com.jme3.scene.plugins.blender.constraints

Class Constraint

java.lang.Object

com.jme3.scene.plugins.blender.constraints.Constraint

public abstract class Constraint
extends java.lang.Object

The implementation of a constraint.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	baked Indicates if the constraint is already baked or not.
protected BlenderContext	blenderContext The blender context.
protected ConstraintDefinition	constraintDefinition
protected ConstraintHelper	constraintHelper
protected Ipo	ipo The ipo object defining influence.
protected java.lang.String	name The name of this constraint.
protected java.lang.Long	ownerOMA
protected ConstraintHelper.Space	ownerSpace
protected java.lang.String	subtargetName
protected java.lang.Long	targetOMA
protected ConstraintHelper.Space	targetSpace

Constructor Summary

Constructors

Constructor and Description
Constraint(Structure constraintStructure, java.lang.Long ownerOMA, Ipo influenceIpo, BlenderContext blenderContext) This constructor creates the constraint instance.

Method Summary

Modifier and Type	Method and Description
void	apply(int frame) Applies the constraint to owner (and in some cases can alter other bones of the skeleton).
boolean	equals(java.lang.Object obj)
java.util.Set<java.lang.Long>	getAlteredOmas()
java.lang.String	getConstraintTypeName()
abstract java.lang.Long	getTargetOMA()
int	hashCode()
boolean	isImplemented()
boolean	isTrackToBeChanged()
java.lang.String	toString()
abstract boolean	validate() Performs validation before baking.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

protected final java.lang.String name

The name of this constraint.

baked

protected boolean baked

Indicates if the constraint is already baked or not.

ownerSpace

protected ConstraintHelper.Space ownerSpace

constraintDefinition

protected final ConstraintDefinition constraintDefinition

ownerOMA

protected java.lang.Long ownerOMA

targetOMA

protected java.lang.Long targetOMA

targetSpace

protected ConstraintHelper.Space targetSpace

subtargetName

protected java.lang.String subtargetName

ipo

protected final Ipo ipo

The ipo object defining influence.

blenderContext

protected final BlenderContext blenderContext

The blender context.

constraintHelper

protected final ConstraintHelper constraintHelper

Constructor Detail

Constraint

public Constraint(Structure constraintStructure,
                  java.lang.Long ownerOMA,
                  Ipo influenceIpo,
                  BlenderContext blenderContext)
           throws BlenderFileException

This constructor creates the constraint instance.

Parameters:

constraintStructure - the constraint's structure (bConstraint clss in blender 2.49).

ownerOMA - the old memory address of the constraint owner

influenceIpo - the ipo curve of the influence factor

blenderContext - the blender context

Throws:

BlenderFileException - this exception is thrown when the blender file is somehow corrupted

Method Detail

isImplemented

public boolean isImplemented()

Returns:

true if the constraint is implemented and false otherwise

getConstraintTypeName

public java.lang.String getConstraintTypeName()

Returns:

the name of the constraint type, similar to the constraint name used in Blender

getAlteredOmas

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

Returns:

the OMAs of the features whose transform had been altered beside the constraint owner

validate

public abstract boolean validate()

Performs validation before baking. Checks factors that can prevent constraint from baking that could not be checked during constraint loading.

getTargetOMA

public abstract java.lang.Long getTargetOMA()

Returns:

the OMA of the target or 0 if no target is specified for the constraint

apply

public void apply(int frame)

Applies the constraint to owner (and in some cases can alter other bones of the skeleton).

Parameters:

frame - the frame of the animation

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object