com.jme3.scene.plugins.blender.constraints.definitions

Class ConstraintDefinition

java.lang.Object

com.jme3.scene.plugins.blender.constraints.definitions.ConstraintDefinition

Direct Known Subclasses:

ConstraintDefinitionIK, ConstraintDefinitionMaintainVolume, ConstraintDefinitionTransLike

public abstract class ConstraintDefinition
extends java.lang.Object

A base class for all constraint definitions.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.Long>	alteredOmas Stores the OMA addresses of all features whose transform had been altered beside the constraint owner.
protected BlenderContext	blenderContext The blender context.
protected ConstraintHelper	constraintHelper
protected java.lang.String	constraintName The name of the constraint.
protected int	flag Constraints flag.
protected java.lang.Long	ownerOMA The constraint's owner OMA.
protected boolean	trackToBeChanged The variable that determines if the constraint will alter the track in any way.

Constructor Summary

Constructors

Constructor and Description
ConstraintDefinition(Structure constraintData, java.lang.Long ownerOMA, BlenderContext blenderContext) Loads a constraint definition based on the constraint definition structure.

Method Summary

Modifier and Type	Method and Description
protected void	applyOwnerTransform(Transform ownerTransform, ConstraintHelper.Space ownerSpace) The method applies the given transformation to the owner.
abstract void	bake(ConstraintHelper.Space ownerSpace, ConstraintHelper.Space targetSpace, Transform targetTransform, float influence) Bakes the constraint for the current feature (bone or spatial) position.
java.util.Set<java.lang.Long>	getAlteredOmas()
abstract java.lang.String	getConstraintTypeName()
protected java.lang.Object	getOwner() This method is here because we have no guarantee that the owner is loaded when constraint is being created.
protected Transform	getOwnerTransform(ConstraintHelper.Space ownerSpace) The method gets the owner's transformation.
boolean	isImplemented()
abstract boolean	isTargetRequired()
boolean	isTrackToBeChanged()
void	setConstraintName(java.lang.String constraintName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

constraintHelper

protected ConstraintHelper constraintHelper

flag

protected int flag

Constraints flag. Used to load user's options applied to the constraint.

blenderContext

protected BlenderContext blenderContext

The blender context.

ownerOMA

protected java.lang.Long ownerOMA

The constraint's owner OMA.

alteredOmas

protected java.util.Set<java.lang.Long> alteredOmas

Stores the OMA addresses of all features whose transform had been altered beside the constraint owner.

trackToBeChanged

protected boolean trackToBeChanged

The variable that determines if the constraint will alter the track in any way.

constraintName

protected java.lang.String constraintName

The name of the constraint.

Constructor Detail

ConstraintDefinition

public ConstraintDefinition(Structure constraintData,
                            java.lang.Long ownerOMA,
                            BlenderContext blenderContext)

Loads a constraint definition based on the constraint definition structure.

Parameters:

constraintData - the constraint definition structure

ownerOMA - the constraint's owner OMA

blenderContext - the blender context

Method Detail

setConstraintName

public void setConstraintName(java.lang.String constraintName)

isTrackToBeChanged

public boolean isTrackToBeChanged()

Returns:

determines if the definition of the constraint will change the bone in any way; in most cases it is possible to tell that even before the constraint baking simulation is started, so we can discard such bones from constraint computing to improve the computation speed and lower the computations complexity

isTargetRequired

public abstract boolean isTargetRequired()

Returns:

determines if this constraint definition requires a defined target or not

getOwner

protected java.lang.Object getOwner()

This method is here because we have no guarantee that the owner is loaded when constraint is being created. So use it to get the owner when it is needed for computations.

Returns:

the owner of the constraint or null if none is set

getOwnerTransform

protected Transform getOwnerTransform(ConstraintHelper.Space ownerSpace)

The method gets the owner's transformation. The owner can be either bone or spatial.

Parameters:

ownerSpace - the space in which the computed transformation is given

Returns:

the constraint owner's transformation

applyOwnerTransform

protected void applyOwnerTransform(Transform ownerTransform,
                                   ConstraintHelper.Space ownerSpace)

The method applies the given transformation to the owner.

Parameters:

ownerTransform - the transformation to apply to the owner

ownerSpace - the space that defines which owner's transformation (ie. global, local, etc. will be set)

isImplemented

public boolean isImplemented()

Returns:

true if the definition is implemented and false otherwise

getAlteredOmas

public java.util.Set<java.lang.Long> getAlteredOmas()

Returns:

a list of all OMAs of the features that the constraint had altered beside its owner

getConstraintTypeName

public abstract java.lang.String getConstraintTypeName()

Returns:

the type name of the constraint

bake

public abstract void bake(ConstraintHelper.Space ownerSpace,
                          ConstraintHelper.Space targetSpace,
                          Transform targetTransform,
                          float influence)

Bakes the constraint for the current feature (bone or spatial) position.

Parameters:

ownerSpace - the space where owner transform will be evaluated in

targetSpace - the space where target transform will be evaluated in

targetTransform - the target transform used by some of the constraints

influence - the influence of the constraint from range [0; 1]

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object