diff options
Diffstat (limited to 'modules/gltf/doc_classes')
| -rw-r--r-- | modules/gltf/doc_classes/EditorSceneImporterGLTF.xml | 9 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFAccessor.xml | 39 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFAnimation.xml | 13 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFBufferView.xml | 21 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFCamera.xml | 19 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFDocument.xml | 33 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFLight.xml | 31 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFMesh.xml | 15 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFNode.xml | 37 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFSkeleton.xml | 55 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFSkin.xml | 60 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFSpecGloss.xml | 21 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFState.xml | 212 | ||||
| -rw-r--r-- | modules/gltf/doc_classes/GLTFTexture.xml | 13 |
14 files changed, 578 insertions, 0 deletions
diff --git a/modules/gltf/doc_classes/EditorSceneImporterGLTF.xml b/modules/gltf/doc_classes/EditorSceneImporterGLTF.xml new file mode 100644 index 0000000000..c85fce7b9d --- /dev/null +++ b/modules/gltf/doc_classes/EditorSceneImporterGLTF.xml @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSceneImporterGLTF" inherits="EditorSceneImporter" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> +</class> diff --git a/modules/gltf/doc_classes/GLTFAccessor.xml b/modules/gltf/doc_classes/GLTFAccessor.xml new file mode 100644 index 0000000000..ae81cae81a --- /dev/null +++ b/modules/gltf/doc_classes/GLTFAccessor.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFAccessor" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <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="PackedFloat64Array" setter="set_max" getter="get_max" default="PackedFloat64Array()"> + </member> + <member name="min" type="PackedFloat64Array" setter="set_min" getter="get_min" default="PackedFloat64Array()"> + </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> +</class> diff --git a/modules/gltf/doc_classes/GLTFAnimation.xml b/modules/gltf/doc_classes/GLTFAnimation.xml new file mode 100644 index 0000000000..70480c2b38 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFAnimation.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFAnimation" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="loop" type="bool" setter="set_loop" getter="get_loop" default="false"> + </member> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFBufferView.xml b/modules/gltf/doc_classes/GLTFBufferView.xml new file mode 100644 index 0000000000..f58aa46508 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFBufferView.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFBufferView" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <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> +</class> diff --git a/modules/gltf/doc_classes/GLTFCamera.xml b/modules/gltf/doc_classes/GLTFCamera.xml new file mode 100644 index 0000000000..3682df5951 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFCamera.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFCamera" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="depth_far" type="float" setter="set_depth_far" getter="get_depth_far" default="4000.0"> + </member> + <member name="depth_near" type="float" setter="set_depth_near" getter="get_depth_near" default="0.05"> + </member> + <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> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFDocument.xml b/modules/gltf/doc_classes/GLTFDocument.xml new file mode 100644 index 0000000000..16e649f390 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFDocument.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFDocument" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="import_scene"> + <return type="Node" /> + <argument index="0" name="path" type="String" /> + <argument index="1" name="flags" type="int" default="0" /> + <argument index="2" name="bake_fps" type="int" default="30" /> + <argument index="3" name="state" type="GLTFState" default="null" /> + <description> + Import a scene from glTF2 ".gltf" or ".glb" file. + </description> + </method> + <method name="save_scene"> + <return type="int" enum="Error" /> + <argument index="0" name="node" type="Node" /> + <argument index="1" name="path" type="String" /> + <argument index="2" name="src_path" type="String" /> + <argument index="3" name="flags" type="int" default="0" /> + <argument index="4" name="bake_fps" type="float" default="30" /> + <argument index="5" name="state" type="GLTFState" default="null" /> + <description> + Save a scene as a glTF2 ".glb" or ".gltf" file. + </description> + </method> + </methods> +</class> diff --git a/modules/gltf/doc_classes/GLTFLight.xml b/modules/gltf/doc_classes/GLTFLight.xml new file mode 100644 index 0000000000..b4f03cd1ed --- /dev/null +++ b/modules/gltf/doc_classes/GLTFLight.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFLight" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="color" type="Color" setter="set_color" getter="get_color" default="Color(1, 1, 1, 1)"> + The [Color] of the light. Defaults to white. A black color causes the light to have no effect. + </member> + <member name="inner_cone_angle" type="float" setter="set_inner_cone_angle" getter="get_inner_cone_angle" default="0.0"> + The inner angle of the cone in a spotlight. Must be less than or equal to the outer cone angle. + Within this angle, the light is at full brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. When creating a Godot [SpotLight3D], the ratio between the inner and outer cone angles is used to calculate the attenuation of the light. + </member> + <member name="intensity" type="float" setter="set_intensity" getter="get_intensity" default="1.0"> + The intensity of the light. This is expressed in candelas (lumens per steradian) for point and spot lights, and lux (lumens per m²) for directional lights. When creating a Godot light, this value is converted to a unitless multiplier. + </member> + <member name="light_type" type="String" setter="set_light_type" getter="get_light_type" default=""""> + The type of the light. The values accepted by Godot are "point", "spot", and "directional", which correspond to Godot's [OmniLight3D], [SpotLight3D], and [DirectionalLight3D] respectively. + </member> + <member name="outer_cone_angle" type="float" setter="set_outer_cone_angle" getter="get_outer_cone_angle" default="0.785398"> + The outer angle of the cone in a spotlight. Must be greater than or equal to the inner angle. + At this angle, the light drops off to zero brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. If this angle is a half turn, then the spotlight emits in all directions. When creating a Godot [SpotLight3D], the outer cone angle is used as the angle of the spotlight. + </member> + <member name="range" type="float" setter="set_range" getter="get_range" default="inf"> + The range of the light, beyond which the light has no effect. GLTF lights with no range defined behave like physical lights (which have infinite range). When creating a Godot light, the range is clamped to 4096. + </member> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFMesh.xml b/modules/gltf/doc_classes/GLTFMesh.xml new file mode 100644 index 0000000000..51e9fc032a --- /dev/null +++ b/modules/gltf/doc_classes/GLTFMesh.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFMesh" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="blend_weights" type="PackedFloat32Array" setter="set_blend_weights" getter="get_blend_weights" default="PackedFloat32Array()"> + </member> + <member name="mesh" type="EditorSceneImporterMesh" setter="set_mesh" getter="get_mesh"> + </member> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFNode.xml b/modules/gltf/doc_classes/GLTFNode.xml new file mode 100644 index 0000000000..f27965ea07 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFNode.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFNode" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="camera" type="int" setter="set_camera" getter="get_camera" default="-1"> + </member> + <member name="children" type="PackedInt32Array" setter="set_children" getter="get_children" default="PackedInt32Array()"> + </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="position" type="Vector3" setter="set_position" getter="get_position" default="Vector3(0, 0, 0)"> + </member> + <member name="rotation" type="Quaternion" setter="set_rotation" getter="get_rotation" default="Quaternion(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="xform" type="Transform3D" setter="set_xform" getter="get_xform" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)"> + </member> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFSkeleton.xml b/modules/gltf/doc_classes/GLTFSkeleton.xml new file mode 100644 index 0000000000..037c3545a6 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFSkeleton.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFSkeleton" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_bone_attachment"> + <return type="BoneAttachment3D" /> + <argument index="0" name="idx" type="int" /> + <description> + </description> + </method> + <method name="get_bone_attachment_count"> + <return type="int" /> + <description> + </description> + </method> + <method name="get_godot_bone_node"> + <return type="Dictionary" /> + <description> + </description> + </method> + <method name="get_godot_skeleton"> + <return type="Skeleton3D" /> + <description> + </description> + </method> + <method name="get_unique_names"> + <return type="Array" /> + <description> + </description> + </method> + <method name="set_godot_bone_node"> + <return type="void" /> + <argument index="0" name="godot_bone_node" type="Dictionary" /> + <description> + </description> + </method> + <method name="set_unique_names"> + <return type="void" /> + <argument index="0" name="unique_names" type="Array" /> + <description> + </description> + </method> + </methods> + <members> + <member name="joints" type="PackedInt32Array" setter="set_joints" getter="get_joints" default="PackedInt32Array()"> + </member> + <member name="roots" type="PackedInt32Array" setter="set_roots" getter="get_roots" default="PackedInt32Array()"> + </member> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFSkin.xml b/modules/gltf/doc_classes/GLTFSkin.xml new file mode 100644 index 0000000000..ad4f017584 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFSkin.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFSkin" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_inverse_binds"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_joint_i_to_bone_i"> + <return type="Dictionary" /> + <description> + </description> + </method> + <method name="get_joint_i_to_name"> + <return type="Dictionary" /> + <description> + </description> + </method> + <method name="set_inverse_binds"> + <return type="void" /> + <argument index="0" name="inverse_binds" type="Array" /> + <description> + </description> + </method> + <method name="set_joint_i_to_bone_i"> + <return type="void" /> + <argument index="0" name="joint_i_to_bone_i" type="Dictionary" /> + <description> + </description> + </method> + <method name="set_joint_i_to_name"> + <return type="void" /> + <argument index="0" name="joint_i_to_name" type="Dictionary" /> + <description> + </description> + </method> + </methods> + <members> + <member name="godot_skin" type="Skin" setter="set_godot_skin" getter="get_godot_skin"> + </member> + <member name="joints" type="PackedInt32Array" setter="set_joints" getter="get_joints" default="PackedInt32Array()"> + </member> + <member name="joints_original" type="PackedInt32Array" setter="set_joints_original" getter="get_joints_original" default="PackedInt32Array()"> + </member> + <member name="non_joints" type="PackedInt32Array" setter="set_non_joints" getter="get_non_joints" default="PackedInt32Array()"> + </member> + <member name="roots" type="PackedInt32Array" setter="set_roots" getter="get_roots" default="PackedInt32Array()"> + </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> +</class> diff --git a/modules/gltf/doc_classes/GLTFSpecGloss.xml b/modules/gltf/doc_classes/GLTFSpecGloss.xml new file mode 100644 index 0000000000..6b8f86ed1c --- /dev/null +++ b/modules/gltf/doc_classes/GLTFSpecGloss.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFSpecGloss" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="diffuse_factor" type="Color" setter="set_diffuse_factor" getter="get_diffuse_factor" default="Color(1, 1, 1, 1)"> + </member> + <member name="diffuse_img" type="Image" setter="set_diffuse_img" getter="get_diffuse_img"> + </member> + <member name="gloss_factor" type="float" setter="set_gloss_factor" getter="get_gloss_factor" default="1.0"> + </member> + <member name="spec_gloss_img" type="Image" setter="set_spec_gloss_img" getter="get_spec_gloss_img"> + </member> + <member name="specular_factor" type="Color" setter="set_specular_factor" getter="get_specular_factor" default="Color(1, 1, 1, 1)"> + </member> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFState.xml b/modules/gltf/doc_classes/GLTFState.xml new file mode 100644 index 0000000000..6d03d0ecf8 --- /dev/null +++ b/modules/gltf/doc_classes/GLTFState.xml @@ -0,0 +1,212 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFState" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_accessors"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_animation_player"> + <return type="AnimationPlayer" /> + <argument index="0" name="idx" type="int" /> + <description> + </description> + </method> + <method name="get_animation_players_count"> + <return type="int" /> + <argument index="0" name="idx" type="int" /> + <description> + </description> + </method> + <method name="get_animations"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_buffer_views"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_cameras"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_images"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_lights"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_materials"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_meshes"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_nodes"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_scene_node"> + <return type="Node" /> + <argument index="0" name="idx" type="int" /> + <description> + </description> + </method> + <method name="get_skeleton_to_node"> + <return type="Dictionary" /> + <description> + </description> + </method> + <method name="get_skeletons"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_skins"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_textures"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_unique_animation_names"> + <return type="Array" /> + <description> + </description> + </method> + <method name="get_unique_names"> + <return type="Array" /> + <description> + </description> + </method> + <method name="set_accessors"> + <return type="void" /> + <argument index="0" name="accessors" type="Array" /> + <description> + </description> + </method> + <method name="set_animations"> + <return type="void" /> + <argument index="0" name="animations" type="Array" /> + <description> + </description> + </method> + <method name="set_buffer_views"> + <return type="void" /> + <argument index="0" name="buffer_views" type="Array" /> + <description> + </description> + </method> + <method name="set_cameras"> + <return type="void" /> + <argument index="0" name="cameras" type="Array" /> + <description> + </description> + </method> + <method name="set_images"> + <return type="void" /> + <argument index="0" name="images" type="Array" /> + <description> + </description> + </method> + <method name="set_lights"> + <return type="void" /> + <argument index="0" name="lights" type="Array" /> + <description> + </description> + </method> + <method name="set_materials"> + <return type="void" /> + <argument index="0" name="materials" type="Array" /> + <description> + </description> + </method> + <method name="set_meshes"> + <return type="void" /> + <argument index="0" name="meshes" type="Array" /> + <description> + </description> + </method> + <method name="set_nodes"> + <return type="void" /> + <argument index="0" name="nodes" type="Array" /> + <description> + </description> + </method> + <method name="set_skeleton_to_node"> + <return type="void" /> + <argument index="0" name="skeleton_to_node" type="Dictionary" /> + <description> + </description> + </method> + <method name="set_skeletons"> + <return type="void" /> + <argument index="0" name="skeletons" type="Array" /> + <description> + </description> + </method> + <method name="set_skins"> + <return type="void" /> + <argument index="0" name="skins" type="Array" /> + <description> + </description> + </method> + <method name="set_textures"> + <return type="void" /> + <argument index="0" name="textures" type="Array" /> + <description> + </description> + </method> + <method name="set_unique_animation_names"> + <return type="void" /> + <argument index="0" name="unique_animation_names" type="Array" /> + <description> + </description> + </method> + <method name="set_unique_names"> + <return type="void" /> + <argument index="0" name="unique_names" type="Array" /> + <description> + </description> + </method> + </methods> + <members> + <member name="buffers" type="Array" setter="set_buffers" getter="get_buffers" default="[]"> + </member> + <member name="glb_data" type="PackedByteArray" setter="set_glb_data" getter="get_glb_data" default="PackedByteArray()"> + </member> + <member name="json" type="Dictionary" setter="set_json" getter="get_json" default="{}"> + </member> + <member name="major_version" type="int" setter="set_major_version" getter="get_major_version" default="0"> + </member> + <member name="minor_version" type="int" setter="set_minor_version" getter="get_minor_version" default="0"> + </member> + <member name="root_nodes" type="Array" setter="set_root_nodes" getter="get_root_nodes" default="[]"> + </member> + <member name="scene_name" type="String" setter="set_scene_name" getter="get_scene_name" default=""""> + </member> + <member name="use_named_skin_binds" type="bool" setter="set_use_named_skin_binds" getter="get_use_named_skin_binds" default="false"> + </member> + </members> +</class> diff --git a/modules/gltf/doc_classes/GLTFTexture.xml b/modules/gltf/doc_classes/GLTFTexture.xml new file mode 100644 index 0000000000..7c88d2318e --- /dev/null +++ b/modules/gltf/doc_classes/GLTFTexture.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GLTFTexture" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="src_image" type="int" setter="set_src_image" getter="get_src_image" default="0"> + </member> + </members> +</class> |