Merge pull request #69447 from aaronfranke/3.x-gltf-organize-files

[3.x] GLTF: Organize structures and extensions into subfolders
godotengine · Dec 1, 2022 · 01574a5 · 01574a5
2 parents 4d5ef72 + d8aa3b3
commit 01574a5
Show file tree

Hide file tree

Showing 31 changed files with 45 additions and 23 deletions.
diff --git a/modules/gltf/README.md b/modules/gltf/README.md
@@ -0,0 +1,10 @@
+# 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.
diff --git a/modules/gltf/SCsub b/modules/gltf/SCsub
@@ -7,3 +7,5 @@ env_gltf = env_modules.Clone()
 
 # Godot source files
 env_gltf.add_source_files(env.modules_sources, "*.cpp")
+env_gltf.add_source_files(env.modules_sources, "structures/*.cpp")
+SConscript("extensions/SCsub")
diff --git a/modules/gltf/extensions/SCsub b/modules/gltf/extensions/SCsub
@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+
+Import("env")
+Import("env_modules")
+
+env_gltf = env_modules.Clone()
+
+# Godot source files
+env_gltf.add_source_files(env.modules_sources, "*.cpp")
diff --git a/modules/gltf/gltf_light.cpp → modules/gltf/extensions/gltf_light.cpp b/modules/gltf/gltf_light.cpp → modules/gltf/extensions/gltf_light.cpp
diff --git a/modules/gltf/gltf_light.h → modules/gltf/extensions/gltf_light.h b/modules/gltf/gltf_light.h → modules/gltf/extensions/gltf_light.h
@@ -31,6 +31,7 @@
 #ifndef GLTF_LIGHT_H
 #define GLTF_LIGHT_H
 
