VirtualPhysics the realtime dynamics simulation library

vp1DOFJoint Class Reference

arbitrary 1 DOF joint More...

#include <vp1DOFJoint.h>

Inheritance diagram for vp1DOFJoint:

vpJoint vpHelixJoint

List of all members.

Public Member Functions

void SetTransformFunc (Transform1DOF *)
void SetPosition (const scalar &)
void SetTorque (const scalar &)
void AddTorque (const scalar &)
void SetInitialPosition (const scalar &)
void SetElasticity (const scalar &)
void SetDamping (const scalar &)
void SetUpperLimit (const scalar &)
void SetLowerLimit (const scalar &)
void SetRestitution (const scalar &)
scalar GetPosition (void) const
scalar GetVelocity (void) const
scalar GetAcceleration (void) const
scalar GetTorque (void) const
scalar GetInitialPosition (void) const
const scalar & GetElasticity (void) const
const scalar & GetDamping (void) const
scalar GetUpperLimit (void) const
scalar GetLowerLimit (void) const
void DisableUpperLimit (void)
void DisableLowerLimit (void)
bool IsEnabledUpperLimit (void) const
bool IsEnabledLowerLimit (void) const
virtual int GetDOF (void) const
virtual scalar GetNormalForce (void) const
virtual scalar GetNormalTorque (void) const


Detailed Description

vp1DOFJoint is a class for user defined 1 DOF joint.

Member Function Documentation

VP_INLINE void vp1DOFJoint::SetTransformFunc ( Transform1DOF fun  ) 

set a transform function

VP_INLINE void vp1DOFJoint::SetPosition ( const scalar &  x  ) 

set a joint value

VP_INLINE void vp1DOFJoint::SetTorque ( const scalar &  x  ) 

set a torque of the joint. The torque will be reset after every simulation step

VP_INLINE void vp1DOFJoint::AddTorque ( const scalar &  x  ) 

add a torque to the joint. The torque will be reset after every simulation step

VP_INLINE void vp1DOFJoint::SetInitialPosition ( const scalar &  x  ) 

set an initial angle of the joint variable.

VP_INLINE void vp1DOFJoint::SetElasticity ( const scalar &  x  ) 

set an elasticity of the joint variable.

VP_INLINE void vp1DOFJoint::SetDamping ( const scalar &  x  ) 

set a damping parameter of the joint variable.

VP_INLINE void vp1DOFJoint::SetUpperLimit ( const scalar &  x  ) 

set an upper joint limit.

VP_INLINE void vp1DOFJoint::SetLowerLimit ( const scalar &  x  ) 

set an upper joint limit.

VP_INLINE void vp1DOFJoint::SetRestitution ( const scalar &  e  ) 

set a restitution.

VP_INLINE scalar vp1DOFJoint::GetPosition ( void   )  const

get an angle of the joint variable.

VP_INLINE scalar vp1DOFJoint::GetVelocity ( void   )  const

get an anglular velocity of the joint variable.

VP_INLINE scalar vp1DOFJoint::GetAcceleration ( void   )  const

get an anglular acceleration of the joint variable.

VP_INLINE scalar vp1DOFJoint::GetTorque ( void   )  const

get a torque of the joint.

VP_INLINE scalar vp1DOFJoint::GetInitialPosition ( void   )  const

get an initial angle of the joint variable.

VP_INLINE const scalar & vp1DOFJoint::GetElasticity ( void   )  const

get an elasticity of the joint variable.

VP_INLINE const scalar & vp1DOFJoint::GetDamping ( void   )  const

get a damping paramter of the joint variable.

VP_INLINE scalar vp1DOFJoint::GetUpperLimit ( void   )  const

get an upper joint limit.

VP_INLINE scalar vp1DOFJoint::GetLowerLimit ( void   )  const

get an lower joint limit.

VP_INLINE void vp1DOFJoint::DisableUpperLimit ( void   ) 

disable upper joint limit.

VP_INLINE void vp1DOFJoint::DisableLowerLimit ( void   ) 

disable lower joint limit.

VP_INLINE bool vp1DOFJoint::IsEnabledUpperLimit ( void   )  const

return whether this joint is set to have upper limit

VP_INLINE bool vp1DOFJoint::IsEnabledLowerLimit ( void   )  const

return whether this joint is set to have lower limit

VP_INLINE int vp1DOFJoint::GetDOF ( void   )  const [virtual]

return the degrees of freedom.

Implements vpJoint.

VP_INLINE scalar vp1DOFJoint::GetNormalForce ( void   )  const [virtual]

get a magnitude of normal force applied to the joint.

Implements vpJoint.

VP_INLINE scalar vp1DOFJoint::GetNormalTorque ( void   )  const [virtual]

get a magnitude of normal torque applied to the joint.

Implements vpJoint.


Generated on Wed Jun 11 23:11:49 2008 for VirtualPhysics by  doxygen 1.5.5