Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

GLTFNode

Inherits: Resource < RefCounted < Object

GLTF node class.

Description

Represents a GLTF node. GLTF nodes may have names, transforms, children (other GLTF nodes), and more specialized properties (represented by their own classes).

GLTF nodes generally exist inside of GLTFState which represents all data of a GLTF file. Most of GLTFNode's properties are indices of other data in the GLTF file. You can extend a GLTF node with additional properties by using get_additional_data and set_additional_data.

Tutorials

Properties

int

camera

-1

PackedInt32Array

children

PackedInt32Array()

int

height

-1

int

light

-1

int

mesh

-1

String

original_name

""

int

parent

-1

Vector3

position

Vector3(0, 0, 0)

Quaternion

rotation

Quaternion(0, 0, 0, 1)

Vector3

scale

Vector3(1, 1, 1)

int

skeleton

-1

int

skin

-1

Transform3D

xform

Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

Methods

Variant

get_additional_data(extension_name: StringName)

void

set_additional_data(extension_name: StringName, additional_data: Variant)


Property Descriptions

int camera = -1

  • void set_camera(value: int)

  • int get_camera()

If this GLTF node is a camera, the index of the GLTFCamera in the GLTFState that describes the camera's properties. If -1, this node is not a camera.


PackedInt32Array children = PackedInt32Array()

The indices of the child nodes in the GLTFState. If this GLTF node has no children, this will be an empty array.


int height = -1

  • void set_height(value: int)

  • int get_height()

How deep into the node hierarchy this node is. A root node will have a height of 0, its children will have a height of 1, and so on. If -1, the height has not been calculated.


int light = -1

  • void set_light(value: int)

  • int get_light()

If this GLTF node is a light, the index of the GLTFLight in the GLTFState that describes the light's properties. If -1, this node is not a light.


int mesh = -1

  • void set_mesh(value: int)

  • int get_mesh()

If this GLTF node is a mesh, the index of the GLTFMesh in the GLTFState that describes the mesh's properties. If -1, this node is not a mesh.


String original_name = ""

  • void set_original_name(value: String)

  • String get_original_name()

The original name of the node.


int parent = -1

  • void set_parent(value: int)

  • int get_parent()

The index of the parent node in the GLTFState. If -1, this node is a root node.


Vector3 position = Vector3(0, 0, 0)

The position of the GLTF node relative to its parent.


Quaternion rotation = Quaternion(0, 0, 0, 1)

The rotation of the GLTF node relative to its parent.


Vector3 scale = Vector3(1, 1, 1)

The scale of the GLTF node relative to its parent.


int skeleton = -1

  • void set_skeleton(value: int)

  • int get_skeleton()

If this GLTF node has a skeleton, the index of the GLTFSkeleton in the GLTFState that describes the skeleton's properties. If -1, this node does not have a skeleton.


int skin = -1

  • void set_skin(value: int)

  • int get_skin()

If this GLTF node has a skin, the index of the GLTFSkin in the GLTFState that describes the skin's properties. If -1, this node does not have a skin.


Transform3D xform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

The transform of the GLTF node relative to its parent. This property is usually unused since the position, rotation, and scale properties are preferred.


Method Descriptions

Variant get_additional_data(extension_name: StringName)

Gets additional arbitrary data in this GLTFNode instance. This can be used to keep per-node 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.


void set_additional_data(extension_name: StringName, additional_data: Variant)

Sets additional arbitrary data in this GLTFNode instance. This can be used to keep per-node 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.


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.