de.javagl.jgltf.model

Interface NodeModel

All Superinterfaces:

ModelElement, NamedModelElement

All Known Implementing Classes:

DefaultNodeModel

public interface NodeModel
extends NamedModelElement

Interface for a node that is part of a scene hierarchy

Method Summary

Modifier and Type	Method and Description
float[]	computeGlobalTransform(float[] result) Computes the global transform of this node.
float[]	computeLocalTransform(float[] result) Computes the local transform of this node.
java.util.function.Supplier<float[]>	createGlobalTransformSupplier() Creates a supplier for the global transform matrix of this node model.
java.util.function.Supplier<float[]>	createLocalTransformSupplier() Creates a supplier for the local transform matrix of this node model.
CameraModel	getCameraModel() Returns the CameraModel for this node, or null if this node is not associated with a camera
java.util.List<NodeModel>	getChildren() Returns an unmodifiable view on the list of children of this node
float[]	getMatrix() Returns a reference to the array storing the matrix of this node.
java.util.List<MeshModel>	getMeshModels() Returns an unmodifiable view on the list of MeshModel instances that are attached to this node.
NodeModel	getParent() Returns the parent of this node, or null if this is a root node
float[]	getRotation() Returns a reference to the array storing the rotation of this node, or null if no rotation was set
float[]	getScale() Returns a reference to the array storing the scale of this node, or null if no scale was set
SkinModel	getSkinModel() Returns the SkinModel for this node, or null if this node is not associated with a skin
float[]	getTranslation() Returns a reference to the array storing the translation of this node, or null if no translation was set.
float[]	getWeights() Returns a reference to the morph target weights, or null if no morph target weights have been defined
void	setMatrix(float[] matrix) Set the matrix of this node to be a reference to the given array.
void	setRotation(float[] rotation) Set the rotation of this node to be a reference to the given array.
void	setScale(float[] scale) Set the scale of this node to be a reference to the given array.
void	setTranslation(float[] translation) Set the translation of this node to be a reference to the given array.
void	setWeights(float[] weights) Set the morph target weights to be a reference to the given array.

Methods inherited from interface de.javagl.jgltf.model.NamedModelElement

getName

Methods inherited from interface de.javagl.jgltf.model.ModelElement

getExtensions, getExtras

Method Detail

getParent

NodeModel getParent()

Returns the parent of this node, or null if this is a root node

Returns:

The parent

getChildren

java.util.List<NodeModel> getChildren()

Returns an unmodifiable view on the list of children of this node

Returns:

The children

getMeshModels

java.util.List<MeshModel> getMeshModels()

Returns an unmodifiable view on the list of MeshModel instances that are attached to this node.

Returns:

The MeshModel list

getSkinModel

SkinModel getSkinModel()

Returns the SkinModel for this node, or null if this node is not associated with a skin

Returns:

The SkinModel

getCameraModel

CameraModel getCameraModel()

Returns the CameraModel for this node, or null if this node is not associated with a camera

Returns:

The CameraModel

setMatrix

void setMatrix(float[] matrix)

Set the matrix of this node to be a reference to the given array.

The matrix is assumed to be a 16-element array containing the matrix in column-major order. If the given matrix is null, then the translation, rotation, and scale properties will be used for determining the local transform.

Parameters:

matrix - The matrix

Throws:

java.lang.IllegalArgumentException - If the given array does not have a length of 16

getMatrix

float[] getMatrix()

Returns a reference to the array storing the matrix of this node. This is a 16-element array containing the matrix in column-major order, or null if no matrix was set.

Returns:

The matrix

setTranslation

void setTranslation(float[] translation)

Set the translation of this node to be a reference to the given array.

Parameters:

translation - The translation

Throws:

java.lang.IllegalArgumentException - If the given array does not have a length of 3

getTranslation

float[] getTranslation()

Returns a reference to the array storing the translation of this node, or null if no translation was set.

Returns:

The translation

setRotation

void setRotation(float[] rotation)

Set the rotation of this node to be a reference to the given array. The array is assumed to be a quaternion, consisting of 4 float elements.

Parameters:

rotation - The rotation

Throws:

java.lang.IllegalArgumentException - If the given array does not have a length of 4

getRotation

float[] getRotation()

Returns a reference to the array storing the rotation of this node, or null if no rotation was set

Returns:

The rotation

setScale

void setScale(float[] scale)

Set the scale of this node to be a reference to the given array.

Parameters:

scale - The scale

Throws:

java.lang.IllegalArgumentException - If the given array does not have a length of 3

getScale

float[] getScale()

Returns a reference to the array storing the scale of this node, or null if no scale was set

Returns:

The scale

setWeights

void setWeights(float[] weights)

Set the morph target weights to be a reference to the given array.

Parameters:

weights - The weights

getWeights

float[] getWeights()

Returns a reference to the morph target weights, or null if no morph target weights have been defined

Returns:

The morph target weights

computeLocalTransform

float[] computeLocalTransform(float[] result)

Computes the local transform of this node.

The result will be written to the given array, as a 4x4 matrix in column major order. If the given array is null or does not have a length of 16, then a new array with length 16 will be created and returned.

Parameters:

result - The result array

Returns:

The result array

computeGlobalTransform

float[] computeGlobalTransform(float[] result)

Computes the global transform of this node.

The result will be written to the given array, as a 4x4 matrix in column major order. If the given array is null or does not have a length of 16, then a new array with length 16 will be created and returned.

Parameters:

result - The result array

Returns:

The result array

createGlobalTransformSupplier

java.util.function.Supplier<float[]> createGlobalTransformSupplier()

Creates a supplier for the global transform matrix of this node model.

The matrix will be provided as a float array with 16 elements, storing the matrix entries in column-major order.

Note: The supplier MAY always return the same array instance. Callers MUST NOT store or modify the returned array.

Returns:

The supplier

createLocalTransformSupplier

java.util.function.Supplier<float[]> createLocalTransformSupplier()

Creates a supplier for the local transform matrix of this node model.

The matrix will be provided as a float array with 16 elements, storing the matrix entries in column-major order.

Note: The supplier MAY always return the same array instance. Callers MUST NOT store or modify the returned array.

Returns:

The supplier