BoneContext (jMonkeyEngine3)

java.lang.Object
- com.jme3.scene.plugins.blender.animations.BoneContext

```
public class BoneContext
extends java.lang.Object
```
This class holds the basic data that describes a bone.

Field Summary

Fields
Modifier and Type	Field and Description
`static Matrix4f`	`BONE_ARMATURE_TRANSFORMATION_MATRIX` The bones' matrices have, unlike objects', the coordinate system identical to JME's (Y axis is UP, X to the right and Z toward us).
`static int`	`CONNECTED_TO_PARENT`
`static int`	`DEFORM`
`static int`	`NO_INHERIT_ROTATION`
`static int`	`NO_INHERIT_SCALE`
`static int`	`NO_LOCAL_LOCATION`
`static int`	`SELECTED`

Constructor Summary

Constructors
Constructor and Description

BoneContext(java.lang.Long armatureObjectOMA, Structure boneStructure, BlenderContext blenderContext)
Constructor.

Constructors
Constructor and Description
`BoneContext(java.lang.Long armatureObjectOMA, Structure boneStructure, BlenderContext blenderContext)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bone`	`buildBone(java.util.List<Bone> bones, java.lang.Long skeletonOwnerOma, BlenderContext blenderContext)` This method builds the bone.
`java.lang.Long`	`getArmatureObjectOMA()`
`Bone`	`getBone()`
`BoneEnvelope`	`getBoneEnvelope()`
`Matrix4f`	`getBoneMatrixInModelSpace()`
`java.lang.Long`	`getBoneOma()`
`int`	`getDistanceFromRoot()`
`float`	`getIkStretch()`
`float`	`getLength()` The method returns the length of the bone.
`Vector3f`	`getLimitMax()`
`Vector3f`	`getLimitMin()`
`BoneContext`	`getRoot()`
`Skeleton`	`getSkeleton()`
`java.lang.Long`	`getSkeletonOwnerOma()`
`Vector3f`	`getStiffness()`
`boolean`	`is(int flagMask)` Tells if the bone is of specified property defined by its flag.
`boolean`	`isLimitX()`
`boolean`	`isLimitY()`
`boolean`	`isLimitZ()`
`boolean`	`isLockX()`
`boolean`	`isLockY()`
`boolean`	`isLockZ()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SELECTED
```
public static final int SELECTED
```
    See Also:
    
    Constant Field Values
  - CONNECTED_TO_PARENT
```
public static final int CONNECTED_TO_PARENT
```
    See Also:
    
    Constant Field Values
  - DEFORM
```
public static final int DEFORM
```
    See Also:
    
    Constant Field Values
  - NO_LOCAL_LOCATION
```
public static final int NO_LOCAL_LOCATION
```
    See Also:
    
    Constant Field Values
  - NO_INHERIT_SCALE
```
public static final int NO_INHERIT_SCALE
```
    See Also:
    
    Constant Field Values
  - NO_INHERIT_ROTATION
```
public static final int NO_INHERIT_ROTATION
```
    See Also:
    
    Constant Field Values
  - BONE_ARMATURE_TRANSFORMATION_MATRIX
```
public static final Matrix4f BONE_ARMATURE_TRANSFORMATION_MATRIX
```
    The bones' matrices have, unlike objects', the coordinate system identical to JME's (Y axis is UP, X to the right and Z toward us). So in order to have them loaded properly we need to transform their armature matrix (which blender sees as rotated) to make sure we get identical results.
- Constructor Detail
  - BoneContext
```
public BoneContext(java.lang.Long armatureObjectOMA,
                   Structure boneStructure,
                   BlenderContext blenderContext)
            throws BlenderFileException
```
    Constructor. Creates the basic set of bone's data.
    
    Parameters:
    
    armatureObjectOMA - the OMA of the bone's armature object
    
    boneStructure - the bone's structure
    
    blenderContext - the blender context
    
    Throws:
    
    BlenderFileException - an exception is thrown when problem with blender data reading occurs
- Method Detail
  - buildBone
```
public Bone buildBone(java.util.List<Bone> bones,
                      java.lang.Long skeletonOwnerOma,
                      BlenderContext blenderContext)
