GLTFState

Inherits: Resource < RefCounted < Object

There is currently no description for this class. Please help us by contributing one!

Properties

String

base_path

""

PackedByteArray[]

buffers

[]

bool

create_animations

true

PackedByteArray

glb_data

PackedByteArray()

Dictionary

json

{}

int

major_version

0

int

minor_version

0

PackedInt32Array

root_nodes

PackedInt32Array()

String

scene_name

""

bool

use_named_skin_binds

false

Methods

void

add_used_extension ( String extension_name, bool required )

GLTFAccessor[]

get_accessors ( )

Variant

get_additional_data ( StringName extension_name )

AnimationPlayer

get_animation_player ( int idx )

int

get_animation_players_count ( int idx )

GLTFAnimation[]

get_animations ( )

GLTFBufferView[]

get_buffer_views ( )

GLTFCamera[]

get_cameras ( )

int

get_handle_binary_image ( )

Texture2D[]

get_images ( )

GLTFLight[]

get_lights ( )

Material[]

get_materials ( )

GLTFMesh[]

get_meshes ( )

GLTFNode[]

get_nodes ( )

Node

get_scene_node ( int idx )

Dictionary

get_skeleton_to_node ( )

GLTFSkeleton[]

get_skeletons ( )

GLTFSkin[]

get_skins ( )

GLTFTextureSampler[]

get_texture_samplers ( )

GLTFTexture[]

get_textures ( )

String[]

get_unique_animation_names ( )

String[]

get_unique_names ( )

void

set_accessors ( GLTFAccessor[] accessors )

void

set_additional_data ( StringName extension_name, Variant additional_data )

void

set_animations ( GLTFAnimation[] animations )

void

set_buffer_views ( GLTFBufferView[] buffer_views )

void

set_cameras ( GLTFCamera[] cameras )

void

set_handle_binary_image ( int method )

void

set_images ( Texture2D[] images )

void

set_lights ( GLTFLight[] lights )

void

set_materials ( Material[] materials )

void

set_meshes ( GLTFMesh[] meshes )

void

set_nodes ( GLTFNode[] nodes )

void

set_skeleton_to_node ( Dictionary skeleton_to_node )

void

set_skeletons ( GLTFSkeleton[] skeletons )

void

set_skins ( GLTFSkin[] skins )

void

set_texture_samplers ( GLTFTextureSampler[] texture_samplers )

void

set_textures ( GLTFTexture[] textures )

void

set_unique_animation_names ( String[] unique_animation_names )

void

set_unique_names ( String[] unique_names )


Constants

HANDLE_BINARY_DISCARD_TEXTURES = 0

HANDLE_BINARY_EXTRACT_TEXTURES = 1

HANDLE_BINARY_EMBED_AS_BASISU = 2


Property Descriptions

String base_path = ""

  • void set_base_path ( String value )

  • String get_base_path ( )

There is currently no description for this property. Please help us by contributing one!


PackedByteArray[] buffers = []

There is currently no description for this property. Please help us by contributing one!


bool create_animations = true

  • void set_create_animations ( bool value )

  • bool get_create_animations ( )

There is currently no description for this property. Please help us by contributing one!


PackedByteArray glb_data = PackedByteArray()

There is currently no description for this property. Please help us by contributing one!


Dictionary json = {}

There is currently no description for this property. Please help us by contributing one!


int major_version = 0

  • void set_major_version ( int value )

  • int get_major_version ( )

There is currently no description for this property. Please help us by contributing one!


int minor_version = 0

  • void set_minor_version ( int value )

  • int get_minor_version ( )

There is currently no description for this property. Please help us by contributing one!


PackedInt32Array root_nodes = PackedInt32Array()

There is currently no description for this property. Please help us by contributing one!


String scene_name = ""

  • void set_scene_name ( String value )

  • String get_scene_name ( )

There is currently no description for this property. Please help us by contributing one!


bool use_named_skin_binds = false

  • void set_use_named_skin_binds ( bool value )

  • bool get_use_named_skin_binds ( )

There is currently no description for this property. Please help us by contributing one!


Method Descriptions

void add_used_extension ( String extension_name, bool required )

Appends an extension to the list of extensions used by this GLTF file during serialization. If required is true, the extension will also be added to the list of required extensions. Do not run this in GLTFDocumentExtension._export_post, as that stage is too late to add extensions. The final list is sorted alphabetically.


