de.javagl.jgltf.model

Interface CameraModel

All Superinterfaces:

NamedModelElement

All Known Implementing Classes:

DefaultCameraModel

public interface CameraModel
extends NamedModelElement

An interface for a camera that is attached to a NodeModel

Method Summary

Modifier and Type	Method and Description
float[]	computeProjectionMatrix(float[] result, java.lang.Float aspectRatio) Compute the projection matrix for this camera.
float[]	computeViewMatrix(float[] result) Compute the view matrix for this camera.
java.util.function.Supplier<float[]>	createProjectionMatrixSupplier(java.util.function.DoubleSupplier aspectRatioSupplier) Create the supplier of the projection matrix for this camera model.
java.util.function.Supplier<float[]>	createViewMatrixSupplier() Create the supplier of the view matrix for this camera model.
java.lang.String	getInstanceName() Returns the name of this camera model instance, suitable to be shown to a user.
NodeModel	getNodeModel() Returns the NodeModel that the camera is attached to

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

getName

Method Detail

getInstanceName

java.lang.String getInstanceName()

Returns the name of this camera model instance, suitable to be shown to a user. In contrast to the pure name, this method will return a string that also contains information about the node that this camera instance is attached to.

Returns:

The name of this camera model instance

getNodeModel

NodeModel getNodeModel()

Returns the NodeModel that the camera is attached to

Returns:

The NodeModel

computeViewMatrix

float[] computeViewMatrix(float[] result)

Compute the view matrix for this camera. This is the inverse of the global transform of the node that the camera is attached to.

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

computeProjectionMatrix

float[] computeProjectionMatrix(float[] result,
                                java.lang.Float aspectRatio)

Compute the projection matrix for this camera.

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

aspectRatio - An optional aspect ratio that should be used. If this is null, then the aspect ratio of the camera will be used.

Returns:

The result array

createViewMatrixSupplier

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

Create the supplier of the view matrix for this camera 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.

createProjectionMatrixSupplier

java.util.function.Supplier<float[]> createProjectionMatrixSupplier(java.util.function.DoubleSupplier aspectRatioSupplier)

Create the supplier of the projection matrix for this camera model.

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

Note: If the type of the camera that this CameraModel was created for is neither "perspective" nor "orthographic", then the supplier will print an error message and return the identity matrix.

Parameters:

aspectRatioSupplier - The optional supplier for the aspect ratio of the camera. If this is null, then the aspect ratio of the camera will be used.

Returns:

The supplier