AINode (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class AINode
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
A node in the imported hierarchy.
Each node has name, a parent node (except for the root node), a transformation relative to its parent and possibly several child nodes. Simple file formats don't support hierarchical structures - for these formats the imported scene does consist of only a single root node without children.

Member documentation
- mName – The name of the node.
  The name might be empty (length of zero) but all nodes which need to be referenced by either bones or animations are named. Multiple nodes may have the same name, except for nodes which are referenced by bones (see AIBone and AIMesh::mBones). Their names must be unique.
  
  Cameras and lights reference a specific node by name - if there are multiple nodes with this name, they are assigned to each of them.
  
  There are no limitations with regard to the characters contained in the name string as it is usually taken directly from the source file.
  
  Implementations should be able to handle tokens such as whitespace, tabs, line feeds, quotation marks, ampersands etc.
  
  Sometimes assimp introduces new nodes not present in the source file into the hierarchy (usually out of necessity because sometimes the source hierarchy format is simply not compatible). Their names are surrounded by <> e.g. <DummyRootNode>.
- mTransformation – The transformation relative to the node's parent.
- mParent – Parent node. NULL if this node is the root node.
- mNumChildren – The number of child nodes of this node.
- mChildren – The child nodes of this node. NULL if mNumChildren is 0.
- mNumMeshes – The number of meshes of this node.
- mMeshes – The meshes of this node. Each entry is an index into the mesh list of the AIScene.
- mMetadata – Metadata associated with this node or NULL if there is no metadata.
  Whether any metadata is generated depends on the source file format. See the importer notes page for more information on every source file format. Importers that don't document any metadata don't write any.
Layout
```
 struct aiNode {
     struct aiString mName;
     struct aiMatrix4x4 mTransformation;
     struct aiNode * mParent;
     unsigned int mNumChildren;
     struct aiNode ** mChildren;
     unsigned int mNumMeshes;
     unsigned int * mMeshes;
     struct aiMetadata * mMetadata;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AINode.Buffer
An array of AINode 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`	`AINode.Buffer` An array of `AINode` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MCHILDREN` The struct member offsets.
`static int`	`MMESHES` The struct member offsets.
`static int`	`MMETADATA` The struct member offsets.
`static int`	`MNAME` The struct member offsets.
`static int`	`MNUMCHILDREN` The struct member offsets.
`static int`	`MNUMMESHES` The struct member offsets.
`static int`	`MPARENT` The struct member offsets.
`static int`	`MTRANSFORMATION` 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

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

Constructors
Constructor and Description
`AINode(java.nio.ByteBuffer container)` Creates a `AINode` 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 AINode`	`calloc()` Returns a new `AINode` instance allocated with `memCalloc`.
`static AINode.Buffer`	`calloc(int capacity)` Returns a new `AINode.Buffer` instance allocated with `memCalloc`.
`static AINode`	`callocStack()` Returns a new `AINode` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AINode.Buffer`	`callocStack(int capacity)` Returns a new `AINode.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AINode.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AINode.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AINode`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AINode` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AINode`	`create()` Returns a new `AINode` instance allocated with `BufferUtils`.
`static AINode.Buffer`	`create(int capacity)` Returns a new `AINode.Buffer` instance allocated with `BufferUtils`.
`static AINode`	`create(long address)` Returns a new `AINode` instance for the specified memory address.
`static AINode.Buffer`	`create(long address, int capacity)` Create a `AINode.Buffer` instance at the specified memory.
`static AINode`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static AINode.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static AINode`	`malloc()` Returns a new `AINode` instance allocated with `memAlloc`.
`static AINode.Buffer`	`malloc(int capacity)` Returns a new `AINode.Buffer` instance allocated with `memAlloc`.
`static AINode`	`mallocStack()` Returns a new `AINode` instance allocated on the thread-local `MemoryStack`.
`static AINode.Buffer`	`mallocStack(int capacity)` Returns a new `AINode.Buffer` instance allocated on the thread-local `MemoryStack`.
`static AINode.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AINode.Buffer` instance allocated on the specified `MemoryStack`.
`static AINode`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AINode` instance allocated on the specified `MemoryStack`.
`org.lwjgl.PointerBuffer`	`mChildren()` Returns a `PointerBuffer` view of the data pointed to by the `mChildren` field.
`AINode`	`mChildren(org.lwjgl.PointerBuffer value)` Sets the address of the specified `PointerBuffer` to the `mChildren` field.
`java.nio.IntBuffer`	`mMeshes()` Returns a `IntBuffer` view of the data pointed to by the `mMeshes` field.
`AINode`	`mMeshes(java.nio.IntBuffer value)` Sets the address of the specified `IntBuffer` to the `mMeshes` field.
`AIMetaData`	`mMetadata()` Returns a `AIMetaData` view of the struct pointed to by the `mMetadata` field.
`AINode`	`mMetadata(AIMetaData value)` Sets the address of the specified `AIMetaData` to the `mMetadata` field.
`AIString`	`mName()` Returns a `AIString` view of the `mName` field.
`AINode`	`mName(AIString value)` Copies the specified `AIString` to the `mName` field.
`AINode`	`mName(java.util.function.Consumer<AIString> consumer)` Passes the `mName` field to the specified `Consumer`.
`int`	`mNumChildren()` Returns the value of the `mNumChildren` field.
`int`	`mNumMeshes()` Returns the value of the `mNumMeshes` field.
`AINode`	`mParent()` Returns a `AINode` view of the struct pointed to by the `mParent` field.
`AINode`	`mParent(AINode value)` Sets the address of the specified `AINode` to the `mParent` field.
`AIMatrix4x4`	`mTransformation()` Returns a `AIMatrix4x4` view of the `mTransformation` field.
`AINode`	`mTransformation(AIMatrix4x4 value)` Copies the specified `AIMatrix4x4` to the `mTransformation` field.
`AINode`	`mTransformation(java.util.function.Consumer<AIMatrix4x4> consumer)` Passes the `mTransformation` field to the specified `Consumer`.
`static org.lwjgl.PointerBuffer`	`nmChildren(long struct)` Unsafe version of `mChildren`.
`static void`	`nmChildren(long struct, org.lwjgl.PointerBuffer value)` Unsafe version of `mChildren`.
`static java.nio.IntBuffer`	`nmMeshes(long struct)` Unsafe version of `mMeshes`.
`static void`	`nmMeshes(long struct, java.nio.IntBuffer value)` Unsafe version of `mMeshes`.
`static AIMetaData`	`nmMetadata(long struct)` Unsafe version of `mMetadata()`.
`static void`	`nmMetadata(long struct, AIMetaData value)` Unsafe version of `mMetadata`.
`static AIString`	`nmName(long struct)` Unsafe version of `mName()`.
`static void`	`nmName(long struct, AIString value)` Unsafe version of `mName`.
`static int`	`nmNumChildren(long struct)` Unsafe version of `mNumChildren()`.
`static void`	`nmNumChildren(long struct, int value)` Sets the specified value to the `mNumChildren` field of the specified `struct`.
`static int`	`nmNumMeshes(long struct)` Unsafe version of `mNumMeshes()`.
`static void`	`nmNumMeshes(long struct, int value)` Sets the specified value to the `mNumMeshes` field of the specified `struct`.
`static AINode`	`nmParent(long struct)` Unsafe version of `mParent()`.
`static void`	`nmParent(long struct, AINode value)` Unsafe version of `mParent`.
`static AIMatrix4x4`	`nmTransformation(long struct)` Unsafe version of `mTransformation()`.
`static void`	`nmTransformation(long struct, AIMatrix4x4 value)` Unsafe version of `mTransformation`.
`AINode`	`set(AINode src)` Copies the specified struct data to this struct.
`AINode`	`set(AIString mName, AIMatrix4x4 mTransformation, AINode mParent, org.lwjgl.PointerBuffer mChildren, java.nio.IntBuffer mMeshes, AIMetaData mMetadata)` 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.
  - MTRANSFORMATION
```
public static final int MTRANSFORMATION
```
    The struct member offsets.
  - MPARENT
```
public static final int MPARENT
```
    The struct member offsets.
  - MNUMCHILDREN
```
public static final int MNUMCHILDREN
```
    The struct member offsets.
  - MCHILDREN
```
public static final int MCHILDREN
```
    The struct member offsets.
  - MNUMMESHES
```
public static final int MNUMMESHES
```
    The struct member offsets.
  - MMESHES
```
public static final int MMESHES
```
    The struct member offsets.
  - MMETADATA
```
public static final int MMETADATA
```
    The struct member offsets.
- Constructor Detail
  - AINode
```
public AINode(java.nio.ByteBuffer container)
```
    Creates a AINode 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.
  - mTransformation
```
public AIMatrix4x4 mTransformation()
```
    Returns a AIMatrix4x4 view of the mTransformation field.
  - mParent
```
@Nullable
public AINode mParent()
```
    Returns a AINode view of the struct pointed to by the mParent field.
  - mNumChildren
```
public int mNumChildren()
```
    Returns the value of the mNumChildren field.
  - mChildren
```
@Nullable
public org.lwjgl.PointerBuffer mChildren()
```
    Returns a PointerBuffer view of the data pointed to by the mChildren field.
  - mNumMeshes
```
public int mNumMeshes()
```
    Returns the value of the mNumMeshes field.
  - mMeshes
```
@Nullable
public java.nio.IntBuffer mMeshes()
```
    Returns a IntBuffer view of the data pointed to by the mMeshes field.
  - mMetadata
```
@Nullable
public AIMetaData mMetadata()
```
    Returns a AIMetaData view of the struct pointed to by the mMetadata field.
  - mName
```
public AINode mName(AIString value)
```
    Copies the specified AIString to the mName field.
  - mName
```
public AINode mName(java.util.function.Consumer<AIString> consumer)
```
    Passes the mName field to the specified Consumer.
  - mTransformation
```
public AINode mTransformation(AIMatrix4x4 value)
```
    Copies the specified AIMatrix4x4 to the mTransformation field.
  - mTransformation
```
public AINode mTransformation(java.util.function.Consumer<AIMatrix4x4> consumer)
```
    Passes the mTransformation field to the specified Consumer.
  - mParent
```
public AINode mParent(@Nullable
                      AINode value)
```
    Sets the address of the specified AINode to the mParent field.
  - mChildren
```
public AINode mChildren(@Nullable
                        org.lwjgl.PointerBuffer value)
```
    Sets the address of the specified PointerBuffer to the mChildren field.
  - mMeshes
```
public AINode mMeshes(@Nullable
                      java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the mMeshes field.
  - mMetadata
```
public AINode mMetadata(@Nullable
                        AIMetaData value)
```
    Sets the address of the specified AIMetaData to the mMetadata field.
  - set
```
public AINode set(AIString mName,
                  AIMatrix4x4 mTransformation,
                  @Nullable
                  AINode mParent,
                  @Nullable
                  org.lwjgl.PointerBuffer mChildren,
                  @Nullable
                  java.nio.IntBuffer mMeshes,
                  @Nullable
                  AIMetaData mMetadata)
```
    Initializes this struct with the specified values.
  - set
```
public AINode set(AINode src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static AINode malloc()
```
    Returns a new AINode instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static AINode calloc()
```
    Returns a new AINode instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static AINode create()
```
    Returns a new AINode instance allocated with BufferUtils.
  - create
```
public static AINode create(long address)
```
    Returns a new AINode instance for the specified memory address.
  - createSafe
```
@Nullable
public static AINode createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static AINode.Buffer malloc(int capacity)
```
    Returns a new AINode.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static AINode.Buffer calloc(int capacity)
```
    Returns a new AINode.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AINode.Buffer create(int capacity)
```
    Returns a new AINode.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AINode.Buffer create(long address,
                                   int capacity)
```
    Create a AINode.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static AINode.Buffer createSafe(long address,
                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static AINode mallocStack()
```
    Returns a new AINode instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static AINode callocStack()
```
    Returns a new AINode instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static AINode mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AINode instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static AINode callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AINode instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static AINode.Buffer mallocStack(int capacity)
```
    Returns a new AINode.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static AINode.Buffer callocStack(int capacity)
```
    Returns a new AINode.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static AINode.Buffer mallocStack(int capacity,
                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new AINode.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static AINode.Buffer callocStack(int capacity,
                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new AINode.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().
  - nmTransformation
```
public static AIMatrix4x4 nmTransformation(long struct)
```
    Unsafe version of mTransformation().
  - nmParent
```
@Nullable
public static AINode nmParent(long struct)
```
    Unsafe version of mParent().
  - nmNumChildren
```
public static int nmNumChildren(long struct)
```
    Unsafe version of mNumChildren().
  - nmChildren
```
@Nullable
public static org.lwjgl.PointerBuffer nmChildren(long struct)
```
    Unsafe version of mChildren.
  - nmNumMeshes
```
public static int nmNumMeshes(long struct)
```
    Unsafe version of mNumMeshes().
  - nmMeshes
```
@Nullable
public static java.nio.IntBuffer nmMeshes(long struct)
```
    Unsafe version of mMeshes.
  - nmMetadata
```
@Nullable
public static AIMetaData nmMetadata(long struct)
```
    Unsafe version of mMetadata().
  - nmName
```
public static void nmName(long struct,
                          AIString value)
```
    Unsafe version of mName.
  - nmTransformation
```
public static void nmTransformation(long struct,
                                    AIMatrix4x4 value)
```
    Unsafe version of mTransformation.
  - nmParent
```
public static void nmParent(long struct,
                            @Nullable
                            AINode value)
```
    Unsafe version of mParent.
  - nmNumChildren
```
public static void nmNumChildren(long struct,
                                 int value)
```
    Sets the specified value to the mNumChildren field of the specified struct.
  - nmChildren
```
public static void nmChildren(long struct,
                              @Nullable
                              org.lwjgl.PointerBuffer value)
```
    Unsafe version of mChildren.
  - nmNumMeshes
```
public static void nmNumMeshes(long struct,
                               int value)
```
    Sets the specified value to the mNumMeshes field of the specified struct.
  - nmMeshes
```
public static void nmMeshes(long struct,
                            @Nullable
                            java.nio.IntBuffer value)
```
    Unsafe version of mMeshes.
  - nmMetadata
```
public static void nmMetadata(long struct,
                              @Nullable
                              AIMetaData value)
```
    Unsafe version of mMetadata.
  - 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 AINode

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

MTRANSFORMATION

MPARENT

MNUMCHILDREN

MCHILDREN

MNUMMESHES

MMESHES

MMETADATA

Constructor Detail

AINode

Method Detail

sizeof

mName

mTransformation

mParent

mNumChildren

mChildren

mNumMeshes

mMeshes

mMetadata

mName

mName

mTransformation

mTransformation

mParent

mChildren

mMeshes

mMetadata

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmName

nmTransformation

nmParent

nmNumChildren

nmChildren

nmNumMeshes

nmMeshes

nmMetadata

nmName

nmTransformation

nmParent

nmNumChildren

nmChildren

nmNumMeshes

nmMeshes

nmMetadata