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

Abstract PL physics up vector joint. More...

#include <JointUpVector.h>

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

List of all members.

Public Member Functions

virtual PLPHYSICS_API ~JointUpVector ()
 Destructor.
PLPHYSICS_API const
PLMath::Vector3
GetPinDir () const
 Returns the aligning vector in world space.

Protected Member Functions

PLPHYSICS_API JointUpVector (World &cWorld, JointImpl &cJointImpl, Body &cParentBody, const PLMath::Vector3 &vPinDir)
 Constructor.

Protected Attributes

PLMath::Vector3 m_vPinDir

Detailed Description

Abstract PL physics up vector joint.

Remarks:
This function creates an up vector joint. An up vector joint is a constraint that allows a body to translate freely in 3d space, but it only allows the body to rotate around the pin direction vector. This could be use by the application to control a character with physics and collision Since the up vector joint is a unuary constraint, there is not need to have user callback or user data assigned to it. The application can simple hold to the joint handle and update the pin on the force callback function of the rigid body owning the joint.
Note:
  • This joint type has no parent

Constructor & Destructor Documentation

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

Destructor.

PLPHYSICS_API PLPhysics::JointUpVector::JointUpVector ( World cWorld,
JointImpl &  cJointImpl,
Body cParentBody,
const PLMath::Vector3 vPinDir 
) [protected]

Constructor.

Parameters:
[in]cWorldWorld this joint is in
[in]cJointImplReference to the physics API specific joint implementation
[in]cParentBodyReference to the parent rigid body
[in]vPinDirThe aligning vector in world space

Member Function Documentation

PLPHYSICS_API const PLMath::Vector3& PLPhysics::JointUpVector::GetPinDir ( ) const

Returns the aligning vector in world space.

Returns:
The aligning vector in world space

Member Data Documentation

The aligning vector in world space


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


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:21
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported