GltfModelNode
class GltfModelNode
GltfModelNode represents a node in a GltfModelEntity.
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 a node's mesh within the glTF graph. |
Unit |
@MainThreadSets a material override for a primitive of a node within the glTF graph. |
Public properties |
|
|---|---|
Int |
The index of this node in the flattened list of child nodes of the glTF model. |
Pose |
The |
Vector3 |
The scale of this node relative to its immediate parent |
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 a node's mesh within the glTF graph.
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 specified node, as defined in the glTF graph. Default is the first primitive of that node. |
| Throws | |
|---|---|
IllegalStateException |
if the node does not have 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 a node within the glTF graph.
The override is then applied to a primitive of that node's mesh at the specified primitiveIndex.
| Parameters | |
|---|---|
material: Material |
The new |
primitiveIndex: Int = 0 |
The zero-based index for the primitive of the specified node, as defined in the glTF graph. Default is the first primitive of that node. |
| Throws | |
|---|---|
IllegalArgumentException |
if the provided |
IllegalStateException |
if the node does not have a mesh. |
IndexOutOfBoundsException |
if the |
| See also | |
|---|---|
clearMaterialOverride |
Public properties
index
val index: Int
The index of this node in the flattened list of child nodes of the glTF model.
localPose
var localPose: Pose
The Pose of this node relative to its immediate parent GltfModelNode.
localScale
var localScale: Vector3
The scale of this node relative to its immediate parent GltfModelNode.
modelPose
var modelPose: Pose
The Pose of this node relative to the GltfModelEntity root.
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.