Skip to content

Import custom attributes with GLTFDocumentExtension #97756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huwpascoe wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Import custom attributes with GLTFDocumentExtension #97756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/gltf/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ def get_doc_classes():
"EditorSceneFormatImporterGLTF",
"GLTFAccessor",
"GLTFAnimation",
"GLTFAttributeMap",
"GLTFBufferView",
"GLTFCamera",
"GLTFDocument",
Expand Down
51 changes: 51 additions & 0 deletions modules/gltf/doc_classes/GLTFAttributeMap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFAttributeMap" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Controls how glTF attributes are mapped on import.
</brief_description>
<description>
Controls how glTF attributes are mapped to the resulting [Mesh]. Used by [method GLTFDocumentExtension._import_get_attribute_map].
Multiplexing is supported with [code]CUSTOM*[/code] attributes. Setting [code]custom*[/code] and [code]custom*_mux[/code] will combine them into the one array.
A pair of [code]custom*[/code] and [code]custom*_mux[/code] attributes must total no larger than [code]vec4[/code]. For instance, you can set [member custom0] to a scalar and [member custom0_mux] to a [code]vec3[/code], but you cannot set [member custom0] to a [code]vec2[/code] and [member custom0_mux] to a [code]vec3[/code] (as this would require 5 values).
If the [code]custom*_mux[/code] attribute that is requested is missing, it will act like only the first was set.
[b]Note:[/b] It may be necessary to disable [code]generate_lods[/code] in the mesh import settings to preserve custom data.
</description>
<tutorials>
</tutorials>
<members>
<member name="color" type="String" setter="set_color" getter="get_color" default="&quot;COLOR_0&quot;">
Targets [constant Mesh.ARRAY_COLOR]. Supported attributes: vec3, vec4.
</member>
<member name="custom0" type="String" setter="set_custom0" getter="get_custom0" default="&quot;TEXCOORD_2&quot;">
Targets [constant Mesh.ARRAY_CUSTOM0]. Supported attributes: float, vec2, vec3, vec4.
</member>
<member name="custom0_mux" type="String" setter="set_custom0_mux" getter="get_custom0_mux" default="&quot;TEXCOORD_3&quot;">
Targets [constant Mesh.ARRAY_CUSTOM0]. Supported attributes: float, vec2, vec3.
</member>
<member name="custom1" type="String" setter="set_custom1" getter="get_custom1" default="&quot;TEXCOORD_4&quot;">
Targets [constant Mesh.ARRAY_CUSTOM1]. Supported attributes: float, vec2, vec3, vec4.
</member>
<member name="custom1_mux" type="String" setter="set_custom1_mux" getter="get_custom1_mux" default="&quot;TEXCOORD_5&quot;">
Targets [constant Mesh.ARRAY_CUSTOM1]. Supported attributes: float, vec2, vec3.
</member>
<member name="custom2" type="String" setter="set_custom2" getter="get_custom2" default="&quot;TEXCOORD_6&quot;">
Targets [constant Mesh.ARRAY_CUSTOM2]. Supported attributes: float, vec2, vec3, vec4.
</member>
<member name="custom2_mux" type="String" setter="set_custom2_mux" getter="get_custom2_mux" default="&quot;TEXCOORD_7&quot;">
Targets [constant Mesh.ARRAY_CUSTOM2]. Supported attributes: float, vec2, vec3.
</member>
<member name="custom3" type="String" setter="set_custom3" getter="get_custom3" default="&quot;&quot;">
Targets [constant Mesh.ARRAY_CUSTOM3]. Supported attributes: float, vec2, vec3, vec4.
</member>
<member name="custom3_mux" type="String" setter="set_custom3_mux" getter="get_custom3_mux" default="&quot;&quot;">
Targets [constant Mesh.ARRAY_CUSTOM3]. Supported attributes: float, vec2, vec3.
</member>
<member name="uv" type="String" setter="set_uv" getter="get_uv" default="&quot;TEXCOORD_0&quot;">
Targets [constant Mesh.ARRAY_TEX_UV]. Supported attributes: vec2.
[b]Note:[/b] The importer may use ARRAY_TEX_UV to generate tangents.
</member>
<member name="uv2" type="String" setter="set_uv2" getter="get_uv2" default="&quot;TEXCOORD_1&quot;">
Targets [constant Mesh.ARRAY_TEX_UV2]. Supported attributes: vec2.
</member>
</members>
</class>
8 changes: 8 additions & 0 deletions modules/gltf/doc_classes/GLTFDocumentExtension.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,14 @@
Returns an array of the glTF extensions supported by this GLTFDocumentExtension class. This is used to validate if a glTF file with required extensions can be loaded.
</description>
</method>
<method name="_import_get_attribute_map" qualifiers="virtual">
<return type="GLTFAttributeMap" />
<param index="0" name="state" type="GLTFState" />
<param index="1" name="mesh_index" type="int" />
<description>
Part of the import process. Allows any mesh to be processed with a custom [GLTFAttributeMap]. Make this function return [code]null[/code] to ignore.
</description>
</method>
<method name="_import_node" qualifiers="virtual">
<return type="int" enum="Error" />
<param index="0" name="state" type="GLTFState" />
Expand Down
6 changes: 6 additions & 0 deletions modules/gltf/editor/editor_scene_importer_blend.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,11 @@ Node *EditorSceneFormatImporterBlend::import_scene(const String &p_path, uint32_
} else {
parameters_map["export_def_bones"] = false;
}
if (p_options.has(SNAME("blender/meshes/export_attributes")) && p_options[SNAME("blender/meshes/export_attributes")]) {
parameters_map["export_attributes"] = true;
} else {
parameters_map["export_attributes"] = false;
}
if (p_options.has(SNAME("blender/nodes/modifiers")) && p_options[SNAME("blender/nodes/modifiers")]) {
parameters_map["export_apply"] = true;
} else {
Expand Down Expand Up @@ -380,6 +385,7 @@ void EditorSceneFormatImporterBlend::get_import_options(const String &p_path, Li
ADD_OPTION_BOOL("blender/meshes/tangents", true);
ADD_OPTION_ENUM("blender/meshes/skins", "None,4 Influences (Compatible),All Influences", BLEND_BONE_INFLUENCES_ALL);
ADD_OPTION_BOOL("blender/meshes/export_bones_deforming_mesh_only", false);
ADD_OPTION_BOOL("blender/meshes/export_attributes", false);
ADD_OPTION_BOOL("blender/materials/unpack_enabled", true);
ADD_OPTION_ENUM("blender/materials/export_materials", "Placeholder,Export,Named Placeholder", BLEND_MATERIAL_EXPORT_EXPORT);
ADD_OPTION_BOOL("blender/animation/limit_playback", true);
Expand Down
156 changes: 156 additions & 0 deletions modules/gltf/extensions/gltf_attribute_map.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
/**************************************************************************/
/* gltf_attribute_map.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/

#include "gltf_attribute_map.h"

void GLTFAttributeMap::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_color"), &GLTFAttributeMap::get_color);
ClassDB::bind_method(D_METHOD("set_color", "color"), &GLTFAttributeMap::set_color);
ClassDB::bind_method(D_METHOD("get_uv"), &GLTFAttributeMap::get_uv);
ClassDB::bind_method(D_METHOD("set_uv", "uv"), &GLTFAttributeMap::set_uv);
ClassDB::bind_method(D_METHOD("get_uv2"), &GLTFAttributeMap::get_uv2);
ClassDB::bind_method(D_METHOD("set_uv2", "uv2"), &GLTFAttributeMap::set_uv2);
ClassDB::bind_method(D_METHOD("get_custom0"), &GLTFAttributeMap::get_custom0);
ClassDB::bind_method(D_METHOD("set_custom0", "custom0"), &GLTFAttributeMap::set_custom0);
ClassDB::bind_method(D_METHOD("get_custom0_mux"), &GLTFAttributeMap::get_custom0_mux);
ClassDB::bind_method(D_METHOD("set_custom0_mux", "custom0_mux"), &GLTFAttributeMap::set_custom0_mux);
ClassDB::bind_method(D_METHOD("get_custom1"), &GLTFAttributeMap::get_custom1);
ClassDB::bind_method(D_METHOD("set_custom1", "custom1"), &GLTFAttributeMap::set_custom1);
ClassDB::bind_method(D_METHOD("get_custom1_mux"), &GLTFAttributeMap::get_custom1_mux);
ClassDB::bind_method(D_METHOD("set_custom1_mux", "custom1_mux"), &GLTFAttributeMap::set_custom1_mux);
ClassDB::bind_method(D_METHOD("get_custom2"), &GLTFAttributeMap::get_custom2);
ClassDB::bind_method(D_METHOD("set_custom2", "custom2"), &GLTFAttributeMap::set_custom2);
ClassDB::bind_method(D_METHOD("get_custom2_mux"), &GLTFAttributeMap::get_custom2_mux);
ClassDB::bind_method(D_METHOD("set_custom2_mux", "custom2_mux"), &GLTFAttributeMap::set_custom2_mux);
ClassDB::bind_method(D_METHOD("get_custom3"), &GLTFAttributeMap::get_custom3);
ClassDB::bind_method(D_METHOD("set_custom3", "custom3"), &GLTFAttributeMap::set_custom3);
ClassDB::bind_method(D_METHOD("get_custom3_mux"), &GLTFAttributeMap::get_custom3_mux);
ClassDB::bind_method(D_METHOD("set_custom3_mux", "custom3_mux"), &GLTFAttributeMap::set_custom3_mux);

ADD_PROPERTY(PropertyInfo(Variant::STRING, "color"), "set_color", "get_color");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "uv"), "set_uv", "get_uv");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "uv2"), "set_uv2", "get_uv2");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom0"), "set_custom0", "get_custom0");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom0_mux"), "set_custom0_mux", "get_custom0_mux");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom1"), "set_custom1", "get_custom1");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom1_mux"), "set_custom1_mux", "get_custom1_mux");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom2"), "set_custom2", "get_custom2");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom2_mux"), "set_custom2_mux", "get_custom2_mux");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom3"), "set_custom3", "get_custom3");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom3_mux"), "set_custom3_mux", "get_custom3_mux");
}

String GLTFAttributeMap::get_color() const {
return _color;
}

void GLTFAttributeMap::set_color(const String &p_color) {
_color = p_color;
}

String GLTFAttributeMap::get_uv() const {
return _uv;
}

void GLTFAttributeMap::set_uv(const String &p_uv) {
_uv = p_uv;
}

String GLTFAttributeMap::get_uv2() const {
return _uv2;
}

void GLTFAttributeMap::set_uv2(const String &p_uv2) {
_uv2 = p_uv2;
}

String GLTFAttributeMap::get_custom0() const {
return _custom[0];
}

void GLTFAttributeMap::set_custom0(const String &p_custom0) {
_custom[0] = p_custom0;
}

String GLTFAttributeMap::get_custom0_mux() const {
return _custom_mux[0];
}

void GLTFAttributeMap::set_custom0_mux(const String &p_custom0_mux) {
_custom_mux[0] = p_custom0_mux;
}

String GLTFAttributeMap::get_custom1() const {
return _custom[1];
}

void GLTFAttributeMap::set_custom1(const String &p_custom1) {
_custom[1] = p_custom1;
}

String GLTFAttributeMap::get_custom1_mux() const {
return _custom_mux[1];
}

void GLTFAttributeMap::set_custom1_mux(const String &p_custom1_mux) {
_custom_mux[1] = p_custom1_mux;
}

String GLTFAttributeMap::get_custom2() const {
return _custom[2];
}

void GLTFAttributeMap::set_custom2(const String &p_custom2) {
_custom[2] = p_custom2;
}

String GLTFAttributeMap::get_custom2_mux() const {
return _custom_mux[2];
}

void GLTFAttributeMap::set_custom2_mux(const String &p_custom2_mux) {
_custom_mux[2] = p_custom2_mux;
}

String GLTFAttributeMap::get_custom3() const {
return _custom[3];
}

void GLTFAttributeMap::set_custom3(const String &p_custom3) {
_custom[3] = p_custom3;
}

String GLTFAttributeMap::get_custom3_mux() const {
return _custom_mux[3];
}

void GLTFAttributeMap::set_custom3_mux(const String &p_custom3_mux) {
_custom_mux[3] = p_custom3_mux;
}
94 changes: 94 additions & 0 deletions modules/gltf/extensions/gltf_attribute_map.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**************************************************************************/
/* gltf_attribute_map.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/

#pragma once

#include "core/io/resource.h"

class GLTFAttributeMap : public Resource {
GDCLASS(GLTFAttributeMap, Resource);

protected:
static void _bind_methods();

private:
friend class GLTFDocument;

String _color = "COLOR_0";
String _uv = "TEXCOORD_0";
String _uv2 = "TEXCOORD_1";

String _custom[4]{
"TEXCOORD_2",
"TEXCOORD_4",
"TEXCOORD_6",
""
};
String _custom_mux[4]{
"TEXCOORD_3",
"TEXCOORD_5",
"TEXCOORD_7",
""
};

public:
String get_color() const;
void set_color(const String &p_color);

String get_uv() const;
void set_uv(const String &p_uv);

String get_uv2() const;
void set_uv2(const String &p_uv2);

String get_custom0() const;
void set_custom0(const String &p_custom0);

String get_custom0_mux() const;
void set_custom0_mux(const String &p_custom0_mux);

String get_custom1() const;
void set_custom1(const String &p_custom1);

String get_custom1_mux() const;
void set_custom1_mux(const String &p_custom1_mux);

String get_custom2() const;
void set_custom2(const String &p_custom2);

String get_custom2_mux() const;
void set_custom2_mux(const String &p_custom2_mux);

String get_custom3() const;
void set_custom3(const String &p_custom3);

String get_custom3_mux() const;
void set_custom3_mux(const String &p_custom3_mux);
};
7 changes: 7 additions & 0 deletions modules/gltf/extensions/gltf_document_extension.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
void GLTFDocumentExtension::_bind_methods() {
// Import process.
GDVIRTUAL_BIND(_import_preflight, "state", "extensions");
GDVIRTUAL_BIND(_import_get_attribute_map, "state", "mesh_index");
GDVIRTUAL_BIND(_get_supported_extensions);
GDVIRTUAL_BIND(_parse_node_extensions, "state", "gltf_node", "extensions");
GDVIRTUAL_BIND(_parse_image_data, "state", "image_data", "mime_type", "ret_image");
Expand Down Expand Up @@ -66,6 +67,12 @@ Error GLTFDocumentExtension::import_preflight(Ref<GLTFState> p_state, const Vect
return err;
}

Ref<GLTFAttributeMap> GLTFDocumentExtension::import_get_attribute_map(Ref<GLTFState> p_state, GLTFMeshIndex p_index) {
Ref<GLTFAttributeMap> ret;
GDVIRTUAL_CALL(_import_get_attribute_map, p_state, p_index, ret);
return ret;
}

Vector<String> GLTFDocumentExtension::get_supported_extensions() {
Vector<String> ret;
GDVIRTUAL_CALL(_get_supported_extensions, ret);
Expand Down
3 changes: 3 additions & 0 deletions modules/gltf/extensions/gltf_document_extension.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
#pragma once

#include "../gltf_state.h"
#include "gltf_attribute_map.h"

#include "scene/3d/node_3d.h"

Expand All @@ -43,6 +44,7 @@ class GLTFDocumentExtension : public Resource {
public:
// Import process.
virtual Error import_preflight(Ref<GLTFState> p_state, const Vector<String> &p_extensions);
virtual Ref<GLTFAttributeMap> import_get_attribute_map(Ref<GLTFState> p_state, GLTFMeshIndex p_index);
virtual Vector<String> get_supported_extensions();
virtual Error parse_node_extensions(Ref<GLTFState> p_state, Ref<GLTFNode> p_gltf_node, const Dictionary &p_extensions);
virtual Error parse_image_data(Ref<GLTFState> p_state, const PackedByteArray &p_image_data, const String &p_mime_type, Ref<Image> r_image);
Expand All @@ -69,6 +71,7 @@ class GLTFDocumentExtension : public Resource {

// Import process.
GDVIRTUAL2R(Error, _import_preflight, Ref<GLTFState>, Vector<String>);
GDVIRTUAL2R(Ref<GLTFAttributeMap>, _import_get_attribute_map, Ref<GLTFState>, GLTFMeshIndex);
GDVIRTUAL0R(Vector<String>, _get_supported_extensions);
GDVIRTUAL3R(Error, _parse_node_extensions, Ref<GLTFState>, Ref<GLTFNode>, Dictionary);
GDVIRTUAL4R(Error, _parse_image_data, Ref<GLTFState>, PackedByteArray, String, Ref<Image>);
Expand Down
Loading