Helper structure to describe a light source.

Assimp supports multiple sorts of light sources, including directional, point and spot lights. All of them are defined with just a single structure and distinguished by their parameters. Note - some file formats (such as 3DS, ASE) export a "target point" - the point a spot light is looking at (it can even be animated). Assimp writes the target point as a sub-node of a spot-lights's main node, called "<spotName>.Target". However, this is just additional information then, the transformation tracks of the main node make the spot light already point in the right direction.

Layout


struct aiLight {
    struct aiString mName;
    aiLightSourceType mType;
    struct aiVector3D mPosition;
    struct aiVector3D mDirection;
    struct aiVector3D mUp;
    float mAttenuationConstant;
    float mAttenuationLinear;
    float mAttenuationQuadratic;
    struct aiColor3D mColorDiffuse;
    struct aiColor3D mColorSpecular;
    struct aiColor3D mColorAmbient;
    float mAngleInnerCone;
    float mAngleOuterCone;
    struct aiVector2D mSize;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	AILight.Buffer An array of `AILight` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	MANGLEINNERCONE The struct member offsets.
public static final int	MANGLEOUTERCONE The struct member offsets.
public static final int	MATTENUATIONCONSTANT The struct member offsets.
public static final int	MATTENUATIONLINEAR The struct member offsets.
public static final int	MATTENUATIONQUADRATIC The struct member offsets.
public static final int	MCOLORAMBIENT The struct member offsets.
public static final int	MCOLORDIFFUSE The struct member offsets.
public static final int	MCOLORSPECULAR The struct member offsets.
public static final int	MDIRECTION The struct member offsets.
public static final int	MNAME The struct member offsets.
public static final int	MPOSITION The struct member offsets.
public static final int	MSIZE The struct member offsets.
public static final int	MTYPE 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	AILight(long address, ByteBuffer container)
public	AILight(ByteBuffer container) Creates a `AILight` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
protected AILight	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 AILight	create(long address) Returns a new `AILight` instance for the specified memory address.
public static AILight.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `AILight.Buffer` instance at the specified memory.
public static AILight	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static AILight.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public float	mAngleInnerCone() Inner angle of a spot light's light cone.
public float	mAngleOuterCone() Outer angle of a spot light's light cone.
public float	mAttenuationConstant() Constant light attenuation factor.
public float	mAttenuationLinear() Linear light attenuation factor.
public float	mAttenuationQuadratic() Quadratic light attenuation factor.
public AIColor3D	mColorAmbient() Ambient color of the light source.
public AIColor3D	mColorDiffuse() Diffuse color of the light source.
public AIColor3D	mColorSpecular() Specular color of the light source.
public AIVector3D	mDirection() Direction of the light source in space.
public AIString	mName() The name of the light source.
public AIVector3D	mPosition() Position of the light source in space.
public AIVector2D	mSize() Size of area light source.
public int	mType() The type of the light source.
public AIVector3D	mUp() Up direction of the light source in space.
public static float	nmAngleInnerCone(long struct) Unsafe version of `mAngleInnerCone`.
public static float	nmAngleOuterCone(long struct) Unsafe version of `mAngleOuterCone`.
public static float	nmAttenuationConstant(long struct) Unsafe version of `mAttenuationConstant`.
public static float	nmAttenuationLinear(long struct) Unsafe version of `mAttenuationLinear`.
public static float	nmAttenuationQuadratic(long struct) Unsafe version of `mAttenuationQuadratic`.
public static AIColor3D	nmColorAmbient(long struct) Unsafe version of `mColorAmbient`.
public static AIColor3D	nmColorDiffuse(long struct) Unsafe version of `mColorDiffuse`.
public static AIColor3D	nmColorSpecular(long struct) Unsafe version of `mColorSpecular`.
public static AIVector3D	nmDirection(long struct) Unsafe version of `mDirection`.
public static AIString	nmName(long struct) Unsafe version of `mName`.
public static AIVector3D	nmPosition(long struct) Unsafe version of `mPosition`.
public static AIVector2D	nmSize(long struct) Unsafe version of `mSize`.
public static int	nmType(long struct) Unsafe version of `mType`.
public static AIVector3D	nmUp(long struct) Unsafe version of `mUp`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

MANGLEINNERCONE	back to summary
public static final int MANGLEINNERCONE The struct member offsets.

MANGLEOUTERCONE	back to summary
public static final int MANGLEOUTERCONE The struct member offsets.

MATTENUATIONCONSTANT	back to summary
public static final int MATTENUATIONCONSTANT The struct member offsets.

MATTENUATIONLINEAR	back to summary
public static final int MATTENUATIONLINEAR The struct member offsets.

MATTENUATIONQUADRATIC	back to summary
public static final int MATTENUATIONQUADRATIC The struct member offsets.

MCOLORAMBIENT	back to summary
public static final int MCOLORAMBIENT The struct member offsets.

MCOLORDIFFUSE	back to summary
public static final int MCOLORDIFFUSE The struct member offsets.

MCOLORSPECULAR	back to summary
public static final int MCOLORSPECULAR The struct member offsets.

MDIRECTION	back to summary
public static final int MDIRECTION The struct member offsets.

MNAME	back to summary
public static final int MNAME The struct member offsets.

MPOSITION	back to summary
public static final int MPOSITION The struct member offsets.

MSIZE	back to summary
public static final int MSIZE The struct member offsets.

MTYPE	back to summary
public static final int MTYPE The struct member offsets.

MUP	back to summary
public static final int MUP The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

AILight	back to summary
protected AILight(long address, ByteBuffer container)

AILight back to summary

AILight	back to summary
public AILight(ByteBuffer container) Creates a `AILight` instance at the current position of the specified `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 AILight(ByteBuffer container)

Creates a AILight instance at the current position of the specified 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.

Method Detail

create back to summary

create	back to summary
protected AILight create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected AILight create(long address, ByteBuffer container)

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

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static AILight create(long address) Returns a new `AILight` instance for the specified memory address.

create back to summary

create	back to summary
public static AILight.Buffer create(long address, int capacity) Create a `AILight.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static AILight.Buffer create(long address, int capacity)

Create a AILight.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static AILight createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static AILight createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static AILight.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

mAngleInnerCone	back to summary
public float mAngleInnerCone() Inner angle of a spot light's light cone. The spot light has maximum influence on objects inside this angle. The angle is given in radians. It is 2PI for point lights and undefined for directional lights.

mAngleOuterCone	back to summary
public float mAngleOuterCone() Outer angle of a spot light's light cone. The spot light does not affect objects outside this angle. The angle is given in radians. It is 2PI for point lights and undefined for directional lights. The outer angle must be greater than or equal to the inner angle. It is assumed that the application uses a smooth interpolation between the inner and the outer cone of the spot light.

mAngleOuterCone

back to summary

public float mAngleOuterCone()

Outer angle of a spot light's light cone. The spot light does not affect objects outside this angle. The angle is given in radians. It is 2PI for point lights and undefined for directional lights. The outer angle must be greater than or equal to the inner angle. It is assumed that the application uses a smooth interpolation between the inner and the outer cone of the spot light.

mAttenuationConstant	back to summary
public float mAttenuationConstant() Constant light attenuation factor. The intensity of the light source at a given distance 'd' from the light's position is `Atten = 1/( att0 + att1 * d + att2 * d*d)`. This member corresponds to the att0 variable in the equation. Naturally undefined for directional lights.

mAttenuationLinear	back to summary
public float mAttenuationLinear() Linear light attenuation factor. The intensity of the light source at a given distance 'd' from the light's position is `Atten = 1/( att0 + att1 * d + att2 * d*d)`. This member corresponds to the att1 variable in the equation. Naturally undefined for directional lights.

mAttenuationQuadratic	back to summary
public float mAttenuationQuadratic() Quadratic light attenuation factor. The intensity of the light source at a given distance 'd' from the light's position is `Atten = 1/( att0 + att1 * d + att2 * d*d)`. This member corresponds to the att2 variable in the equation. Naturally undefined for directional lights.

mColorAmbient	back to summary
public AIColor3D mColorAmbient() Ambient color of the light source. The ambient light color is multiplied with the ambient material color to obtain the final color that contributes to the ambient shading term. Most renderers will ignore this value it, is just a remaining of the fixed-function pipeline that is still supported by quite many file formats. Annotations @NativeType:struct aiColor3D

mColorAmbient

back to summary

public AIColor3D mColorAmbient()

Ambient color of the light source. The ambient light color is multiplied with the ambient material color to obtain the final color that contributes to the ambient shading term. Most renderers will ignore this value it, is just a remaining of the fixed-function pipeline that is still supported by quite many file formats.

Annotations

@NativeType:struct aiColor3D

mColorDiffuse	back to summary
public AIColor3D mColorDiffuse() Diffuse color of the light source. The diffuse light color is multiplied with the diffuse material color to obtain the final color that contributes to the diffuse shading term. Annotations @NativeType:struct aiColor3D

mColorDiffuse

back to summary

public AIColor3D mColorDiffuse()

Diffuse color of the light source. The diffuse light color is multiplied with the diffuse material color to obtain the final color that contributes to the diffuse shading term.

Annotations

@NativeType:struct aiColor3D

mColorSpecular	back to summary
public AIColor3D mColorSpecular() Specular color of the light source. The specular light color is multiplied with the specular material color to obtain the final color that contributes to the specular shading term. Annotations @NativeType:struct aiColor3D

mColorSpecular

back to summary

public AIColor3D mColorSpecular()

Specular color of the light source. The specular light color is multiplied with the specular material color to obtain the final color that contributes to the specular shading term.

Annotations

@NativeType:struct aiColor3D

mDirection	back to summary
public AIVector3D mDirection() Direction of the light source in space. Relative to the transformation of the node corresponding to the light. The direction is undefined for point lights. The vector may be normalized, but it needn't. Annotations @NativeType:struct aiVector3D

mDirection

back to summary

public AIVector3D mDirection()

Direction of the light source in space. Relative to the transformation of the node corresponding to the light. The direction is undefined for point lights. The vector may be normalized, but it needn't.

Annotations

@NativeType:struct aiVector3D

mName	back to summary
public AIString mName() The name of the light source. There must be a node in the scene-graph with the same name. This node specifies the position of the light in the scene hierarchy and can be animated. Annotations @NativeType:struct aiString

mName

back to summary

public AIString mName()

The name of the light source. There must be a node in the scene-graph with the same name. This node specifies the position of the light in the scene hierarchy and can be animated.

Annotations

@NativeType:struct aiString

mPosition	back to summary
public AIVector3D mPosition() Position of the light source in space. Relative to the transformation of the node corresponding to the light. The position is undefined for directional lights. Annotations @NativeType:struct aiVector3D

mPosition

back to summary

public AIVector3D mPosition()

Position of the light source in space. Relative to the transformation of the node corresponding to the light. The position is undefined for directional lights.

Annotations

@NativeType:struct aiVector3D

mSize	back to summary
public AIVector2D mSize() Size of area light source. Annotations @NativeType:struct aiVector2D

mSize

back to summary

public AIVector2D mSize()

Size of area light source.

Annotations

@NativeType:struct aiVector2D

mType back to summary

public int mType()

The type of the light source. LightSource_UNDEFINED is not a valid value for this member. One of:

`LightSource_DIRECTIONAL`	`LightSource_POINT`	`LightSource_SPOT`	`LightSource_AMBIENT`
`LightSource_AREA`

Annotations

@NativeType:aiLightSourceType

mUp	back to summary
public AIVector3D mUp() Up direction of the light source in space. Relative to the transformation of the node corresponding to the light. The direction is undefined for point lights. The vector may be normalized, but it needn't. Annotations @NativeType:struct aiVector3D

mUp

back to summary

public AIVector3D mUp()

Up direction of the light source in space. Relative to the transformation of the node corresponding to the light. The direction is undefined for point lights. The vector may be normalized, but it needn't.

Annotations

@NativeType:struct aiVector3D

nmAngleInnerCone	back to summary
public static float nmAngleInnerCone(long struct) Unsafe version of `mAngleInnerCone`.

nmAngleOuterCone	back to summary
public static float nmAngleOuterCone(long struct) Unsafe version of `mAngleOuterCone`.

nmAttenuationConstant	back to summary
public static float nmAttenuationConstant(long struct) Unsafe version of `mAttenuationConstant`.

nmAttenuationLinear	back to summary
public static float nmAttenuationLinear(long struct) Unsafe version of `mAttenuationLinear`.

nmAttenuationQuadratic	back to summary
public static float nmAttenuationQuadratic(long struct) Unsafe version of `mAttenuationQuadratic`.

nmColorAmbient	back to summary
public static AIColor3D nmColorAmbient(long struct) Unsafe version of `mColorAmbient`.

nmColorDiffuse	back to summary
public static AIColor3D nmColorDiffuse(long struct) Unsafe version of `mColorDiffuse`.

nmColorSpecular	back to summary
public static AIColor3D nmColorSpecular(long struct) Unsafe version of `mColorSpecular`.

nmDirection	back to summary
public static AIVector3D nmDirection(long struct) Unsafe version of `mDirection`.

nmName	back to summary
public static AIString nmName(long struct) Unsafe version of `mName`.

nmPosition	back to summary
public static AIVector3D nmPosition(long struct) Unsafe version of `mPosition`.

nmSize	back to summary
public static AIVector2D nmSize(long struct) Unsafe version of `mSize`.

nmType	back to summary
public static int nmType(long struct) Unsafe version of `mType`.

nmUp	back to summary
public static AIVector3D nmUp(long struct) Unsafe version of `mUp`.

sizeof back to summary

public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.assimp back to summary

public Class AILight.Buffer

Class Inheritance

extends StructBuffer<AILight, AILight.Buffer>

An array of AILight structs.

Field Summary

Modifier and Type	Field and Description
private static final AILight	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `AILight.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected AILight	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public float	Returns: the value of the `AILight#mAngleInnerCone` field. mAngleInnerCone()
public float	Returns: the value of the `AILight#mAngleOuterCone` field. mAngleOuterCone()
public float	Returns: the value of the `AILight#mAttenuationConstant` field. mAttenuationConstant()
public float	Returns: the value of the `AILight#mAttenuationLinear` field. mAttenuationLinear()
public float	Returns: the value of the `AILight#mAttenuationQuadratic` field. mAttenuationQuadratic()
public AIColor3D	Returns: a `AIColor3D` view of the `AILight#mColorAmbient` field. mColorAmbient()
public AIColor3D	Returns: a `AIColor3D` view of the `AILight#mColorDiffuse` field. mColorDiffuse()
public AIColor3D	Returns: a `AIColor3D` view of the `AILight#mColorSpecular` field. mColorSpecular()
public AIVector3D	Returns: a `AIVector3D` view of the `AILight#mDirection` field. mDirection()
public AIString	Returns: a `AIString` view of the `AILight#mName` field. mName()
public AIVector3D	Returns: a `AIVector3D` view of the `AILight#mPosition` field. mPosition()
public AIVector2D	Returns: a `AIVector2D` view of the `AILight#mSize` field. mSize()
public int	Returns: the value of the `AILight#mType` field. mType()
public AIVector3D	Returns: a `AIVector3D` view of the `AILight#mUp` field. mUp()
protected AILight.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final AILight ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new AILight.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 AILight#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory

back to summary

protected AILight getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

mAngleInnerCone	back to summary
public float mAngleInnerCone() Returns:float the value of the `AILight#mAngleInnerCone` field.

mAngleOuterCone	back to summary
public float mAngleOuterCone() Returns:float the value of the `AILight#mAngleOuterCone` field.

mAttenuationConstant	back to summary
public float mAttenuationConstant() Returns:float the value of the `AILight#mAttenuationConstant` field.

mAttenuationLinear	back to summary
public float mAttenuationLinear() Returns:float the value of the `AILight#mAttenuationLinear` field.

mAttenuationQuadratic	back to summary
public float mAttenuationQuadratic() Returns:float the value of the `AILight#mAttenuationQuadratic` field.

mColorAmbient	back to summary
public AIColor3D mColorAmbient() Returns:AIColor3D a `AIColor3D` view of the `AILight#mColorAmbient` field. Annotations @NativeType:struct aiColor3D

mColorDiffuse	back to summary
public AIColor3D mColorDiffuse() Returns:AIColor3D a `AIColor3D` view of the `AILight#mColorDiffuse` field. Annotations @NativeType:struct aiColor3D

mColorSpecular	back to summary
public AIColor3D mColorSpecular() Returns:AIColor3D a `AIColor3D` view of the `AILight#mColorSpecular` field. Annotations @NativeType:struct aiColor3D

mDirection	back to summary
public AIVector3D mDirection() Returns:AIVector3D a `AIVector3D` view of the `AILight#mDirection` field. Annotations @NativeType:struct aiVector3D

mName	back to summary
public AIString mName() Returns:AIString a `AIString` view of the `AILight#mName` field. Annotations @NativeType:struct aiString

mPosition	back to summary
public AIVector3D mPosition() Returns:AIVector3D a `AIVector3D` view of the `AILight#mPosition` field. Annotations @NativeType:struct aiVector3D

mSize	back to summary
public AIVector2D mSize() Returns:AIVector2D a `AIVector2D` view of the `AILight#mSize` field. Annotations @NativeType:struct aiVector2D

mType	back to summary
public int mType() Returns:int the value of the `AILight#mType` field. Annotations @NativeType:aiLightSourceType

mUp	back to summary
public AIVector3D mUp() Returns:AIVector3D a `AIVector3D` view of the `AILight#mUp` field. Annotations @NativeType:struct aiVector3D

self

back to summary

protected AILight.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override