com.jme3.anim

Class ArmatureMask

java.lang.Object

com.jme3.anim.ArmatureMask

All Implemented Interfaces:

AnimationMask

public class ArmatureMask
extends java.lang.Object
implements AnimationMask

An AnimationMask to select joints from a single Armature.

Constructor Summary

Constructors

Constructor and Description
ArmatureMask() Instantiate a mask that affects no joints.
ArmatureMask(Armature armature) Instantiate a mask that affects all joints in the specified Armature.

Method Summary

Modifier and Type	Method and Description
ArmatureMask	addAncestors(Joint start) Add the specified Joint and all its ancestors.
void	addBones(Armature armature, java.lang.String... jointNames) Add joints to be influenced by this animation mask.
void	addFromJoint(Armature armature, java.lang.String jointName) Add a joint and all its sub armature joints to be influenced by this animation mask.
boolean	contains(java.lang.Object target) Test whether the animation should applied to the specified element.
static ArmatureMask	createMask(Armature armature, java.lang.String... joints) Create an ArmatureMask that selects the named joints.
static ArmatureMask	createMask(Armature armature, java.lang.String fromJoint) Create an ArmatureMask that selects the named Joint and all its descendants.
ArmatureMask	remove(ArmatureMask removeMask) Remove all joints affected by the specified ArmatureMask.
ArmatureMask	removeAncestors(Joint start) Remove the specified Joint and all its ancestors.
ArmatureMask	removeJoints(Armature armature, java.lang.String... jointNames) Remove the named joints.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArmatureMask

public ArmatureMask()

Instantiate a mask that affects no joints.

ArmatureMask

public ArmatureMask(Armature armature)

Instantiate a mask that affects all joints in the specified Armature.

Parameters:

armature - the Armature containing the joints (not null, unaffected)

Method Detail

remove

public ArmatureMask remove(ArmatureMask removeMask)

Remove all joints affected by the specified ArmatureMask.

Parameters:

removeMask - the set of joints to remove (not null, unaffected)

Returns:

this

removeJoints

public ArmatureMask removeJoints(Armature armature,
                                 java.lang.String... jointNames)

Remove the named joints.

Parameters:

armature - the Armature containing the joints (not null, unaffected)

jointNames - the names of the joints to be removed

Returns:

this

contains

public boolean contains(java.lang.Object target)

Description copied from interface: AnimationMask

Test whether the animation should applied to the specified element.

Specified by:

contains in interface AnimationMask

Parameters:

target - the target element

Returns:

true if animation should be applied, otherwise false

createMask

public static ArmatureMask createMask(Armature armature,
                                      java.lang.String fromJoint)

Create an ArmatureMask that selects the named Joint and all its descendants.

Parameters:

armature - the Armature containing the joints (not null)

fromJoint - the name of the ancestor joint

Returns:

a new mask

createMask

public static ArmatureMask createMask(Armature armature,
                                      java.lang.String... joints)

Create an ArmatureMask that selects the named joints.

Parameters:

armature - the Armature containing the joints (not null)

joints - the names of the joints to be included

Returns:

a new mask

addBones

public void addBones(Armature armature,
                     java.lang.String... jointNames)

Add joints to be influenced by this animation mask.

Parameters:

armature - the Armature containing the joints

jointNames - the names of the joints to be influenced

addFromJoint

public void addFromJoint(Armature armature,
                         java.lang.String jointName)

Add a joint and all its sub armature joints to be influenced by this animation mask.

Parameters:

armature - the Armature containing the ancestor joint

jointName - the names of the ancestor joint

addAncestors

public ArmatureMask addAncestors(Joint start)

Add the specified Joint and all its ancestors.

Parameters:

start - the starting point (may be null, unaffected)

Returns:

this

removeAncestors

public ArmatureMask removeAncestors(Joint start)

Remove the specified Joint and all its ancestors.

Parameters:

start - the starting point (may be null, unaffected)

Returns:

this