org.ode4j.ode
Interface DSliderJoint

All Superinterfaces:
DJoint

public interface DSliderJoint
extends DJoint


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.ode4j.ode.DJoint
DJoint.DJointFeedback, DJoint.PARAM, DJoint.PARAM_GROUPS, DJoint.PARAM_N
 
Field Summary
 
Fields inherited from interface org.ode4j.ode.DJoint
P_OFS_1, P_OFS_2, P_OFS_3
 
Method Summary
 void addForce(double force)
          Applies the given force in the slider's direction.
 void getAxis(DVector3 result)
          Get the slider axis.
 double getParam(DJoint.PARAM_N parameter)
          Get joint parameter.
 double getPosition()
          Get the slider linear position (i.e.
 double getPositionRate()
          Get the slider linear position's time derivative.
 void setAxis(double x, double y, double z)
          Set the joint axis.
 void setAxis(DVector3C a)
          Set the joint axis.
 void setAxisDelta(double x, double y, double z, double dx, double dy, double dz)
           
 void setParam(DJoint.PARAM_N parameter, double value)
          Set joint parameter.
 void setParamBounce(double d)
           
 void setParamFMax(double d)
           
 void setParamHiStop(double d)
           
 void setParamLoStop(double d)
           
 void setParamVel(double d)
           
 
Methods inherited from interface org.ode4j.ode.DJoint
attach, DESTRUCTOR, disable, enable, getBody, getData, getFeedback, getNumBodies, isEnabled, setData, setFeedback
 

Method Detail

setAxis

void setAxis(double x,
             double y,
             double z)
Set the joint axis.


setAxis

void setAxis(DVector3C a)
Set the joint axis.


getAxis

void getAxis(DVector3 result)
Get the slider axis.


getPosition

double getPosition()
Get the slider linear position (i.e. the slider's extension).

When the axis is set, the current position of the attached bodies is examined and that position will be the zero position.

The position is the distance, with respect to the zero position, along the slider axis of body 1 with respect to body 2. (A NULL body is replaced by the world).


getPositionRate

double getPositionRate()
Get the slider linear position's time derivative.


addForce

void addForce(double force)
Applies the given force in the slider's direction.

That is, it applies a force with specified magnitude, in the direction of slider's axis, to body1, and with the same magnitude but opposite direction to body2. This function is just a wrapper for dBodyAddForce().


setParamFMax

void setParamFMax(double d)

setParamLoStop

void setParamLoStop(double d)

setParamHiStop

void setParamHiStop(double d)

setParamVel

void setParamVel(double d)

setParamBounce

void setParamBounce(double d)

setAxisDelta

void setAxisDelta(double x,
                  double y,
                  double z,
                  double dx,
                  double dy,
                  double dz)

setParam

void setParam(DJoint.PARAM_N parameter,
              double value)
Set joint parameter.

Specified by:
setParam in interface DJoint

getParam

double getParam(DJoint.PARAM_N parameter)
Get joint parameter.

Specified by:
getParam in interface DJoint