AIBone (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.assimp.AIBone

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class AIBone
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
A single bone of a mesh.
A bone has a name by which it can be found in the frame hierarchy and by which it can be addressed by animations. In addition it has a number of influences on vertices, and a matrix relating the mesh position to the position of the bone at the time of binding.

Member documentation
- mName – the name of the bone.
- mNumWeights – the number of vertices affected by this bone. The maximum value for this member is Assimp.AI_MAX_BONE_WEIGHTS.
- mArmature – the bone armature node - used for skeleton conversion you must enable Process_PopulateArmatureData to populate this
- mNode – the bone node in the scene - used for skeleton conversion you must enable Process_PopulateArmatureData to populate this
- mWeights – the influence weights of this bone, by vertex index
- mOffsetMatrix – matrix that transforms from bone space to mesh space in bind pose.
  This matrix describes the position of the mesh in the local space of this bone when the skeleton was bound. Thus it can be used directly to determine a desired vertex position, given the world-space transform of the bone when animated, and the position of the vertex in mesh space.
  
  It is sometimes called an inverse-bind matrix, or inverse bind pose matrix.
Layout
```
 struct aiBone {
     struct aiString mName;
     unsigned int mNumWeights;
     struct aiNode * mArmature;
     struct aiNode * mNode;
     struct aiVertexWeight * mWeights;
     struct aiMatrix4x4 mOffsetMatrix;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AIBone.Buffer
An array of AIBone structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`AIBone.Buffer` An array of `AIBone` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MARMATURE` The struct member offsets.
`static int`	`MNAME` The struct member offsets.
`static int`	`MNODE` The struct member offsets.
`static int`	`MNUMWEIGHTS` The struct member offsets.
`static int`	`MOFFSETMATRIX` The struct member offsets.
`static int`	`MWEIGHTS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

AIBone(java.nio.ByteBuffer container)
Creates a AIBone instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`AIBone(java.nio.ByteBuffer container)` Creates a `AIBone` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AIBone`	`calloc()` Returns a new `AIBone` instance allocated with `memCalloc`.
`static AIBone.Buffer`	`calloc(int capacity)` Returns a new `AIBone.Buffer` instance allocated with `memCalloc`.
`static AIBone`	`callocStack()` Returns a new `AIBone` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIBone.Buffer`	`callocStack(int capacity)` Returns a new `AIBone.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIBone.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIBone.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIBone`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIBone` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIBone`	`create()` Returns a new `AIBone` instance allocated with `BufferUtils`.
`static AIBone.Buffer`	`create(int capacity)` Returns a new `AIBone.Buffer` instance allocated with `BufferUtils`.
`static AIBone`	`create(long address)` Returns a new `AIBone` instance for the specified memory address.
`static AIBone.Buffer`	`create(long address, int capacity)` Create a `AIBone.Buffer` instance at the specified memory.
`static AIBone`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIBone.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIBone`	`malloc()` Returns a new `AIBone` instance allocated with `memAlloc`.
`static AIBone.Buffer`	`malloc(int capacity)` Returns a new `AIBone.Buffer` instance allocated with `memAlloc`.
`static AIBone`	`mallocStack()` Returns a new `AIBone` instance allocated on the thread-local `MemoryStack`.
`static AIBone.Buffer`	`mallocStack(int capacity)` Returns a new `AIBone.Buffer` instance allocated on the thread-local `MemoryStack`.
`static AIBone.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIBone.Buffer` instance allocated on the specified `MemoryStack`.
`static AIBone`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIBone` instance allocated on the specified `MemoryStack`.
`AINode`	`mArmature()` Returns a `AINode` view of the struct pointed to by the `mArmature` field.
`AIBone`	`mArmature(AINode value)` Sets the address of the specified `AINode` to the `mArmature` field.
`AIString`	`mName()` Returns a `AIString` view of the `mName` field.
`AIBone`	`mName(AIString value)` Copies the specified `AIString` to the `mName` field.
`AIBone`	`mName(java.util.function.Consumer<AIString> consumer)` Passes the `mName` field to the specified `Consumer`.
`AINode`	`mNode()` Returns a `AINode` view of the struct pointed to by the `mNode` field.
`AIBone`	`mNode(AINode value)` Sets the address of the specified `AINode` to the `mNode` field.
`int`	`mNumWeights()` Returns the value of the `mNumWeights` field.
`AIMatrix4x4`	`mOffsetMatrix()` Returns a `AIMatrix4x4` view of the `mOffsetMatrix` field.
`AIBone`	`mOffsetMatrix(AIMatrix4x4 value)` Copies the specified `AIMatrix4x4` to the `mOffsetMatrix` field.
`AIBone`	`mOffsetMatrix(java.util.function.Consumer<AIMatrix4x4> consumer)` Passes the `mOffsetMatrix` field to the specified `Consumer`.
`AIVertexWeight.Buffer`	`mWeights()` Returns a `AIVertexWeight.Buffer` view of the struct array pointed to by the `mWeights` field.
`AIBone`	`mWeights(AIVertexWeight.Buffer value)` Sets the address of the specified `AIVertexWeight.Buffer` to the `mWeights` field.
`static AINode`	`nmArmature(long struct)` Unsafe version of `mArmature()`.
`static void`	`nmArmature(long struct, AINode value)` Unsafe version of `mArmature`.
`static AIString`	`nmName(long struct)` Unsafe version of `mName()`.
`static void`	`nmName(long struct, AIString value)` Unsafe version of `mName`.
`static AINode`	`nmNode(long struct)` Unsafe version of `mNode()`.
`static void`	`nmNode(long struct, AINode value)` Unsafe version of `mNode`.
`static int`	`nmNumWeights(long struct)` Unsafe version of `mNumWeights()`.
`static void`	`nmNumWeights(long struct, int value)` Sets the specified value to the `mNumWeights` field of the specified `struct`.
`static AIMatrix4x4`	`nmOffsetMatrix(long struct)` Unsafe version of `mOffsetMatrix()`.
`static void`	`nmOffsetMatrix(long struct, AIMatrix4x4 value)` Unsafe version of `mOffsetMatrix`.
`static AIVertexWeight.Buffer`	`nmWeights(long struct)` Unsafe version of `mWeights()`.
`static void`	`nmWeights(long struct, AIVertexWeight.Buffer value)` Unsafe version of `mWeights`.
`AIBone`	`set(AIBone src)` Copies the specified struct data to this struct.
`AIBone`	`set(AIString mName, AINode mArmature, AINode mNode, AIVertexWeight.Buffer mWeights, AIMatrix4x4 mOffsetMatrix)` Initializes this struct with the specified values.
`int`	`sizeof()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - MNAME
```
public static final int MNAME
```
    The struct member offsets.
  - MNUMWEIGHTS
```
public static final int MNUMWEIGHTS
```
    The struct member offsets.
  - MARMATURE
```
public static final int MARMATURE
```
    The struct member offsets.
  - MNODE
```
public static final int MNODE
```
    The struct member offsets.
  - MWEIGHTS
```
public static final int MWEIGHTS
```
    The struct member offsets.
  - MOFFSETMATRIX
```
public static final int MOFFSETMATRIX
```
    The struct member offsets.
- Constructor Detail
  - AIBone
```
public AIBone(java.nio.ByteBuffer container)
```
    Creates a AIBone 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - mName
```
public AIString mName()
```
    Returns a AIString view of the mName field.
  - mNumWeights
```
public int mNumWeights()
```
    Returns the value of the mNumWeights field.
  - mArmature
```
public AINode mArmature()
```
    Returns a AINode view of the struct pointed to by the mArmature field.
  - mNode
```
public AINode mNode()
```
    Returns a AINode view of the struct pointed to by the mNode field.
  - mWeights
```
public AIVertexWeight.Buffer mWeights()
```
    Returns a AIVertexWeight.Buffer view of the struct array pointed to by the mWeights field.
  - mOffsetMatrix
```
public AIMatrix4x4 mOffsetMatrix()
```
    Returns a AIMatrix4x4 view of the mOffsetMatrix field.
  - mName
```
public AIBone mName(AIString value)
```
    Copies the specified AIString to the mName field.
  - mName
```
public AIBone mName(java.util.function.Consumer<AIString> consumer)
```
    Passes the mName field to the specified Consumer.
  - mArmature
```
public AIBone mArmature(AINode value)
```
    Sets the address of the specified AINode to the mArmature field.
  - mNode
```
public AIBone mNode(AINode value)
```
    Sets the address of the specified AINode to the mNode field.
  - mWeights
```
public AIBone mWeights(AIVertexWeight.Buffer value)
```
    Sets the address of the specified AIVertexWeight.Buffer to the mWeights field.
  - mOffsetMatrix
```
public AIBone mOffsetMatrix(AIMatrix4x4 value)
```
    Copies the specified AIMatrix4x4 to the mOffsetMatrix field.
  - mOffsetMatrix
```
public AIBone mOffsetMatrix(java.util.function.Consumer<AIMatrix4x4> consumer)
```
    Passes the mOffsetMatrix field to the specified Consumer.
  - set
```
public AIBone set(AIString mName,
                  AINode mArmature,
                  AINode mNode,
                  AIVertexWeight.Buffer mWeights,
                  AIMatrix4x4 mOffsetMatrix)
```
    Initializes this struct with the specified values.
  - set
```
public AIBone set(AIBone src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static AIBone malloc()
```
    Returns a new AIBone instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static AIBone calloc()
```
    Returns a new AIBone instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static AIBone create()
```
    Returns a new AIBone instance allocated with BufferUtils.
  - create
```
public static AIBone create(long address)
```
    Returns a new AIBone instance for the specified memory address.
  - createSafe
```
@Nullable
public static AIBone createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static AIBone.Buffer malloc(int capacity)
```
    Returns a new AIBone.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static AIBone.Buffer calloc(int capacity)
```
    Returns a new AIBone.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIBone.Buffer create(int capacity)
```
    Returns a new AIBone.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIBone.Buffer create(long address,
                                   int capacity)
```
    Create a AIBone.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static AIBone.Buffer createSafe(long address,
                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static AIBone mallocStack()
```
    Returns a new AIBone instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static AIBone callocStack()
```
    Returns a new AIBone instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static AIBone mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIBone instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static AIBone callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIBone instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static AIBone.Buffer mallocStack(int capacity)
```
    Returns a new AIBone.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static AIBone.Buffer callocStack(int capacity)
```
    Returns a new AIBone.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static AIBone.Buffer mallocStack(int capacity,
                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIBone.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static AIBone.Buffer callocStack(int capacity,
                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIBone.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nmName
```
public static AIString nmName(long struct)
```
    Unsafe version of mName().
  - nmNumWeights
```
public static int nmNumWeights(long struct)
```
    Unsafe version of mNumWeights().
  - nmArmature
```
public static AINode nmArmature(long struct)
```
    Unsafe version of mArmature().
  - nmNode
```
public static AINode nmNode(long struct)
```
    Unsafe version of mNode().
  - nmWeights
```
public static AIVertexWeight.Buffer nmWeights(long struct)
```
    Unsafe version of mWeights().
  - nmOffsetMatrix
```
public static AIMatrix4x4 nmOffsetMatrix(long struct)
```
    Unsafe version of mOffsetMatrix().
  - nmName
```
public static void nmName(long struct,
                          AIString value)
```
    Unsafe version of mName.
  - nmNumWeights
```
public static void nmNumWeights(long struct,
                                int value)
```
    Sets the specified value to the mNumWeights field of the specified struct.
  - nmArmature
```
public static void nmArmature(long struct,
                              AINode value)
```
    Unsafe version of mArmature.
  - nmNode
```
public static void nmNode(long struct,
                          AINode value)
```
    Unsafe version of mNode.
  - nmWeights
```
public static void nmWeights(long struct,
                             AIVertexWeight.Buffer value)
```
    Unsafe version of mWeights.
  - nmOffsetMatrix
```
public static void nmOffsetMatrix(long struct,
                                  AIMatrix4x4 value)
```
    Unsafe version of mOffsetMatrix.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class AIBone

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

MNAME

MNUMWEIGHTS

MARMATURE

MNODE

MWEIGHTS

MOFFSETMATRIX

Constructor Detail

AIBone

Method Detail

sizeof

mName

mNumWeights

mArmature

mNode

mWeights

mOffsetMatrix

mName

mName

mArmature

mNode

mWeights

mOffsetMatrix

mOffsetMatrix

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmName

nmNumWeights

nmArmature

nmNode

nmWeights

nmOffsetMatrix

nmName

nmNumWeights

nmArmature

nmNode

nmWeights

nmOffsetMatrix

validate

validate