+#include "../gltf_defines.h"
 #include "core/resource.h"
 
 class GLTFLight : public Resource {

diff --git a/modules/gltf/gltf_spec_gloss.cpp → modules/gltf/extensions/gltf_spec_gloss.cpp b/modules/gltf/gltf_spec_gloss.cpp → modules/gltf/extensions/gltf_spec_gloss.cpp
diff --git a/modules/gltf/gltf_spec_gloss.h → modules/gltf/extensions/gltf_spec_gloss.h b/modules/gltf/gltf_spec_gloss.h → modules/gltf/extensions/gltf_spec_gloss.h
@@ -31,6 +31,7 @@
 #ifndef GLTF_SPEC_GLOSS_H
 #define GLTF_SPEC_GLOSS_H
 
+#include "../gltf_defines.h"
 #include "core/image.h"
 #include "core/resource.h"
 

diff --git a/modules/gltf/gltf_document.cpp b/modules/gltf/gltf_document.cpp
@@ -30,7 +30,7 @@
 
 #include "gltf_document.h"
 
-#include "gltf_spec_gloss.h"
+#include "extensions/gltf_spec_gloss.h"
 #include "gltf_state.h"
 
 #include "core/bind/core_bind.h" // FIXME: Shouldn't use _Directory but DirAccess.

diff --git a/modules/gltf/gltf_document.h b/modules/gltf/gltf_document.h
@@ -32,6 +32,7 @@
 #define GLTF_DOCUMENT_H
 
 #include "gltf_defines.h"
+#include "structures/gltf_animation.h"
 
 #include "scene/3d/bone_attachment.h"
 #include "scene/3d/camera.h"
@@ -43,8 +44,6 @@
 #include "scene/resources/material.h"
 #include "scene/resources/texture.h"
 
-#include "gltf_animation.h"
-
 #include "modules/modules_enabled.gen.h" // For csg, gridmap.
 
 #ifdef MODULE_CSG_ENABLED

diff --git a/modules/gltf/gltf_state.h b/modules/gltf/gltf_state.h
@@ -31,18 +31,18 @@
 #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 "gltf_texture_sampler.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 "structures/gltf_texture_sampler.h"
 
 class GLTFState : public Resource {
 	GDCLASS(GLTFState, Resource);

diff --git a/modules/gltf/register_types.cpp b/modules/gltf/register_types.cpp
@@ -32,7 +32,7 @@
 
 #include "register_types.h"
 
-#include "gltf_spec_gloss.h"
+#include "extensions/gltf_spec_gloss.h"
 #include "gltf_state.h"
 
 #ifdef TOOLS_ENABLED

diff --git a/modules/gltf/gltf_accessor.cpp → modules/gltf/structures/gltf_accessor.cpp b/modules/gltf/gltf_accessor.cpp → modules/gltf/structures/gltf_accessor.cpp
diff --git a/modules/gltf/gltf_accessor.h → modules/gltf/structures/gltf_accessor.h b/modules/gltf/gltf_accessor.h → modules/gltf/structures/gltf_accessor.h
@@ -31,8 +31,8 @@
 #ifndef GLTF_ACCESSOR_H
 #define GLTF_ACCESSOR_H
 
+#include "../gltf_defines.h"
 #include "core/resource.h"
-#include "gltf_defines.h"
 
 struct GLTFAccessor : public Resource {
 	GDCLASS(GLTFAccessor, Resource);

diff --git a/modules/gltf/gltf_animation.cpp → modules/gltf/structures/gltf_animation.cpp b/modules/gltf/gltf_animation.cpp → modules/gltf/structures/gltf_animation.cpp
diff --git a/modules/gltf/gltf_animation.h → modules/gltf/structures/gltf_animation.h b/modules/gltf/gltf_animation.h → modules/gltf/structures/gltf_animation.h
diff --git a/modules/gltf/gltf_buffer_view.cpp → modules/gltf/structures/gltf_buffer_view.cpp b/modules/gltf/gltf_buffer_view.cpp → modules/gltf/structures/gltf_buffer_view.cpp
diff --git a/modules/gltf/gltf_buffer_view.h → modules/gltf/structures/gltf_buffer_view.h b/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/resource.h"
-#include "gltf_defines.h"
 
 class GLTFBufferView : public Resource {
 	GDCLASS(GLTFBufferView, Resource);

diff --git a/modules/gltf/gltf_camera.cpp → modules/gltf/structures/gltf_camera.cpp b/modules/gltf/gltf_camera.cpp → modules/gltf/structures/gltf_camera.cpp
diff --git a/modules/gltf/gltf_camera.h → modules/gltf/structures/gltf_camera.h b/modules/gltf/gltf_camera.h → modules/gltf/structures/gltf_camera.h
diff --git a/modules/gltf/gltf_mesh.cpp → modules/gltf/structures/gltf_mesh.cpp b/modules/gltf/gltf_mesh.cpp → modules/gltf/structures/gltf_mesh.cpp
diff --git a/modules/gltf/gltf_mesh.h → modules/gltf/structures/gltf_mesh.h b/modules/gltf/gltf_mesh.h → modules/gltf/structures/gltf_mesh.h
diff --git a/modules/gltf/gltf_node.cpp → modules/gltf/structures/gltf_node.cpp b/modules/gltf/gltf_node.cpp → modules/gltf/structures/gltf_node.cpp
diff --git a/modules/gltf/gltf_node.h → modules/gltf/structures/gltf_node.h b/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/resource.h"
-#include "gltf_defines.h"
 
 class GLTFNode : public Resource {
 	GDCLASS(GLTFNode, Resource);

diff --git a/modules/gltf/gltf_skeleton.cpp → modules/gltf/structures/gltf_skeleton.cpp b/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.h"
 
 void GLTFSkeleton::_bind_methods() {

diff --git a/modules/gltf/gltf_skeleton.h → modules/gltf/structures/gltf_skeleton.h b/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/resource.h"
-#include "gltf_defines.h"
 
 class GLTFSkeleton : public Resource {
 	GDCLASS(GLTFSkeleton, Resource);

diff --git a/modules/gltf/gltf_skin.cpp → modules/gltf/structures/gltf_skin.cpp b/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() {

diff --git a/modules/gltf/gltf_skin.h → modules/gltf/structures/gltf_skin.h b/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/resource.h"
-#include "gltf_defines.h"
 
 class GLTFSkin : public Resource {
 	GDCLASS(GLTFSkin, Resource);

diff --git a/modules/gltf/gltf_texture.cpp → modules/gltf/structures/gltf_texture.cpp b/modules/gltf/gltf_texture.cpp → modules/gltf/structures/gltf_texture.cpp
diff --git a/modules/gltf/gltf_texture.h → modules/gltf/structures/gltf_texture.h b/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/resource.h"
-#include "gltf_defines.h"
 
 class GLTFTexture : public Resource {
 	GDCLASS(GLTFTexture, Resource);

diff --git a/modules/gltf/gltf_texture_sampler.cpp → .../gltf/structures/gltf_texture_sampler.cpp b/modules/gltf/gltf_texture_sampler.cpp → .../gltf/structures/gltf_texture_sampler.cpp
diff --git a/modules/gltf/gltf_texture_sampler.h → ...es/gltf/structures/gltf_texture_sampler.h b/modules/gltf/gltf_texture_sampler.h → ...es/gltf/structures/gltf_texture_sampler.h