com.jme3.bullet.joints.motors

Class RotationalLimitMotor

java.lang.Object

com.jme3.bullet.joints.motors.RotationalLimitMotor

public class RotationalLimitMotor
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
RotationalLimitMotor(long motor) Instantiate a motor for the identified btRotationalLimitMotor.

Method Summary

Modifier and Type	Method and Description
float	getBounce() Read this motor's bounce.
float	getDamping() Read this motor's damping.
float	getERP() Read this motor's error tolerance at limits.
float	getHiLimit() Read this motor's constraint upper limit.
float	getLimitSoftness() Read this motor's limit softness.
float	getLoLimit() Read this motor's constraint lower limit.
float	getMaxLimitForce() Read the limit's maximum force.
float	getMaxMotorForce() Read this motor's maximum force.
long	getMotor() Read the id of the btRotationalLimitMotor.
float	getTargetVelocity() Read this motor's target velocity.
boolean	isEnableMotor() Test whether this motor is enabled.
void	setBounce(float bounce) Alter this motor's bounce.
void	setDamping(float damping) Alter this motor's damping.
void	setEnableMotor(boolean enableMotor) Enable or disable this motor.
void	setERP(float ERP) Alter this motor's error tolerance at limits.
void	setHiLimit(float hiLimit) Alter this motor's constraint upper limit.
void	setLimitSoftness(float limitSoftness) Alter this motor's limit softness.
void	setLoLimit(float loLimit) Alter this motor's constraint lower limit.
void	setMaxLimitForce(float maxLimitForce) Alter the limit's maximum force.
void	setMaxMotorForce(float maxMotorForce) Alter this motor's maximum force.
void	setTargetVelocity(float targetVelocity) Alter this motor's target velocity.

Methods inherited from class java.lang.Object

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

Constructor Detail

RotationalLimitMotor

public RotationalLimitMotor(long motor)

Instantiate a motor for the identified btRotationalLimitMotor.

Parameters:

motor - the unique identifier (not zero)

Method Detail

getMotor

public long getMotor()

Read the id of the btRotationalLimitMotor.

Returns:

the identifier of the btRotationalLimitMotor (not zero)

getLoLimit

public float getLoLimit()

Read this motor's constraint lower limit.

Returns:

the limit value

setLoLimit

public void setLoLimit(float loLimit)

Alter this motor's constraint lower limit.

Parameters:

loLimit - the desired limit value

getHiLimit

public float getHiLimit()

Read this motor's constraint upper limit.

Returns:

the limit value

setHiLimit

public void setHiLimit(float hiLimit)

Alter this motor's constraint upper limit.

Parameters:

hiLimit - the desired limit value

getTargetVelocity

public float getTargetVelocity()

Read this motor's target velocity.

Returns:

the target velocity (in radians per second)

setTargetVelocity

public void setTargetVelocity(float targetVelocity)

Alter this motor's target velocity.

Parameters:

targetVelocity - the desired target velocity (in radians per second)

getMaxMotorForce

public float getMaxMotorForce()

Read this motor's maximum force.

Returns:

the maximum force

setMaxMotorForce

public void setMaxMotorForce(float maxMotorForce)

Alter this motor's maximum force.

Parameters:

maxMotorForce - the desired maximum force on the motor

getMaxLimitForce

public float getMaxLimitForce()

Read the limit's maximum force.

Returns:

the maximum force on the limit

setMaxLimitForce

public void setMaxLimitForce(float maxLimitForce)

Alter the limit's maximum force.

Parameters:

maxLimitForce - the desired maximum force on the limit

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)

getLimitSoftness

public float getLimitSoftness()

Read this motor's limit softness.

Returns:

the limit softness

setLimitSoftness

public void setLimitSoftness(float limitSoftness)

Alter this motor's limit softness.

Parameters:

limitSoftness - the desired limit softness

getERP

public float getERP()

Read this motor's error tolerance at limits.

Returns:

the error tolerance (>0)

setERP

public void setERP(float ERP)

Alter this motor's error tolerance at limits.

Parameters:

ERP - the desired error tolerance (>0)

getBounce

public float getBounce()

Read this motor's bounce.

Returns:

the bounce (restitution factor)

setBounce

public void setBounce(float bounce)

Alter this motor's bounce.

Parameters:

bounce - the desired bounce (restitution factor)

isEnableMotor

public boolean isEnableMotor()

Test whether this motor is enabled.

Returns:

true if enabled, otherwise false

setEnableMotor

public void setEnableMotor(boolean enableMotor)

Enable or disable this motor.

Parameters:

enableMotor - true→enable, false→disable