GltfModelNode
class GltfModelNode
GltfModelNode represents a node in a GltfModelEntity.
Nodes are the fundamental structural elements of a glTF scene. A GltfModelNode defines a spatial transformation and can be associated with other components such as a mesh. This class allows you to manipulate these spatial properties and, if a mesh is attached, override its rendering materials.
The lifecycle of a glTF node is tied to the glTF model itself. Trying to use the GltfModelNode after the GltfModelEntity is disposed will throw an IllegalStateException.
Summary
Public functions |
|
|---|---|
Unit |
@MainThreadClears a previously set material override for a specific primitive of the mesh associated with this node. |
Unit |
@MainThreadSets a material override for a primitive of the mesh associated with this node. |
Public properties |
|
|---|---|
Int |
The index of this node in the flattened list of nodes of the glTF model. |
Pose |
The |
Vector3 |
The scale of this node relative to its direct parent as defined in the source glTF asset. |
Pose |
The |
Vector3 |
The scale of this node relative to the |
String? |
The name of the node as defined in the glTF file. |
Public functions
clearMaterialOverride
@MainThread
fun clearMaterialOverride(primitiveIndex: Int = 0): Unit
Clears a previously set material override for a specific primitive of the mesh associated with this node.
If no override was previously set for that primitive, this call has no effect.
| Parameters | |
|---|---|
primitiveIndex: Int = 0 |
The zero-based index for the primitive of the associated mesh. The valid range is from |
| Throws | |
|---|---|
IllegalStateException |
if this node is not associated with a mesh. |
IndexOutOfBoundsException |
if the |
| See also | |
|---|---|
setMaterialOverride |
setMaterialOverride
@MainThread
fun setMaterialOverride(material: Material, primitiveIndex: Int = 0): Unit
Sets a material override for a primitive of the mesh associated with this node.
In a glTF model, a node may be associated with a mesh. A mesh consists of one or more geometric surfaces called primitives (such as a collection of triangles) that are rendered using a single material. This method applies a material override to a specific primitive within this node's associated mesh.
| Parameters | |
|---|---|
material: Material |
The new |
primitiveIndex: Int = 0 |
The zero-based index for the primitive of the associated mesh. The valid range is from |
| Throws | |
|---|---|
IllegalArgumentException |
if the provided |
IllegalStateException |
if this node is not associated with a mesh. |
IndexOutOfBoundsException |
if the |
| See also | |
|---|---|
clearMaterialOverride |
Public properties
index
val index: Int
The index of this node in the flattened list of nodes of the glTF model.
localPose
var localPose: Pose
The Pose of this node relative to its direct parent as defined in the source glTF asset.
Even though the API exposes nodes as a flattened list, their local transforms still respect the structure of the original glTF asset. If this node has no parent in the source asset, this pose is relative to the GltfModelEntity root.
localScale
var localScale: Vector3
The scale of this node relative to its direct parent as defined in the source glTF asset.
modelPose
var modelPose: Pose
The Pose of this node relative to the GltfModelEntity root.
Unlike localPose, which is strictly relative to the node's parent in the glTF file, the model pose represents the node's final, accumulated transformation within the model.
modelScale
var modelScale: Vector3
The scale of this node relative to the GltfModelEntity root.
name
val name: String?
The name of the node as defined in the glTF file. Returns null if the node has no name.