Package com.jme3.anim

Class SingleLayerInfluenceMask

java.lang.Object

com.jme3.anim.ArmatureMask

com.jme3.anim.SingleLayerInfluenceMask

All Implemented Interfaces:

AnimationMask, Savable

public class SingleLayerInfluenceMask
extends ArmatureMask

Mask that excludes joints from participating in the layer if a higher layer is using those joints in an animation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleLayerInfluenceMask()	For serialization only.
	SingleLayerInfluenceMask(String targetLayer, AnimComposer animComposer)	Instantiate a mask that affects no joints.
	SingleLayerInfluenceMask(String targetLayer, AnimComposer animComposer, Armature armature)	Instantiate a mask that affects all joints in the specified Armature.

Method Summary

Modifier and Type	Method	Description
boolean	contains(Object target)	Checks if the specified target is contained within this mask.
String	getTargetLayer()	Get the layer this mask is targeted for.
void	read(JmeImporter im)
void	setAnimComposer(AnimComposer animComposer)	Sets the animation composer for this mask.
void	write(JmeExporter ex)

Methods inherited from class com.jme3.anim.ArmatureMask

addAncestors, addBones, addFromJoint, createMask, createMask, remove, removeAncestors, removeJoints

Methods inherited from class java.lang.Object

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

Constructor Details

SingleLayerInfluenceMask

protected SingleLayerInfluenceMask()

For serialization only. Do not use

SingleLayerInfluenceMask

public SingleLayerInfluenceMask(String targetLayer,
 AnimComposer animComposer,
 Armature armature)

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

Parameters:

targetLayer - The layer this mask is targeted for.

animComposer - The animation composer associated with this mask.

armature - The Armature containing the joints.

SingleLayerInfluenceMask

public SingleLayerInfluenceMask(String targetLayer,
 AnimComposer animComposer)

Instantiate a mask that affects no joints.

Parameters:

targetLayer - The layer this mask is targeted for.

animComposer - The animation composer associated with this mask.

Method Details

getTargetLayer

public String getTargetLayer()

Get the layer this mask is targeted for.

Returns:

The target layer

setAnimComposer

public void setAnimComposer(AnimComposer animComposer)

Sets the animation composer for this mask.

Parameters:

animComposer - The new animation composer.

contains

public boolean contains(Object target)

Checks if the specified target is contained within this mask.

Specified by:

contains in interface AnimationMask

Overrides:

contains in class ArmatureMask

Parameters:

target - The target to check.

Returns:

True if the target is contained within this mask, false otherwise.

write

public void write(JmeExporter ex)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class ArmatureMask

Throws:

IOException

read

public void read(JmeImporter im)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class ArmatureMask

Throws:

IOException