org.lwjgl.assimp.AICamera Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-assimp Show documentation
Show all versions of lwjgl-assimp Show documentation
A portable Open Source library to import various well-known 3D model formats in a uniform manner.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.assimp;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* 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
* {@code aiCamera}, but beware, they could also be encoded in the node transformation.
*
* Member documentation
*
*
* - {@code mName} –
* The name of the camera. There must be a node in the scenegraph with the same name. This node specifies the position of the camera in the scene
* hierarchy and can be animated.
* - {@code mPosition} – Position of the camera relative to the coordinate space defined by the corresponding node. The default value is 0|0|0.
* - {@code mUp} –
* 'Up' - vector of the camera coordinate system relative to the coordinate space defined by the corresponding node. The 'right' vector of the camera
* coordinate system is the cross product of the up and lookAt vectors. The default value is 0|1|0. The vector may be normalized, but it needn't.
* - {@code mLookAt} –
* 'LookAt' - vector of the camera coordinate system relative to the coordinate space defined by the corresponding node. This is the viewing direction of
* the user. The default value is 0|0|1. The vector may be normalized, but it needn't.
* - {@code mHorizontalFOV} –
* Half horizontal field of view angle, in radians. The field of view angle is the angle between the center line of the screen and the left or right
* border. The default value is 1/4PI.
* - {@code mClipPlaneNear} –
* Distance of the near clipping plane from the camera. The value may not be 0.f (for arithmetic reasons to prevent a division through zero). The default
* value is 0.1f.
* - {@code mClipPlaneFar} – Distance of the far clipping plane from the camera. The far clipping plane must, of course, be further away than the near clipping plane. The
* default value is 1000.f. The ratio between the near and the far plane should not be too large (between 1000-10000 should be ok) to avoid floating-point
* inaccuracies which could lead to z-fighting.
* - {@code mAspect} –
* Screen aspect ratio. This is the ration between the width and the height of the screen. Typical values are 4/3, 1/2 or 1/1. This value is 0 if the
* aspect ratio is not defined in the source file. 0 is also the default value.
*
*
* Layout
*
*
* struct aiCamera {
* {@link AIString struct aiString} mName;
* {@link AIVector3D struct aiVector3D} mPosition;
* {@link AIVector3D struct aiVector3D} mUp;
* {@link AIVector3D struct aiVector3D} mLookAt;
* float mHorizontalFOV;
* float mClipPlaneNear;
* float mClipPlaneFar;
* float mAspect;
* }
*/
@NativeType("struct aiCamera")
public class AICamera extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
MNAME,
MPOSITION,
MUP,
MLOOKAT,
MHORIZONTALFOV,
MCLIPPLANENEAR,
MCLIPPLANEFAR,
MASPECT;
static {
Layout layout = __struct(
__member(AIString.SIZEOF, AIString.ALIGNOF),
__member(AIVector3D.SIZEOF, AIVector3D.ALIGNOF),
__member(AIVector3D.SIZEOF, AIVector3D.ALIGNOF),
__member(AIVector3D.SIZEOF, AIVector3D.ALIGNOF),
__member(4),
__member(4),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
MNAME = layout.offsetof(0);
MPOSITION = layout.offsetof(1);
MUP = layout.offsetof(2);
MLOOKAT = layout.offsetof(3);
MHORIZONTALFOV = layout.offsetof(4);
MCLIPPLANENEAR = layout.offsetof(5);
MCLIPPLANEFAR = layout.offsetof(6);
MASPECT = layout.offsetof(7);
}
/**
* Creates a {@link AICamera} instance at the current position of the specified {@link ByteBuffer} container. Changes to the buffer's content will be
* visible to the struct instance and vice versa.
*
* The created instance holds a strong reference to the container object.
*/
public AICamera(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link AIString} view of the {@code mName} field. */
@NativeType("struct aiString")
public AIString mName() { return nmName(address()); }
/** Passes the {@code mName} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera mName(java.util.function.Consumer consumer) { consumer.accept(mName()); return this; }
/** Returns a {@link AIVector3D} view of the {@code mPosition} field. */
@NativeType("struct aiVector3D")
public AIVector3D mPosition() { return nmPosition(address()); }
/** Passes the {@code mPosition} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera mPosition(java.util.function.Consumer consumer) { consumer.accept(mPosition()); return this; }
/** Returns a {@link AIVector3D} view of the {@code mUp} field. */
@NativeType("struct aiVector3D")
public AIVector3D mUp() { return nmUp(address()); }
/** Passes the {@code mUp} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera mUp(java.util.function.Consumer consumer) { consumer.accept(mUp()); return this; }
/** Returns a {@link AIVector3D} view of the {@code mLookAt} field. */
@NativeType("struct aiVector3D")
public AIVector3D mLookAt() { return nmLookAt(address()); }
/** Passes the {@code mLookAt} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera mLookAt(java.util.function.Consumer consumer) { consumer.accept(mLookAt()); return this; }
/** Returns the value of the {@code mHorizontalFOV} field. */
public float mHorizontalFOV() { return nmHorizontalFOV(address()); }
/** Returns the value of the {@code mClipPlaneNear} field. */
public float mClipPlaneNear() { return nmClipPlaneNear(address()); }
/** Returns the value of the {@code mClipPlaneFar} field. */
public float mClipPlaneFar() { return nmClipPlaneFar(address()); }
/** Returns the value of the {@code mAspect} field. */
public float mAspect() { return nmAspect(address()); }
/** Copies the specified {@link AIString} to the {@code mName} field. */
public AICamera mName(@NativeType("struct aiString") AIString value) { nmName(address(), value); return this; }
/** Copies the specified {@link AIVector3D} to the {@code mPosition} field. */
public AICamera mPosition(@NativeType("struct aiVector3D") AIVector3D value) { nmPosition(address(), value); return this; }
/** Copies the specified {@link AIVector3D} to the {@code mUp} field. */
public AICamera mUp(@NativeType("struct aiVector3D") AIVector3D value) { nmUp(address(), value); return this; }
/** Copies the specified {@link AIVector3D} to the {@code mLookAt} field. */
public AICamera mLookAt(@NativeType("struct aiVector3D") AIVector3D value) { nmLookAt(address(), value); return this; }
/** Sets the specified value to the {@code mHorizontalFOV} field. */
public AICamera mHorizontalFOV(float value) { nmHorizontalFOV(address(), value); return this; }
/** Sets the specified value to the {@code mClipPlaneNear} field. */
public AICamera mClipPlaneNear(float value) { nmClipPlaneNear(address(), value); return this; }
/** Sets the specified value to the {@code mClipPlaneFar} field. */
public AICamera mClipPlaneFar(float value) { nmClipPlaneFar(address(), value); return this; }
/** Sets the specified value to the {@code mAspect} field. */
public AICamera mAspect(float value) { nmAspect(address(), value); return this; }
/** Initializes this struct with the specified values. */
public AICamera set(
AIString mName,
AIVector3D mPosition,
AIVector3D mUp,
AIVector3D mLookAt,
float mHorizontalFOV,
float mClipPlaneNear,
float mClipPlaneFar,
float mAspect
) {
mName(mName);
mPosition(mPosition);
mUp(mUp);
mLookAt(mLookAt);
mHorizontalFOV(mHorizontalFOV);
mClipPlaneNear(mClipPlaneNear);
mClipPlaneFar(mClipPlaneFar);
mAspect(mAspect);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public AICamera set(AICamera src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link AICamera} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static AICamera malloc() {
return wrap(AICamera.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link AICamera} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static AICamera calloc() {
return wrap(AICamera.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link AICamera} instance allocated with {@link BufferUtils}. */
public static AICamera create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(AICamera.class, memAddress(container), container);
}
/** Returns a new {@link AICamera} instance for the specified memory address. */
public static AICamera create(long address) {
return wrap(AICamera.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static AICamera createSafe(long address) {
return address == NULL ? null : wrap(AICamera.class, address);
}
/**
* Returns a new {@link AICamera.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static AICamera.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link AICamera.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static AICamera.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link AICamera.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static AICamera.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link AICamera.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static AICamera.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static AICamera.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Returns a new {@link AICamera} instance allocated on the thread-local {@link MemoryStack}. */
public static AICamera mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link AICamera} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static AICamera callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link AICamera} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static AICamera mallocStack(MemoryStack stack) {
return wrap(AICamera.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link AICamera} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static AICamera callocStack(MemoryStack stack) {
return wrap(AICamera.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link AICamera.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static AICamera.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link AICamera.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static AICamera.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link AICamera.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static AICamera.Buffer mallocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link AICamera.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static AICamera.Buffer callocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #mName}. */
public static AIString nmName(long struct) { return AIString.create(struct + AICamera.MNAME); }
/** Unsafe version of {@link #mPosition}. */
public static AIVector3D nmPosition(long struct) { return AIVector3D.create(struct + AICamera.MPOSITION); }
/** Unsafe version of {@link #mUp}. */
public static AIVector3D nmUp(long struct) { return AIVector3D.create(struct + AICamera.MUP); }
/** Unsafe version of {@link #mLookAt}. */
public static AIVector3D nmLookAt(long struct) { return AIVector3D.create(struct + AICamera.MLOOKAT); }
/** Unsafe version of {@link #mHorizontalFOV}. */
public static float nmHorizontalFOV(long struct) { return UNSAFE.getFloat(null, struct + AICamera.MHORIZONTALFOV); }
/** Unsafe version of {@link #mClipPlaneNear}. */
public static float nmClipPlaneNear(long struct) { return UNSAFE.getFloat(null, struct + AICamera.MCLIPPLANENEAR); }
/** Unsafe version of {@link #mClipPlaneFar}. */
public static float nmClipPlaneFar(long struct) { return UNSAFE.getFloat(null, struct + AICamera.MCLIPPLANEFAR); }
/** Unsafe version of {@link #mAspect}. */
public static float nmAspect(long struct) { return UNSAFE.getFloat(null, struct + AICamera.MASPECT); }
/** Unsafe version of {@link #mName(AIString) mName}. */
public static void nmName(long struct, AIString value) { memCopy(value.address(), struct + AICamera.MNAME, AIString.SIZEOF); }
/** Unsafe version of {@link #mPosition(AIVector3D) mPosition}. */
public static void nmPosition(long struct, AIVector3D value) { memCopy(value.address(), struct + AICamera.MPOSITION, AIVector3D.SIZEOF); }
/** Unsafe version of {@link #mUp(AIVector3D) mUp}. */
public static void nmUp(long struct, AIVector3D value) { memCopy(value.address(), struct + AICamera.MUP, AIVector3D.SIZEOF); }
/** Unsafe version of {@link #mLookAt(AIVector3D) mLookAt}. */
public static void nmLookAt(long struct, AIVector3D value) { memCopy(value.address(), struct + AICamera.MLOOKAT, AIVector3D.SIZEOF); }
/** Unsafe version of {@link #mHorizontalFOV(float) mHorizontalFOV}. */
public static void nmHorizontalFOV(long struct, float value) { UNSAFE.putFloat(null, struct + AICamera.MHORIZONTALFOV, value); }
/** Unsafe version of {@link #mClipPlaneNear(float) mClipPlaneNear}. */
public static void nmClipPlaneNear(long struct, float value) { UNSAFE.putFloat(null, struct + AICamera.MCLIPPLANENEAR, value); }
/** Unsafe version of {@link #mClipPlaneFar(float) mClipPlaneFar}. */
public static void nmClipPlaneFar(long struct, float value) { UNSAFE.putFloat(null, struct + AICamera.MCLIPPLANEFAR, value); }
/** Unsafe version of {@link #mAspect(float) mAspect}. */
public static void nmAspect(long struct, float value) { UNSAFE.putFloat(null, struct + AICamera.MASPECT, value); }
// -----------------------------------
/** An array of {@link AICamera} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final AICamera ELEMENT_FACTORY = AICamera.create(-1L);
/**
* Creates a new {@link AICamera.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link AICamera#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected AICamera getElementFactory() {
return ELEMENT_FACTORY;
}
/** Returns a {@link AIString} view of the {@code mName} field. */
@NativeType("struct aiString")
public AIString mName() { return AICamera.nmName(address()); }
/** Passes the {@code mName} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera.Buffer mName(java.util.function.Consumer consumer) { consumer.accept(mName()); return this; }
/** Returns a {@link AIVector3D} view of the {@code mPosition} field. */
@NativeType("struct aiVector3D")
public AIVector3D mPosition() { return AICamera.nmPosition(address()); }
/** Passes the {@code mPosition} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera.Buffer mPosition(java.util.function.Consumer consumer) { consumer.accept(mPosition()); return this; }
/** Returns a {@link AIVector3D} view of the {@code mUp} field. */
@NativeType("struct aiVector3D")
public AIVector3D mUp() { return AICamera.nmUp(address()); }
/** Passes the {@code mUp} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera.Buffer mUp(java.util.function.Consumer consumer) { consumer.accept(mUp()); return this; }
/** Returns a {@link AIVector3D} view of the {@code mLookAt} field. */
@NativeType("struct aiVector3D")
public AIVector3D mLookAt() { return AICamera.nmLookAt(address()); }
/** Passes the {@code mLookAt} field to the specified {@link java.util.function.Consumer Consumer}. */
public AICamera.Buffer mLookAt(java.util.function.Consumer consumer) { consumer.accept(mLookAt()); return this; }
/** Returns the value of the {@code mHorizontalFOV} field. */
public float mHorizontalFOV() { return AICamera.nmHorizontalFOV(address()); }
/** Returns the value of the {@code mClipPlaneNear} field. */
public float mClipPlaneNear() { return AICamera.nmClipPlaneNear(address()); }
/** Returns the value of the {@code mClipPlaneFar} field. */
public float mClipPlaneFar() { return AICamera.nmClipPlaneFar(address()); }
/** Returns the value of the {@code mAspect} field. */
public float mAspect() { return AICamera.nmAspect(address()); }
/** Copies the specified {@link AIString} to the {@code mName} field. */
public AICamera.Buffer mName(@NativeType("struct aiString") AIString value) { AICamera.nmName(address(), value); return this; }
/** Copies the specified {@link AIVector3D} to the {@code mPosition} field. */
public AICamera.Buffer mPosition(@NativeType("struct aiVector3D") AIVector3D value) { AICamera.nmPosition(address(), value); return this; }
/** Copies the specified {@link AIVector3D} to the {@code mUp} field. */
public AICamera.Buffer mUp(@NativeType("struct aiVector3D") AIVector3D value) { AICamera.nmUp(address(), value); return this; }
/** Copies the specified {@link AIVector3D} to the {@code mLookAt} field. */
public AICamera.Buffer mLookAt(@NativeType("struct aiVector3D") AIVector3D value) { AICamera.nmLookAt(address(), value); return this; }
/** Sets the specified value to the {@code mHorizontalFOV} field. */
public AICamera.Buffer mHorizontalFOV(float value) { AICamera.nmHorizontalFOV(address(), value); return this; }
/** Sets the specified value to the {@code mClipPlaneNear} field. */
public AICamera.Buffer mClipPlaneNear(float value) { AICamera.nmClipPlaneNear(address(), value); return this; }
/** Sets the specified value to the {@code mClipPlaneFar} field. */
public AICamera.Buffer mClipPlaneFar(float value) { AICamera.nmClipPlaneFar(address(), value); return this; }
/** Sets the specified value to the {@code mAspect} field. */
public AICamera.Buffer mAspect(float value) { AICamera.nmAspect(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy