Browse Source

Merge pull request #63412 from aaronfranke/gltf-organize-files

GLTF: Organize structures and extensions into subfolders
Rémi Verschelde 3 years ago
parent
commit
af45036d1a

+ 11 - 0
modules/gltf/README.md

@@ -0,0 +1,11 @@
+# Godot GLTF import and export module
+
+In a nutshell, the GLTF module works like this:
+
+* The [`structures/`](structures/) folder contains GLTF structures, the
+  small pieces that make up a GLTF file, represented as C++ classes.
+* The [`extensions/`](extensions/) folder contains GLTF extensions, which
+  are optional features that build on top of the base GLTF spec.
+* [`GLTFState`](gltf_state.h) holds collections of structures and extensions.
+* [`GLTFDocument`](gltf_document.h) operates on GLTFState and its elements.
+* The [`editor/`](editor/) folder uses GLTFDocument to import and export 3D models.

+ 2 - 0
modules/gltf/SCsub

@@ -7,5 +7,7 @@ env_gltf = env_modules.Clone()
 
 # Godot's own source files
 env_gltf.add_source_files(env.modules_sources, "*.cpp")
+env_gltf.add_source_files(env.modules_sources, "extensions/*.cpp")
+env_gltf.add_source_files(env.modules_sources, "structures/*.cpp")
 if env["tools"]:
     env_gltf.add_source_files(env.modules_sources, "editor/*.cpp")

+ 0 - 0
modules/gltf/gltf_light.cpp → modules/gltf/extensions/gltf_light.cpp


+ 0 - 0
modules/gltf/gltf_light.h → modules/gltf/extensions/gltf_light.h


+ 0 - 0
modules/gltf/gltf_spec_gloss.cpp → modules/gltf/extensions/gltf_spec_gloss.cpp


+ 0 - 0
modules/gltf/gltf_spec_gloss.h → modules/gltf/extensions/gltf_spec_gloss.h


+ 1 - 1
modules/gltf/gltf_document.cpp

@@ -30,9 +30,9 @@
 
 #include "gltf_document.h"
 
+#include "extensions/gltf_spec_gloss.h"
 #include "gltf_document_extension.h"
 #include "gltf_document_extension_convert_importer_mesh.h"
-#include "gltf_spec_gloss.h"
 #include "gltf_state.h"
 
 #include "core/crypto/crypto_core.h"

+ 1 - 1
modules/gltf/gltf_document.h

@@ -31,8 +31,8 @@
 #ifndef GLTF_DOCUMENT_H
 #define GLTF_DOCUMENT_H
 
-#include "gltf_animation.h"
 #include "gltf_defines.h"
+#include "structures/gltf_animation.h"
 
 #include "scene/3d/bone_attachment_3d.h"
 #include "scene/3d/importer_mesh_instance_3d.h"

+ 1 - 1
modules/gltf/gltf_document_extension.h

@@ -31,8 +31,8 @@
 #ifndef GLTF_DOCUMENT_EXTENSION_H
 #define GLTF_DOCUMENT_EXTENSION_H
 
-#include "gltf_node.h"
 #include "gltf_state.h"
