PLPhysics::JointBall Class Reference

Abstract PL physics ball and socket (other name: spherical) joint. More...

#include <JointBall.h>

Inheritance diagram for PLPhysics::JointBall:

List of all members.

Public Member Functions
virtual PLPHYSICS_API	~JointBall ()
	Destructor.
PLPHYSICS_API const PLMath::Vector3 &	GetPivotPoint () const
	Returns the origin of the ball and socket in world space.
PLPHYSICS_API const PLMath::Vector3 &	GetPinDir () const
	Returns the vector defining the cone axis in world space.
Protected Member Functions
PLPHYSICS_API	JointBall (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 ball and socket (other name: spherical) joint.

Remarks:

DOFs removed: 3 DOFs remaining: 3

Note:

• All non-zero value for 'MaxConeAngle' are clamped between 5 degree and 175 degrees

---

Constructor & Destructor Documentation

virtual PLPHYSICS_API PLPhysics::JointBall::~JointBall

(

)

[virtual]

Destructor.

PLPHYSICS_API PLPhysics::JointBall::JointBall	(	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 ball and socket in world space
[in]	vPinDir	Vector defining the cone axis in world space

---

Member Function Documentation

PLPHYSICS_API const PLMath::Vector3& PLPhysics::JointBall::GetPivotPoint

(

)

const

Returns the origin of the ball and socket in world space.

Returns:

The origin of the ball and socket in world space

PLPHYSICS_API const PLMath::Vector3& PLPhysics::JointBall::GetPinDir

(

)

const

Returns the vector defining the cone axis in world space.

Returns:

The vector defining the cone axis in world space

---

Member Data Documentation

PLMath::Vector3 PLPhysics::JointBall::m_vPivotPoint [protected]

Origin of the ball and socket in world space

PLMath::Vector3 PLPhysics::JointBall::m_vPinDir [protected]

Vector defining the cone axis in world space

---

The documentation for this class was generated from the following file:

• JointBall.h