de.javagl.jgltf.model.impl

Class DefaultCameraModel

java.lang.Object

de.javagl.jgltf.model.impl.AbstractNamedModelElement

de.javagl.jgltf.model.impl.DefaultCameraModel

All Implemented Interfaces:

CameraModel, NamedModelElement

public final class DefaultCameraModel
extends AbstractNamedModelElement
implements CameraModel

Implementation of a CameraModel

Constructor Summary

Constructors

Constructor and Description
DefaultCameraModel(java.util.function.Function<float[],float[]> viewMatrixComputer, java.util.function.BiFunction<float[],java.lang.Float,float[]> projectionMatrixComputer) Creates a new instance

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
void	setInstanceName(java.lang.String instanceName) Set the name of this camera model, suitable to be shown to a user
void	setNodeModel(NodeModel nodeModel) Set the NodeModel that the camera is attached to

Methods inherited from class de.javagl.jgltf.model.impl.AbstractNamedModelElement

getName, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getName

Constructor Detail

DefaultCameraModel

public DefaultCameraModel(java.util.function.Function<float[],float[]> viewMatrixComputer,
                          java.util.function.BiFunction<float[],java.lang.Float,float[]> projectionMatrixComputer)

Creates a new instance

Parameters:

viewMatrixComputer - The function that computes the view matrix

projectionMatrixComputer - The function that computes the projection matrix

Method Detail

setInstanceName

public void setInstanceName(java.lang.String instanceName)

Set the name of this camera model, suitable to be shown to a user

Parameters:

instanceName - The instance name

setNodeModel

public void setNodeModel(NodeModel nodeModel)

Set the NodeModel that the camera is attached to

Parameters:

nodeModel - The NodeModel that the camera is attached to

getInstanceName

public java.lang.String getInstanceName()

Description copied from interface: CameraModel

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.

Specified by:

getInstanceName in interface CameraModel

Returns:

The name of this camera model instance

getNodeModel

public NodeModel getNodeModel()

Description copied from interface: CameraModel

Returns the NodeModel that the camera is attached to

Specified by:

getNodeModel in interface CameraModel

Returns:

The NodeModel

computeViewMatrix

public float[] computeViewMatrix(float[] result)

Description copied from interface: CameraModel

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.

Specified by:

computeViewMatrix in interface CameraModel

Parameters:

result - The result array

Returns:

The result array

computeProjectionMatrix

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

Description copied from interface: CameraModel

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.

Specified by:

computeProjectionMatrix in interface CameraModel

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

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

Description copied from interface: CameraModel

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.

Specified by:

createViewMatrixSupplier in interface CameraModel

Returns:

The supplier.

createProjectionMatrixSupplier

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

Description copied from interface: CameraModel

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.

Specified by:

createProjectionMatrixSupplier in interface CameraModel

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