Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

VPBiaxialJoint Class Reference

A joint with two rotational degrees of freedom. More...

#include <vpbiaxialjoint.h>

Inheritance diagram for VPBiaxialJoint:

VPJoint VPTransform VPSceneNode VPMemoryObj VPCondylarJoint VPEllipsoidJoint VPSaddlelJoint List of all members.

Public Member Functions

 VPBiaxialJoint ()
 Creates an uninitialized biaxial (2 DOFs) joint.
virtual ~VPBiaxialJoint ()
void SetFlexionTo (float value)
 Sets the first DOF.
void Flex (float variance)
 Moves the first DOF.
void SetAductionTo (float value)
 Sets the second DOF.
void SetAdductionTo (float value)
 Sets the second DOF.
void Adduct (float variance)
 Moves the second DOF.
void AddDof (VPDof *dof)
 Add a DOF to the joint.

Detailed Description

A joint with two rotational degrees of freedom.

FixMe: Put detailed description here.

Definition at line 17 of file vpbiaxialjoint.h.


Constructor & Destructor Documentation

VPBiaxialJoint::VPBiaxialJoint  ) 
 

Creates an uninitialized biaxial (2 DOFs) joint.

Before using the joint, two DOFs should be added to it.

Definition at line 29 of file vpbiaxialjoint.cpp.

VPBiaxialJoint::~VPBiaxialJoint  )  [virtual]
 

Definition at line 33 of file vpbiaxialjoint.cpp.


Member Function Documentation

void VPBiaxialJoint::AddDof VPDof dof  ) 
 

Add a DOF to the joint.

Parameters:
dof [in] A pointer to the DOF that is to be added.
At most two DOFs can be added to a biaxial joint. VPJoint's destructor will dealocate DOFs marked as autoDelete.

Reimplemented from VPJoint.

Definition at line 69 of file vpbiaxialjoint.cpp.

References VPJoint::AddDof(), VPJoint::GetNumDofs(), and VPJoint::MakeLim().

void VPBiaxialJoint::Adduct float  variance  ) 
 

Moves the second DOF.

Parameters:
variance [in] A number in the range [0:1] - will be added to the second DOF's position (see VPDof::GetCurrent).

Definition at line 60 of file vpbiaxialjoint.cpp.

References VPJoint::dofList, VPJoint::GetNumDofs(), and VPDof::Move().

void VPBiaxialJoint::Flex float  variance  )  [inline]
 

Moves the first DOF.

Parameters:
variance [in] A number in the range [0:1] - will be added to the first DOF's position (see VPDof::GetCurrent).

Definition at line 37 of file vpbiaxialjoint.h.

References VPJoint::dofList.

void VPBiaxialJoint::SetAdductionTo float  value  ) 
 

Sets the second DOF.

Parameters:
value [in] A number in the range [0:1] - zero means "set to minimal angle" and 1 means "set to maximal angle".

Definition at line 51 of file vpbiaxialjoint.cpp.

References VPJoint::dofList, VPJoint::GetNumDofs(), and VPDof::MoveTo().

Referenced by SetAductionTo().

void VPBiaxialJoint::SetAductionTo float  value  ) 
 

Sets the second DOF.

Deprecated:
Spelling has been corrected to SetAdductionTo.

Definition at line 45 of file vpbiaxialjoint.cpp.

References SetAdductionTo().

void VPBiaxialJoint::SetFlexionTo float  value  ) 
 

Sets the first DOF.

Parameters:
value [in] A number in the range [0:1] - zero means "set to minimal angle" and 1 means "set to maximal angle".

Definition at line 39 of file vpbiaxialjoint.cpp.

References VPJoint::dofList, and VPDof::MoveTo().


The documentation for this class was generated from the following files:
Generated on Tue Sep 6 10:00:12 2005 for VPAT by  doxygen 1.4.4