virtualx-engine/modules/gltf/doc_classes/GLTFState.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

238 lines
7.2 KiB
XML
Raw Normal View History

2021-01-04 14:33:44 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFState" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2021-01-04 14:33:44 +01:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_used_extension">
<return type="void" />
<param index="0" name="extension_name" type="String" />
<param index="1" name="required" type="bool" />
<description>
Appends an extension to the list of extensions used by this GLTF file during serialization. If [param required] is true, the extension will also be added to the list of required extensions. Do not run this in [method GLTFDocumentExtension._export_post], as that stage is too late to add extensions. The final list is sorted alphabetically.
</description>
</method>
2021-01-04 14:33:44 +01:00
<method name="get_accessors">
<return type="GLTFAccessor[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_animation_player">
<return type="AnimationPlayer" />
<param index="0" name="idx" type="int" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_animation_players_count">
<return type="int" />
<param index="0" name="idx" type="int" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_animations">
<return type="GLTFAnimation[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_buffer_views">
<return type="GLTFBufferView[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_cameras">
<return type="GLTFCamera[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_images">
<return type="Texture2D[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_lights">
<return type="GLTFLight[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_materials">
<return type="BaseMaterial3D[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_meshes">
<return type="GLTFMesh[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_nodes">
<return type="GLTFNode[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_scene_node">
<return type="Node" />
<param index="0" name="idx" type="int" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_skeleton_to_node">
<return type="Dictionary" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_skeletons">
<return type="GLTFSkeleton[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_skins">
<return type="GLTFSkin[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="get_texture_samplers">
<return type="GLTFTextureSampler[]" />
<description>
Retrieves the array of texture samplers that are used by the textures contained in the GLTF.
</description>
</method>
2021-01-04 14:33:44 +01:00
<method name="get_textures">
<return type="GLTFTexture[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
2021-03-10 10:54:21 +01:00
<method name="get_unique_animation_names">
<return type="String[]" />
2021-03-10 10:54:21 +01:00
<description>
</description>
</method>
2021-01-04 14:33:44 +01:00
<method name="get_unique_names">
<return type="String[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_accessors">
<return type="void" />
<param index="0" name="accessors" type="GLTFAccessor[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_animations">
<return type="void" />
<param index="0" name="animations" type="GLTFAnimation[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_buffer_views">
<return type="void" />
<param index="0" name="buffer_views" type="GLTFBufferView[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_cameras">
<return type="void" />
<param index="0" name="cameras" type="GLTFCamera[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_images">
<return type="void" />
<param index="0" name="images" type="Texture2D[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_lights">
<return type="void" />
<param index="0" name="lights" type="GLTFLight[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_materials">
<return type="void" />
<param index="0" name="materials" type="BaseMaterial3D[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_meshes">
<return type="void" />
<param index="0" name="meshes" type="GLTFMesh[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_nodes">
<return type="void" />
<param index="0" name="nodes" type="GLTFNode[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_skeleton_to_node">
<return type="void" />
<param index="0" name="skeleton_to_node" type="Dictionary" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_skeletons">
<return type="void" />
<param index="0" name="skeletons" type="GLTFSkeleton[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_skins">
<return type="void" />
<param index="0" name="skins" type="GLTFSkin[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
<method name="set_texture_samplers">
<return type="void" />
<param index="0" name="texture_samplers" type="GLTFTextureSampler[]" />
<description>
Sets the array of texture samplers that are used by the textures contained in the GLTF.
</description>
</method>
2021-01-04 14:33:44 +01:00
<method name="set_textures">
<return type="void" />
<param index="0" name="textures" type="GLTFTexture[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
2021-03-10 10:54:21 +01:00
<method name="set_unique_animation_names">
<return type="void" />
<param index="0" name="unique_animation_names" type="String[]" />
2021-03-10 10:54:21 +01:00
<description>
</description>
</method>
2021-01-04 14:33:44 +01:00
<method name="set_unique_names">
<return type="void" />
<param index="0" name="unique_names" type="String[]" />
2021-01-04 14:33:44 +01:00
<description>
</description>
</method>
</methods>
<members>
<member name="base_path" type="String" setter="set_base_path" getter="get_base_path" default="&quot;&quot;">
</member>
<member name="buffers" type="PackedByteArray[]" setter="set_buffers" getter="get_buffers" default="[]">
2021-01-04 14:33:44 +01:00
</member>
<member name="create_animations" type="bool" setter="set_create_animations" getter="get_create_animations" default="true">
</member>
<member name="glb_data" type="PackedByteArray" setter="set_glb_data" getter="get_glb_data" default="PackedByteArray()">
2021-01-04 14:33:44 +01:00
</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="PackedInt32Array" setter="set_root_nodes" getter="get_root_nodes" default="PackedInt32Array()">
2021-01-04 14:33:44 +01:00
</member>
<member name="scene_name" type="String" setter="set_scene_name" getter="get_scene_name" default="&quot;&quot;">
</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>