```
    This method builds the bone. It recursively builds the bone's children.
    
    Parameters:
    
    bones - a list of bones where the newly created bone will be added
    
    skeletonOwnerOma - the spatial of the object that will own the skeleton
    
    blenderContext - the blender context
    
    Returns:
    
    newly created bone
  - getBone
```
public Bone getBone()
```
    Returns:
    
    built bone (available after calling 'buildBone' method)
  - getBoneOma
```
public java.lang.Long getBoneOma()
```
    Returns:
    
    the old memory address of the bone
  - getLength
```
public float getLength()
```
    The method returns the length of the bone. If you want to use it for bone debugger take model space scale into account and do something like this: boneContext.getLength() * boneContext.getBone().getModelSpaceScale().y. Otherwise the bones might not look as they should in the bone debugger.
    
    Returns:
    
    the length of the bone
  - getArmatureObjectOMA
```
public java.lang.Long getArmatureObjectOMA()
```
    Returns:
    
    OMA of the bone's armature object
  - getSkeletonOwnerOma
```
public java.lang.Long getSkeletonOwnerOma()
```
    Returns:
    
    the OMA of the model that owns the bone's skeleton
  - getSkeleton
```
public Skeleton getSkeleton()
```
    Returns:
    
    the skeleton the bone of this context belongs to
  - getBoneMatrixInModelSpace
```
public Matrix4f getBoneMatrixInModelSpace()
```
    Returns:
    
    the initial bone's matrix in model space
  - getBoneEnvelope
```
public BoneEnvelope getBoneEnvelope()
```
    Returns:
    
    the vertex assigning envelope of the bone
  - getIkStretch
```
public float getIkStretch()
```
    Returns:
    
    bone's stretch factor
  - isLimitX
```
public boolean isLimitX()
```
    Returns:
    
    indicates if the X rotation should be limited
  - isLimitY
```
public boolean isLimitY()
```
    Returns:
    
    indicates if the Y rotation should be limited
  - isLimitZ
```
public boolean isLimitZ()
```
    Returns:
    
    indicates if the Z rotation should be limited
  - isLockX
```
public boolean isLockX()
```
    Returns:
    
    indicates if the X rotation should be disabled
  - isLockY
```
public boolean isLockY()
```
    Returns:
    
    indicates if the Y rotation should be disabled
  - isLockZ
```
public boolean isLockZ()
```
    Returns:
    
    indicates if the Z rotation should be disabled
  - getLimitMin
```
public Vector3f getLimitMin()
```
    Returns:
    
    the minimum values in rotation limitation (if limitation is enabled for specific axis).
  - getLimitMax
```
public Vector3f getLimitMax()
```
    Returns:
    
    the maximum values in rotation limitation (if limitation is enabled for specific axis).
  - getStiffness
```
public Vector3f getStiffness()
```
    Returns:
    
    the stiffness of the bone
  - is
```
public boolean is(int flagMask)
```
    Tells if the bone is of specified property defined by its flag.
    
    Parameters:
    
    flagMask - the mask of the flag (constants defined in this class)
    
    Returns:
    
    true if the bone IS of specified proeprty and false otherwise
  - getRoot
```
public BoneContext getRoot()
```
    Returns:
    
    the root bone context of this bone context
  - getDistanceFromRoot
```
public int getDistanceFromRoot()
```
    Returns:
    
    a number of bones from this bone to its root
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BoneContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SELECTED

CONNECTED_TO_PARENT

DEFORM

NO_LOCAL_LOCATION

NO_INHERIT_SCALE

NO_INHERIT_ROTATION

BONE_ARMATURE_TRANSFORMATION_MATRIX

Constructor Detail

BoneContext

Method Detail

buildBone

getBone

getBoneOma

getLength

getArmatureObjectOMA

getSkeletonOwnerOma

getSkeleton

getBoneMatrixInModelSpace

getBoneEnvelope

getIkStretch

isLimitX

isLimitY

isLimitZ

isLockX

isLockY

isLockZ

getLimitMin

getLimitMax

getStiffness

is

getRoot

getDistanceFromRoot

toString