Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AISkeleton

extends Struct<AISkeleton>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct aiSkeleton
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

A skeleton represents the bone hierarchy of an animation.

Skeleton animations can be described as a tree of bones:


   root
     |
   node1
   /   \
node3  node4

If you want to calculate the transformation of node three you need to compute the transformation hierarchy for the transformation chain of node3:


root->node1->node3

Each node is represented as a skeleton instance.

Layout


struct aiSkeleton {
    struct aiString mName;
    unsigned int mNumBones;
    struct aiSkeletonBone ** mBones;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AISkeleton.Buffer

An array of AISkeleton structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MBONES

The struct member offsets.

public static final int
MNAME

The struct member offsets.

public static final int
MNUMBONES

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
AISkeleton(long address, ByteBuffer container)

public
AISkeleton(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AISkeleton
calloc()

Returns a new AISkeleton instance allocated with memCalloc.

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

Returns a new AISkeleton.Buffer instance allocated with memCalloc.

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

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

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

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

protected AISkeleton
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 AISkeleton
create()

Returns a new AISkeleton instance allocated with BufferUtils.

public static AISkeleton
create(long address)

Returns a new AISkeleton instance for the specified memory address.

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

Returns a new AISkeleton.Buffer instance allocated with BufferUtils.

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

Create a AISkeleton.Buffer instance at the specified memory.

public static AISkeleton
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static AISkeleton
malloc()

Returns a new AISkeleton instance allocated with memAlloc.

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

Returns a new AISkeleton.Buffer instance allocated with memAlloc.

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

Returns a new AISkeleton instance allocated on the specified MemoryStack.

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

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

public PointerBuffer
mBones()

the bone instance in the skeleton

public AISkeleton
mBones(PointerBuffer value)

Sets the address of the specified PointerBuffer to the mBones field.

public AIString
mName()

the name of the skeleton instance

public AISkeleton
mName(AIString value)

Copies the specified AIString to the mName field.

public AISkeleton
mName(Consumer<AIString> consumer)

Passes the mName field to the specified Consumer.

public int
mNumBones()

the number of bones in the skeleton

public static PointerBuffer
nmBones(long struct)

Unsafe version of mBones.

public static void
nmBones(long struct, PointerBuffer value)

Unsafe version of mBones.

public static AIString
nmName(long struct)

Unsafe version of mName.

public static void
nmName(long struct, AIString value)

Unsafe version of mName.

public static int
nmNumBones(long struct)

Unsafe version of mNumBones.

public static void
nmNumBones(long struct, int value)

Sets the specified value to the mNumBones field of the specified struct.

public AISkeleton
set(AIString mName, PointerBuffer mBones)

Initializes this struct with the specified values.

public AISkeleton

Returns:

this struct
set
(AISkeleton
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).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MBONESback to summary
public static final int MBONES

The struct member offsets.

MNAMEback to summary
public static final int MNAME

The struct member offsets.

MNUMBONESback to summary
public static final int MNUMBONES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AISkeletonback to summary
protected AISkeleton(long address, ByteBuffer container)
AISkeletonback to summary
public AISkeleton(ByteBuffer container)

Creates a AISkeleton 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

callocback to summary
public static AISkeleton calloc()

Returns a new AISkeleton instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static AISkeleton.Buffer calloc(int capacity)

Returns a new AISkeleton.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AISkeleton calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static AISkeleton.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected AISkeleton 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
createback to summary
public static AISkeleton create()

Returns a new AISkeleton instance allocated with BufferUtils.

createback to summary
public static AISkeleton create(long address)

Returns a new AISkeleton instance for the specified memory address.

createback to summary
public static AISkeleton.Buffer create(int capacity)

Returns a new AISkeleton.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static AISkeleton.Buffer create(long address, int capacity)

Create a AISkeleton.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AISkeleton createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static AISkeleton.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static AISkeleton malloc()

Returns a new AISkeleton instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static AISkeleton.Buffer malloc(int capacity)

Returns a new AISkeleton.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AISkeleton malloc(MemoryStack stack)

Returns a new AISkeleton instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static AISkeleton.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mBonesback to summary
public PointerBuffer mBones()

the bone instance in the skeleton

Annotations
@NativeType:struct aiSkeletonBone **
mBonesback to summary
public AISkeleton mBones(PointerBuffer value)

Sets the address of the specified PointerBuffer to the mBones field.

mNameback to summary
public AIString mName()

the name of the skeleton instance

Annotations
@NativeType:struct aiString
mNameback to summary
public AISkeleton mName(AIString value)

Copies the specified AIString to the mName field.

mNameback to summary
public AISkeleton mName(Consumer<AIString> consumer)

Passes the mName field to the specified Consumer.

mNumBonesback to summary
public int mNumBones()

the number of bones in the skeleton

Annotations
@NativeType:unsigned int
nmBonesback to summary
public static PointerBuffer nmBones(long struct)

Unsafe version of mBones.

nmBonesback to summary
public static void nmBones(long struct, PointerBuffer value)

Unsafe version of mBones.

nmNameback to summary
public static AIString nmName(long struct)

Unsafe version of mName.

nmNameback to summary
public static void nmName(long struct, AIString value)

Unsafe version of mName.

nmNumBonesback to summary
public static int nmNumBones(long struct)

Unsafe version of mNumBones.

nmNumBonesback to summary
public static void nmNumBones(long struct, int value)

Sets the specified value to the mNumBones field of the specified struct.

setback to summary
public AISkeleton set(AIString mName, PointerBuffer mBones)

Initializes this struct with the specified values.

setback to summary
public AISkeleton set(AISkeleton src)

Copies the specified struct data to this struct.

Parameters
src:AISkeleton

the source struct

Returns:AISkeleton

this struct

sizeofback to summary
public int sizeof()

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

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

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.assimp back to summary

public Class AISkeleton.Buffer

extends StructBuffer<AISkeleton, AISkeleton.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of AISkeleton structs.

Field Summary

Modifier and TypeField and Description
private static final AISkeleton

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AISkeleton.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 TypeMethod and Description
protected AISkeleton
public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the AISkeleton#mBones field.
mBones
()

public AISkeleton.Buffer
mBones(PointerBuffer value)

Sets the address of the specified PointerBuffer to the AISkeleton#mBones field.

public AIString

Returns:

a AIString view of the AISkeleton#mName field.
mName
()

public AISkeleton.Buffer
mName(AIString value)

Copies the specified AIString to the AISkeleton#mName field.

public AISkeleton.Buffer
mName(Consumer<AIString> consumer)

Passes the AISkeleton#mName field to the specified Consumer.

public int

Returns:

the value of the AISkeleton#mNumBones field.
mNumBones
()

protected AISkeleton.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final AISkeleton ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

Method Detail

getElementFactoryback to summary
protected AISkeleton getElementFactory()

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

Annotations
@Override
mBonesback to summary
public PointerBuffer mBones()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the AISkeleton#mBones field.

Annotations
@NativeType:struct aiSkeletonBone **
mBonesback to summary
public AISkeleton.Buffer mBones(PointerBuffer value)

Sets the address of the specified PointerBuffer to the AISkeleton#mBones field.

mNameback to summary
public AIString mName()
Returns:AIString

a AIString view of the AISkeleton#mName field.

Annotations
@NativeType:struct aiString
mNameback to summary
public AISkeleton.Buffer mName(AIString value)

Copies the specified AIString to the AISkeleton#mName field.

mNameback to summary
public AISkeleton.Buffer mName(Consumer<AIString> consumer)

Passes the AISkeleton#mName field to the specified Consumer.

mNumBonesback to summary
public int mNumBones()
Returns:int

the value of the AISkeleton#mNumBones field.

Annotations
@NativeType:unsigned int
selfback to summary
protected AISkeleton.Buffer self()

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

Annotations
@Override