+#include "structures/gltf_node.h"
 
 class GLTFDocumentExtension : public Resource {
 	GDCLASS(GLTFDocumentExtension, Resource);

+ 10 - 10
modules/gltf/gltf_state.h

@@ -31,17 +31,17 @@
 #ifndef GLTF_STATE_H
 #define GLTF_STATE_H
 
-#include "gltf_accessor.h"
-#include "gltf_animation.h"
-#include "gltf_buffer_view.h"
-#include "gltf_camera.h"
-#include "gltf_light.h"
-#include "gltf_mesh.h"
-#include "gltf_node.h"
-#include "gltf_skeleton.h"
-#include "gltf_skin.h"
+#include "extensions/gltf_light.h"
 #include "gltf_template_convert.h"
-#include "gltf_texture.h"
+#include "structures/gltf_accessor.h"
+#include "structures/gltf_animation.h"
+#include "structures/gltf_buffer_view.h"
+#include "structures/gltf_camera.h"
+#include "structures/gltf_mesh.h"
+#include "structures/gltf_node.h"
+#include "structures/gltf_skeleton.h"
+#include "structures/gltf_skin.h"
+#include "structures/gltf_texture.h"
 
 #include "core/templates/rb_map.h"
 #include "scene/animation/animation_player.h"

+ 11 - 11
modules/gltf/register_types.cpp

@@ -32,21 +32,21 @@
 
 #ifndef _3D_DISABLED
 
-#include "gltf_accessor.h"
-#include "gltf_animation.h"
-#include "gltf_buffer_view.h"
-#include "gltf_camera.h"
+#include "extensions/gltf_light.h"
+#include "extensions/gltf_spec_gloss.h"
 #include "gltf_document.h"
 #include "gltf_document_extension.h"
 #include "gltf_document_extension_convert_importer_mesh.h"
-#include "gltf_light.h"
-#include "gltf_mesh.h"
-#include "gltf_node.h"
-#include "gltf_skeleton.h"
-#include "gltf_skin.h"
-#include "gltf_spec_gloss.h"
 #include "gltf_state.h"
-#include "gltf_texture.h"
+#include "structures/gltf_accessor.h"
+#include "structures/gltf_animation.h"
+#include "structures/gltf_buffer_view.h"
+#include "structures/gltf_camera.h"
+#include "structures/gltf_mesh.h"
+#include "structures/gltf_node.h"
+#include "structures/gltf_skeleton.h"
+#include "structures/gltf_skin.h"
+#include "structures/gltf_texture.h"
 
 #ifdef TOOLS_ENABLED
 #include "core/config/project_settings.h"

+ 0 - 0
modules/gltf/gltf_accessor.cpp → modules/gltf/structures/gltf_accessor.cpp


+ 1 - 1
modules/gltf/gltf_accessor.h → modules/gltf/structures/gltf_accessor.h

@@ -33,7 +33,7 @@
 
 #include "core/io/resource.h"
 
-#include "gltf_defines.h"
+#include "../gltf_defines.h"
 
 struct GLTFAccessor : public Resource {
 	GDCLASS(GLTFAccessor, Resource);

+ 0 - 0
modules/gltf/gltf_animation.cpp → modules/gltf/structures/gltf_animation.cpp


+ 0 - 0
modules/gltf/gltf_animation.h → modules/gltf/structures/gltf_animation.h


+ 1 - 1
modules/gltf/gltf_buffer_view.cpp → modules/gltf/structures/gltf_buffer_view.cpp

@@ -30,7 +30,7 @@
 
 #include "gltf_buffer_view.h"
 
-#include "gltf_document_extension.h"
+#include "../gltf_document_extension.h"
 
 void GLTFBufferView::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_buffer"), &GLTFBufferView::get_buffer);

+ 1 - 1
modules/gltf/gltf_buffer_view.h → modules/gltf/structures/gltf_buffer_view.h

@@ -31,8 +31,8 @@
 #ifndef GLTF_BUFFER_VIEW_H
 #define GLTF_BUFFER_VIEW_H
 
+#include "../gltf_defines.h"
 #include "core/io/resource.h"
-#include "gltf_defines.h"
 
 class GLTFBufferView : public Resource {
 	GDCLASS(GLTFBufferView, Resource);

+ 0 - 0
modules/gltf/gltf_camera.cpp → modules/gltf/structures/gltf_camera.cpp


+ 0 - 0
modules/gltf/gltf_camera.h → modules/gltf/structures/gltf_camera.h


+ 0 - 0
modules/gltf/gltf_mesh.cpp → modules/gltf/structures/gltf_mesh.cpp


+ 0 - 0
modules/gltf/gltf_mesh.h → modules/gltf/structures/gltf_mesh.h


+ 0 - 0
modules/gltf/gltf_node.cpp → modules/gltf/structures/gltf_node.cpp


+ 1 - 1
modules/gltf/gltf_node.h → modules/gltf/structures/gltf_node.h

@@ -31,8 +31,8 @@
 #ifndef GLTF_NODE_H
 #define GLTF_NODE_H
 
+#include "../gltf_defines.h"
 #include "core/io/resource.h"
-#include "gltf_defines.h"
 
 class GLTFNode : public Resource {
 	GDCLASS(GLTFNode, Resource);

+ 1 - 1
modules/gltf/gltf_skeleton.cpp → modules/gltf/structures/gltf_skeleton.cpp

@@ -30,7 +30,7 @@
 
 #include "gltf_skeleton.h"
 
-#include "gltf_template_convert.h"
+#include "../gltf_template_convert.h"
 #include "scene/3d/bone_attachment_3d.h"
 
 void GLTFSkeleton::_bind_methods() {

+ 1 - 1
modules/gltf/gltf_skeleton.h → modules/gltf/structures/gltf_skeleton.h

@@ -31,8 +31,8 @@
 #ifndef GLTF_SKELETON_H
 #define GLTF_SKELETON_H
 
+#include "../gltf_defines.h"
 #include "core/io/resource.h"
-#include "gltf_defines.h"
 
 class GLTFSkeleton : public Resource {
 	GDCLASS(GLTFSkeleton, Resource);

+ 1 - 1
modules/gltf/gltf_skin.cpp → modules/gltf/structures/gltf_skin.cpp

@@ -30,7 +30,7 @@
 
 #include "gltf_skin.h"
 
-#include "gltf_template_convert.h"
+#include "../gltf_template_convert.h"
 #include "scene/resources/skin.h"
 
 void GLTFSkin::_bind_methods() {

+ 1 - 1
modules/gltf/gltf_skin.h → modules/gltf/structures/gltf_skin.h

@@ -31,8 +31,8 @@
 #ifndef GLTF_SKIN_H
 #define GLTF_SKIN_H
 
+#include "../gltf_defines.h"
 #include "core/io/resource.h"
-#include "gltf_defines.h"
 
 class GLTFSkin : public Resource {
 	GDCLASS(GLTFSkin, Resource);

+ 0 - 0
modules/gltf/gltf_texture.cpp → modules/gltf/structures/gltf_texture.cpp


+ 1 - 1
modules/gltf/gltf_texture.h → modules/gltf/structures/gltf_texture.h

@@ -31,8 +31,8 @@
 #ifndef GLTF_TEXTURE_H
 #define GLTF_TEXTURE_H
 
+#include "../gltf_defines.h"
 #include "core/io/resource.h"
-#include "gltf_defines.h"
 
 class GLTFTexture : public Resource {
 	GDCLASS(GLTFTexture, Resource);