GLTFAccessor[] get_accessors ( )

There is currently no description for this method. Please help us by contributing one!


Variant get_additional_data ( StringName extension_name )

Gets additional arbitrary data in this GLTFState instance. This can be used to keep per-file state data in GLTFDocumentExtension classes, which is important because they are stateless.

The argument should be the GLTFDocumentExtension name (does not have to match the extension name in the GLTF file), and the return value can be anything you set. If nothing was set, the return value is null.


AnimationPlayer get_animation_player ( int idx )

There is currently no description for this method. Please help us by contributing one!


int get_animation_players_count ( int idx )

There is currently no description for this method. Please help us by contributing one!


GLTFAnimation[] get_animations ( )

There is currently no description for this method. Please help us by contributing one!


GLTFBufferView[] get_buffer_views ( )

There is currently no description for this method. Please help us by contributing one!


GLTFCamera[] get_cameras ( )

There is currently no description for this method. Please help us by contributing one!


int get_handle_binary_image ( )

There is currently no description for this method. Please help us by contributing one!


Texture2D[] get_images ( )

There is currently no description for this method. Please help us by contributing one!


GLTFLight[] get_lights ( )

There is currently no description for this method. Please help us by contributing one!


Material[] get_materials ( )

There is currently no description for this method. Please help us by contributing one!


GLTFMesh[] get_meshes ( )

There is currently no description for this method. Please help us by contributing one!


GLTFNode[] get_nodes ( )

There is currently no description for this method. Please help us by contributing one!


Node get_scene_node ( int idx )

There is currently no description for this method. Please help us by contributing one!


Dictionary get_skeleton_to_node ( )

There is currently no description for this method. Please help us by contributing one!


GLTFSkeleton[] get_skeletons ( )

There is currently no description for this method. Please help us by contributing one!


GLTFSkin[] get_skins ( )

There is currently no description for this method. Please help us by contributing one!


GLTFTextureSampler[] get_texture_samplers ( )

Retrieves the array of texture samplers that are used by the textures contained in the GLTF.


GLTFTexture[] get_textures ( )

There is currently no description for this method. Please help us by contributing one!


String[] get_unique_animation_names ( )

There is currently no description for this method. Please help us by contributing one!


String[] get_unique_names ( )

There is currently no description for this method. Please help us by contributing one!


void set_accessors ( GLTFAccessor[] accessors )

There is currently no description for this method. Please help us by contributing one!


void set_additional_data ( StringName extension_name, Variant additional_data )

Sets additional arbitrary data in this GLTFState instance. This can be used to keep per-file state data in GLTFDocumentExtension classes, which is important because they are stateless.

The first argument should be the GLTFDocumentExtension name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want.


void set_animations ( GLTFAnimation[] animations )

There is currently no description for this method. Please help us by contributing one!


void set_buffer_views ( GLTFBufferView[] buffer_views )

There is currently no description for this method. Please help us by contributing one!


void set_cameras ( GLTFCamera[] cameras )

There is currently no description for this method. Please help us by contributing one!


void set_handle_binary_image ( int method )

There is currently no description for this method. Please help us by contributing one!


void set_images ( Texture2D[] images )

There is currently no description for this method. Please help us by contributing one!


void set_lights ( GLTFLight[] lights )

There is currently no description for this method. Please help us by contributing one!


void set_materials ( Material[] materials )

There is currently no description for this method. Please help us by contributing one!


void set_meshes ( GLTFMesh[] meshes )

There is currently no description for this method. Please help us by contributing one!


void set_nodes ( GLTFNode[] nodes )

There is currently no description for this method. Please help us by contributing one!


void set_skeleton_to_node ( Dictionary skeleton_to_node )

There is currently no description for this method. Please help us by contributing one!


void set_skeletons ( GLTFSkeleton[] skeletons )

There is currently no description for this method. Please help us by contributing one!


void set_skins ( GLTFSkin[] skins )

There is currently no description for this method. Please help us by contributing one!


void set_texture_samplers ( GLTFTextureSampler[] texture_samplers )

Sets the array of texture samplers that are used by the textures contained in the GLTF.


void set_textures ( GLTFTexture[] textures )

There is currently no description for this method. Please help us by contributing one!


void set_unique_animation_names ( String[] unique_animation_names )

There is currently no description for this method. Please help us by contributing one!


void set_unique_names ( String[] unique_names )

There is currently no description for this method. Please help us by contributing one!