PixelLightAPI  .
Public Member Functions | Protected Member Functions | Protected Attributes
PLPhysics::JointCorkscrew Class Reference

Abstract PL physics corkscrew joint. More...

#include <JointCorkscrew.h>

Inheritance diagram for PLPhysics::JointCorkscrew:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual PLPHYSICS_API ~JointCorkscrew ()
 Destructor.
PLPHYSICS_API const
PLMath::Vector3
GetPivotPoint () const
 Returns the origin of the corkscrew in world space.
PLPHYSICS_API const
PLMath::Vector3
GetPinDir () const
 Returns the line of action of the corkscrew in world space.

Protected Member Functions

PLPHYSICS_API JointCorkscrew (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 corkscrew joint.


Constructor & Destructor Documentation

virtual PLPHYSICS_API PLPhysics::JointCorkscrew::~JointCorkscrew ( ) [virtual]

Destructor.

PLPHYSICS_API PLPhysics::JointCorkscrew::JointCorkscrew ( World cWorld,
JointImpl &  cJointImpl,
Body pParentBody,
Body pChildBody,
const PLMath::Vector3 vPivotPoint,
const PLMath::Vector3 vPinDir 
) [protected]

Constructor.

Parameters:
[in]cWorldWorld this joint is in
[in]cJointImplReference to the physics API specific joint implementation
[in]pParentBodyPointer to the parent rigid body, can be a null pointer
[in]pChildBodyPointer to the attached rigid body, can be a null pointer
[in]vPivotPointOrigin of the corkscrew in world space
[in]vPinDirThe line of action of the corkscrew in world space

Member Function Documentation

Returns the origin of the corkscrew in world space.

Returns:
The origin of the corkscrew in world space
PLPHYSICS_API const PLMath::Vector3& PLPhysics::JointCorkscrew::GetPinDir ( ) const

Returns the line of action of the corkscrew in world space.

Returns:
The line of action of the corkscrew in world space

Member Data Documentation

Origin of the corkscrew in world space

The line of action of the corkscrew in world space


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:37
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported