com.jme3.bullet.joints.motors

Class TranslationalLimitMotor

java.lang.Object

com.jme3.bullet.joints.motors.TranslationalLimitMotor

public class TranslationalLimitMotor
extends java.lang.Object

A motor based on Bullet's btTranslationalLimitMotor. Motors are used to drive joints.

Constructor Summary

Constructors

Constructor and Description
TranslationalLimitMotor(long motor) Instantiate a motor for the identified btTranslationalLimitMotor.

Method Summary

Modifier and Type	Method and Description
Vector3f	getAccumulatedImpulse() Copy the accumulated impulse.
float	getDamping() Read this motor's damping.
float	getLimitSoftness() Read this motor's limit softness.
Vector3f	getLowerLimit() Copy this motor's constraint lower limits.
long	getMotor() Read the id of the btTranslationalLimitMotor.
float	getRestitution() Read this motor's restitution.
Vector3f	getUpperLimit() Copy this motor's constraint upper limits.
boolean	isEnabled(int axisIndex) Test whether the indexed axis is enabled.
void	setAccumulatedImpulse(Vector3f accumulatedImpulse) Alter the accumulated impulse.
void	setDamping(float damping) Alter this motor's damping.
void	setEnabled(int axisIndex, boolean enableMotor) Enable or disable the indexed axis.
void	setLimitSoftness(float limitSoftness) Alter the limit softness.
void	setLowerLimit(Vector3f lowerLimit) Alter the constraint lower limits.
void	setRestitution(float restitution) Alter this motor's restitution.
void	setUpperLimit(Vector3f upperLimit) Alter the constraint upper limits.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationalLimitMotor

public TranslationalLimitMotor(long motor)

Instantiate a motor for the identified btTranslationalLimitMotor.

Parameters:

motor - the unique identifier (not zero)

Method Detail

getMotor

public long getMotor()

Read the id of the btTranslationalLimitMotor.

Returns:

the unique identifier (not zero)

getLowerLimit

public Vector3f getLowerLimit()

Copy this motor's constraint lower limits.

Returns:

a new vector (not null)

setLowerLimit

public void setLowerLimit(Vector3f lowerLimit)

Alter the constraint lower limits.

Parameters:

lowerLimit - (unaffected, not null)

getUpperLimit

public Vector3f getUpperLimit()

Copy this motor's constraint upper limits.

Returns:

a new vector (not null)

setUpperLimit

public void setUpperLimit(Vector3f upperLimit)

Alter the constraint upper limits.

Parameters:

upperLimit - (unaffected, not null)

getAccumulatedImpulse

public Vector3f getAccumulatedImpulse()

Copy the accumulated impulse.

Returns:

a new vector (not null)

setAccumulatedImpulse

public void setAccumulatedImpulse(Vector3f accumulatedImpulse)

Alter the accumulated impulse.

Parameters:

accumulatedImpulse - the desired vector (not null, unaffected)

getLimitSoftness

public float getLimitSoftness()

Read this motor's limit softness.

Returns:

the softness

setLimitSoftness

public void setLimitSoftness(float limitSoftness)

Alter the limit softness.

Parameters:

limitSoftness - the desired limit softness (default=0.5)

getDamping

public float getDamping()

Read this motor's damping.

Returns:

the viscous damping ratio (0→no damping, 1→critically damped)

setDamping

public void setDamping(float damping)

Alter this motor's damping.

Parameters:

damping - the desired viscous damping ratio (0→no damping, 1→critically damped, default=1)

getRestitution

public float getRestitution()

Read this motor's restitution.

Returns:

the restitution (bounce) factor

setRestitution

public void setRestitution(float restitution)

Alter this motor's restitution.

Parameters:

restitution - the desired restitution (bounce) factor

setEnabled

public void setEnabled(int axisIndex,
                       boolean enableMotor)

Enable or disable the indexed axis.

Parameters:

axisIndex - which axis: 0→X, 1→Y, 2→Z

enableMotor - true→enable, false→disable (default=false)

isEnabled

public boolean isEnabled(int axisIndex)

Test whether the indexed axis is enabled.

Parameters:

axisIndex - which axis: 0→X, 1→Y, 2→Z

Returns:

true if enabled, otherwise false