Skip to content

Commit

Permalink
move GLTF docs to its module folder.
Browse files Browse the repository at this point in the history
  • Loading branch information
lyuma committed May 26, 2021
1 parent f8422f9 commit 1da3270
Show file tree
Hide file tree
Showing 17 changed files with 749 additions and 1 deletion.
24 changes: 24 additions & 0 deletions modules/gltf/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,27 @@ def can_build(env, platform):

def configure(env):
pass


def get_doc_classes():
return [
"EditorSceneImporterGLTF",
"GLTFAccessor",
"GLTFAnimation",
"GLTFBufferView",
"GLTFCamera",
"GLTFDocument",
"GLTFLight",
"GLTFMesh",
"GLTFNode",
"GLTFSkeleton",
"GLTFSkin",
"GLTFSpecGloss",
"GLTFState",
"GLTFTexture",
"PackedSceneGLTF",
]


def get_doc_path():
return "doc_classes"
13 changes: 13 additions & 0 deletions modules/gltf/doc_classes/EditorSceneImporterGLTF.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSceneImporterGLTF" inherits="EditorSceneImporter" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>
43 changes: 43 additions & 0 deletions modules/gltf/doc_classes/GLTFAccessor.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFAccessor" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="buffer_view" type="int" setter="set_buffer_view" getter="get_buffer_view" default="0">
</member>
<member name="byte_offset" type="int" setter="set_byte_offset" getter="get_byte_offset" default="0">
</member>
<member name="component_type" type="int" setter="set_component_type" getter="get_component_type" default="0">
</member>
<member name="count" type="int" setter="set_count" getter="get_count" default="0">
</member>
<member name="max" type="PoolRealArray" setter="set_max" getter="get_max" default="PoolRealArray( )">
</member>
<member name="min" type="PoolRealArray" setter="set_min" getter="get_min" default="PoolRealArray( )">
</member>
<member name="normalized" type="bool" setter="set_normalized" getter="get_normalized" default="false">
</member>
<member name="sparse_count" type="int" setter="set_sparse_count" getter="get_sparse_count" default="0">
</member>
<member name="sparse_indices_buffer_view" type="int" setter="set_sparse_indices_buffer_view" getter="get_sparse_indices_buffer_view" default="0">
</member>
<member name="sparse_indices_byte_offset" type="int" setter="set_sparse_indices_byte_offset" getter="get_sparse_indices_byte_offset" default="0">
</member>
<member name="sparse_indices_component_type" type="int" setter="set_sparse_indices_component_type" getter="get_sparse_indices_component_type" default="0">
</member>
<member name="sparse_values_buffer_view" type="int" setter="set_sparse_values_buffer_view" getter="get_sparse_values_buffer_view" default="0">
</member>
<member name="sparse_values_byte_offset" type="int" setter="set_sparse_values_byte_offset" getter="get_sparse_values_byte_offset" default="0">
</member>
<member name="type" type="int" setter="set_type" getter="get_type" default="0">
</member>
</members>
<constants>
</constants>
</class>
17 changes: 17 additions & 0 deletions modules/gltf/doc_classes/GLTFAnimation.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFAnimation" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="loop" type="bool" setter="set_loop" getter="get_loop" default="false">
</member>
</members>
<constants>
</constants>
</class>
25 changes: 25 additions & 0 deletions modules/gltf/doc_classes/GLTFBufferView.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFBufferView" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="buffer" type="int" setter="set_buffer" getter="get_buffer" default="-1">
</member>
<member name="byte_length" type="int" setter="set_byte_length" getter="get_byte_length" default="0">
</member>
<member name="byte_offset" type="int" setter="set_byte_offset" getter="get_byte_offset" default="0">
</member>
<member name="byte_stride" type="int" setter="set_byte_stride" getter="get_byte_stride" default="-1">
</member>
<member name="indices" type="bool" setter="set_indices" getter="get_indices" default="false">
</member>
</members>
<constants>
</constants>
</class>
23 changes: 23 additions & 0 deletions modules/gltf/doc_classes/GLTFCamera.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFCamera" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="fov_size" type="float" setter="set_fov_size" getter="get_fov_size" default="75.0">
</member>
<member name="perspective" type="bool" setter="set_perspective" getter="get_perspective" default="true">
</member>
<member name="zfar" type="float" setter="set_zfar" getter="get_zfar" default="4000.0">
</member>
<member name="znear" type="float" setter="set_znear" getter="get_znear" default="0.05">
</member>
</members>
<constants>
</constants>
</class>
13 changes: 13 additions & 0 deletions modules/gltf/doc_classes/GLTFDocument.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFDocument" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>
27 changes: 27 additions & 0 deletions modules/gltf/doc_classes/GLTFLight.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFLight" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 0, 0, 0, 1 )">
</member>
<member name="inner_cone_angle" type="float" setter="set_inner_cone_angle" getter="get_inner_cone_angle" default="0.0">
</member>
<member name="intensity" type="float" setter="set_intensity" getter="get_intensity" default="0.0">
</member>
<member name="outer_cone_angle" type="float" setter="set_outer_cone_angle" getter="get_outer_cone_angle" default="0.0">
</member>
<member name="range" type="float" setter="set_range" getter="get_range" default="0.0">
</member>
<member name="type" type="String" setter="set_type" getter="get_type" default="&quot;&quot;">
</member>
</members>
<constants>
</constants>
</class>
19 changes: 19 additions & 0 deletions modules/gltf/doc_classes/GLTFMesh.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFMesh" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="blend_weights" type="PoolRealArray" setter="set_blend_weights" getter="get_blend_weights" default="PoolRealArray( )">
</member>
<member name="mesh" type="ArrayMesh" setter="set_mesh" getter="get_mesh">
</member>
</members>
<constants>
</constants>
</class>
41 changes: 41 additions & 0 deletions modules/gltf/doc_classes/GLTFNode.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFNode" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="camera" type="int" setter="set_camera" getter="get_camera" default="-1">
</member>
<member name="children" type="PoolIntArray" setter="set_children" getter="get_children" default="PoolIntArray( )">
</member>
<member name="height" type="int" setter="set_height" getter="get_height" default="-1">
</member>
<member name="joint" type="bool" setter="set_joint" getter="get_joint" default="false">
</member>
<member name="light" type="int" setter="set_light" getter="get_light" default="-1">
</member>
<member name="mesh" type="int" setter="set_mesh" getter="get_mesh" default="-1">
</member>
<member name="parent" type="int" setter="set_parent" getter="get_parent" default="-1">
</member>
<member name="rotation" type="Quat" setter="set_rotation" getter="get_rotation" default="Quat( 0, 0, 0, 1 )">
</member>
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3( 1, 1, 1 )">
</member>
<member name="skeleton" type="int" setter="set_skeleton" getter="get_skeleton" default="-1">
</member>
<member name="skin" type="int" setter="set_skin" getter="get_skin" default="-1">
</member>
<member name="translation" type="Vector3" setter="set_translation" getter="get_translation" default="Vector3( 0, 0, 0 )">
</member>
<member name="xform" type="Transform" setter="set_xform" getter="get_xform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</member>
</members>
<constants>
</constants>
</class>
67 changes: 67 additions & 0 deletions modules/gltf/doc_classes/GLTFSkeleton.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFSkeleton" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_bone_attachment">
<return type="BoneAttachment">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="get_bone_attachment_count">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_godot_bone_node">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="get_godot_skeleton">
<return type="Skeleton">
</return>
<description>
</description>
</method>
<method name="get_unique_names">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="set_godot_bone_node">
<return type="void">
</return>
<argument index="0" name="godot_bone_node" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="set_unique_names">
<return type="void">
</return>
<argument index="0" name="unique_names" type="Array">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="joints" type="PoolIntArray" setter="set_joints" getter="get_joints" default="PoolIntArray( )">
</member>
<member name="roots" type="PoolIntArray" setter="set_roots" getter="get_roots" default="PoolIntArray( )">
</member>
</members>
<constants>
</constants>
</class>
71 changes: 71 additions & 0 deletions modules/gltf/doc_classes/GLTFSkin.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFSkin" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_inverse_binds">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_joint_i_to_bone_i">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="get_joint_i_to_name">
<return type="Dictionary">
</return>
<description>
</description>
</method>
<method name="set_inverse_binds">
<return type="void">
</return>
<argument index="0" name="inverse_binds" type="Array">
</argument>
<description>
</description>
</method>
<method name="set_joint_i_to_bone_i">
<return type="void">
</return>
<argument index="0" name="joint_i_to_bone_i" type="Dictionary">
</argument>
<description>
</description>
</method>
<method name="set_joint_i_to_name">
<return type="void">
</return>
<argument index="0" name="joint_i_to_name" type="Dictionary">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="godot_skin" type="Skin" setter="set_godot_skin" getter="get_godot_skin">
</member>
<member name="joints" type="PoolIntArray" setter="set_joints" getter="get_joints" default="PoolIntArray( )">
</member>
<member name="joints_original" type="PoolIntArray" setter="set_joints_original" getter="get_joints_original" default="PoolIntArray( )">
</member>
<member name="non_joints" type="PoolIntArray" setter="set_non_joints" getter="get_non_joints" default="PoolIntArray( )">
</member>
<member name="roots" type="PoolIntArray" setter="set_roots" getter="get_roots" default="PoolIntArray( )">
</member>
<member name="skeleton" type="int" setter="set_skeleton" getter="get_skeleton" default="-1">
</member>
<member name="skin_root" type="int" setter="set_skin_root" getter="get_skin_root" default="-1">
</member>
</members>
<constants>
</constants>
</class>
Loading

0 comments on commit 1da3270

Please sign in to comment.