Abstract PL physics hinge (other name: revolute) joint. More...
#include <JointHinge.h>
Inheritance diagram for PLPhysics::JointHinge:
Public Member Functions | |
| virtual PLPHYSICS_API | ~JointHinge () |
| Destructor. | |
| PLPHYSICS_API const PLMath::Vector3 & | GetPivotPoint () const |
| Returns the origin of the hinge in world space. | |
| PLPHYSICS_API const PLMath::Vector3 & | GetPinDir () const |
| Returns the line of action of the hinge in world space. | |
| PLPHYSICS_API float | GetLowRange () const |
| Returns the low range. | |
| PLPHYSICS_API void | SetLowRange (float fLowRange=-180.0f) |
| Sets the low range. | |
| PLPHYSICS_API float | GetHighRange () const |
| Returns the high range. | |
| PLPHYSICS_API void | SetHighRange (float fHighRange=180.0f) |
| Sets the high range. | |
| virtual void | AddOmega (float fOmega)=0 |
| Adds omega to the bodies assigned with this joint. | |
Protected Member Functions | |
| PLPHYSICS_API | JointHinge (World &cWorld, JointImpl &cJointImpl, Body *pParentBody, Body *pChildBody, const PLMath::Vector3 &vPivotPoint, const PLMath::Vector3 &vPinDir) |
| Constructor. | |
Protected Attributes | |
| PLMath::Vector3 | m_vPivotPoint |
| PLMath::Vector3 | m_vPinDir |
Detailed Description
Abstract PL physics hinge (other name: revolute) joint.
- Remarks:
- DOFs removed: 5 DOFs remaining: 1
Constructor & Destructor Documentation
| virtual PLPHYSICS_API PLPhysics::JointHinge::~JointHinge | ( | ) | [virtual] |
Destructor.
| PLPHYSICS_API PLPhysics::JointHinge::JointHinge | ( | World & | cWorld, |
| JointImpl & | cJointImpl, | ||
| Body * | pParentBody, | ||
| Body * | pChildBody, | ||
| const PLMath::Vector3 & | vPivotPoint, | ||
| const PLMath::Vector3 & | vPinDir | ||
| ) | [protected] |
Constructor.
- Parameters:
-
[in] cWorld World this joint is in [in] cJointImpl Reference to the physics API specific joint implementation [in] pParentBody Pointer to the parent rigid body, can be a null pointer [in] pChildBody Pointer to the attached rigid body, can be a null pointer [in] vPivotPoint Origin of the hinge in world space [in] vPinDir The line of action of the hinge in world space
Member Function Documentation
| PLPHYSICS_API const PLMath::Vector3& PLPhysics::JointHinge::GetPivotPoint | ( | ) | const |
Returns the origin of the hinge in world space.
- Returns:
- The origin of the hinge in world space
| PLPHYSICS_API const PLMath::Vector3& PLPhysics::JointHinge::GetPinDir | ( | ) | const |
Returns the line of action of the hinge in world space.
- Returns:
- The line of action of the hinge in world space
| PLPHYSICS_API float PLPhysics::JointHinge::GetLowRange | ( | ) | const |
Returns the low range.
- Returns:
- The low range in degree
| PLPHYSICS_API void PLPhysics::JointHinge::SetLowRange | ( | float | fLowRange = -180.0f | ) |
Sets the low range.
- Parameters:
-
[in] fLowRange New low range in degree
| PLPHYSICS_API float PLPhysics::JointHinge::GetHighRange | ( | ) | const |
Returns the high range.
- Returns:
- The high range in degree
| PLPHYSICS_API void PLPhysics::JointHinge::SetHighRange | ( | float | fHighRange = 180.0f | ) |
Sets the high range.
- Parameters:
-
[in] fHighRange New high range in degree
| virtual void PLPhysics::JointHinge::AddOmega | ( | float | fOmega | ) | [pure virtual] |
Adds omega to the bodies assigned with this joint.
- Parameters:
-
[in] fOmega Omega to add
Member Data Documentation
PLMath::Vector3 PLPhysics::JointHinge::m_vPivotPoint [protected] |
Origin of the hinge in world space
PLMath::Vector3 PLPhysics::JointHinge::m_vPinDir [protected] |
The line of action of the hinge in world space
The documentation for this class was generated from the following file:
