Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AICamera

extends Struct<AICamera>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct aiCamera
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Helper structure to describe a virtual camera.

Cameras have a representation in the node graph and can be animated. An important aspect is that the camera itself is also part of the scenegraph. This means, any values such as the look-at vector are not *absolute*, they're relative to the coordinate system defined by the node which corresponds to the camera. This allows for camera animations. For static cameras parameters like the 'look-at' or 'up' vectors are usually specified directly in aiCamera, but beware, they could also be encoded in the node transformation.

Layout


struct aiCamera {
    struct aiString mName;
    struct aiVector3D mPosition;
    struct aiVector3D mUp;
    struct aiVector3D mLookAt;
    float mHorizontalFOV;
    float mClipPlaneNear;
    float mClipPlaneFar;
    float mAspect;
    float mOrthographicWidth;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AICamera.Buffer

An array of AICamera structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MASPECT

The struct member offsets.

public static final int
MCLIPPLANEFAR

The struct member offsets.

public static final int
MCLIPPLANENEAR

The struct member offsets.

public static final int
MHORIZONTALFOV

The struct member offsets.

public static final int
MLOOKAT

The struct member offsets.

public static final int
MNAME

The struct member offsets.

public static final int
MORTHOGRAPHICWIDTH

The struct member offsets.

public static final int
MPOSITION

The struct member offsets.

public static final int
MUP

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
AICamera(long address, ByteBuffer container)

public
AICamera(ByteBuffer container)

Creates a AICamera instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static AICamera
calloc()

Returns a new AICamera instance allocated with memCalloc.

public static AICamera.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new AICamera.Buffer instance allocated with memCalloc.

public static AICamera
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new AICamera instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static AICamera.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new AICamera.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static AICamera
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static AICamera
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static AICamera.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static AICamera.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected AICamera
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static AICamera
create()

Returns a new AICamera instance allocated with BufferUtils.

public static AICamera
create(long address)

Returns a new AICamera instance for the specified memory address.

public static AICamera.Buffer
create(int
the buffer capacity
capacity)

Returns a new AICamera.Buffer instance allocated with BufferUtils.

public static AICamera.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a AICamera.Buffer instance at the specified memory.

public static AICamera
createSafe(long address)

Like create, but returns null if address is NULL.

public static AICamera.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static AICamera
malloc()

Returns a new AICamera instance allocated with memAlloc.

public static AICamera.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new AICamera.Buffer instance allocated with memAlloc.

public static AICamera
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new AICamera instance allocated on the specified MemoryStack.

public static AICamera.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new AICamera.Buffer instance allocated on the specified MemoryStack.

public static AICamera
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static AICamera
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static AICamera.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static AICamera.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public float
mAspect()

Screen aspect ratio.

public AICamera
mAspect(float value)

Sets the specified value to the mAspect field.

public float
mClipPlaneFar()

Distance of the far clipping plane from the camera.

public AICamera
mClipPlaneFar(float value)

Sets the specified value to the mClipPlaneFar field.

public float
mClipPlaneNear()

Distance of the near clipping plane from the camera.

public AICamera
mClipPlaneNear(float value)

Sets the specified value to the mClipPlaneNear field.

public float
mHorizontalFOV()

Horizontal field of view angle, in radians.

public AICamera
mHorizontalFOV(float value)

Sets the specified value to the mHorizontalFOV field.

public AIVector3D
mLookAt()

'LookAt' - vector of the camera coordinate system relative to the coordinate space defined by the corresponding node.

public AICamera
mLookAt(AIVector3D value)

Copies the specified AIVector3D to the mLookAt field.

public AICamera
mLookAt(Consumer<AIVector3D> consumer)

Passes the mLookAt field to the specified Consumer.

public AIString
mName()

The name of the camera.

public AICamera
mName(AIString value)

Copies the specified AIString to the mName field.

public AICamera
mName(Consumer<AIString> consumer)

Passes the mName field to the specified Consumer.

public float
mOrthographicWidth()

Half horizontal orthographic width, in scene units.

public AICamera
mOrthographicWidth(float value)

Sets the specified value to the mOrthographicWidth field.

public AIVector3D
mPosition()

Position of the camera relative to the coordinate space defined by the corresponding node.

public AICamera
mPosition(AIVector3D value)

Copies the specified AIVector3D to the mPosition field.

public AICamera
mPosition(Consumer<AIVector3D> consumer)

Passes the mPosition field to the specified Consumer.

public AIVector3D
mUp()

'Up' - vector of the camera coordinate system relative to the coordinate space defined by the corresponding node.

public AICamera
mUp(AIVector3D value)

Copies the specified AIVector3D to the mUp field.

public AICamera
mUp(Consumer<AIVector3D> consumer)

Passes the mUp field to the specified Consumer.

public static float
nmAspect(long struct)

Unsafe version of mAspect.

public static void
nmAspect(long struct, float value)

Unsafe version of mAspect.

public static float
nmClipPlaneFar(long struct)

Unsafe version of mClipPlaneFar.

public static void
nmClipPlaneFar(long struct, float value)

Unsafe version of mClipPlaneFar.

public static float
nmClipPlaneNear(long struct)

Unsafe version of mClipPlaneNear.

public static void
nmClipPlaneNear(long struct, float value)

Unsafe version of mClipPlaneNear.

public static float
nmHorizontalFOV(long struct)

Unsafe version of mHorizontalFOV.

public static void
nmHorizontalFOV(long struct, float value)

Unsafe version of mHorizontalFOV.

public static AIVector3D
nmLookAt(long struct)

Unsafe version of mLookAt.

public static void
nmLookAt(long struct, AIVector3D value)

Unsafe version of mLookAt.

public static AIString
nmName(long struct)

Unsafe version of mName.

public static void
nmName(long struct, AIString value)

Unsafe version of mName.

public static float
nmOrthographicWidth(long struct)

Unsafe version of mOrthographicWidth.

public static void
nmOrthographicWidth(long struct, float value)

Unsafe version of mOrthographicWidth.

public static AIVector3D
nmPosition(long struct)

Unsafe version of mPosition.

public static void
nmPosition(long struct, AIVector3D value)

Unsafe version of mPosition.

public static AIVector3D
nmUp(long struct)

Unsafe version of mUp.

public static void
nmUp(long struct, AIVector3D value)

Unsafe version of mUp.

public AICamera
set(AIString mName, AIVector3D mPosition, AIVector3D mUp, AIVector3D mLookAt, float mHorizontalFOV, float mClipPlaneNear, float mClipPlaneFar, float mAspect, float mOrthographicWidth)

Initializes this struct with the specified values.

public AICamera

Returns:

this struct
set(AICamera
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate