om::physics::objects::CharacterController Class Reference

A class that implements. More...

#include <omPhysicsCharacterController.h>

Inheritance diagram for om::physics::objects::CharacterController:

Public Member Functions
	CharacterController ()
	Create a default physics object centered at the origin with no shape. More...
const Vector3f &	getPosition () const
	Return the position of this character in world space. More...
void	setPosition (const Vector3f &newPosition)
	Set the position of this character in world space. More...
const Matrix3f &	getOrientation () const
	Return a reference to this character's 3x3 orthonormal rotation matrix. More...
void	setOrientation (const Matrix3f &newOrientation)
	Set this character's 3x3 orthonormal rotation matrix. More...
const Transform3f &	getTransform () const
	Return a const reference to this character's transformation. More...
void	setTransform (const Transform3f &newTransform)
	Set this character's transformation. More...
const Vector2f &	getHeading () const
	Return a const reference to this character's current heading vector. More...
void	setHeading (const Vector2f &newHeading)
	Set this character's heading vector. More...
const AABB2f &	getMaxVelocity () const
	Return a const reference to this character's maximum velocity in each local direction. More...
void	setMaxVelocity (const AABB2f &newMaxVelocity)
	Set this character's maximum velocity in each local direction. More...
const AABB2f &	getMaxForce () const
	Return a const reference to this character's maximum force in each local direction. More...
void	setMaxForce (const AABB2f &newMaxForce)
	Set this character's maximum force in each local direction. More...
virtual Bool	setContext (PhysicsContext *newContext)
	Set a pointer to the physics context this context object should use to do simulation. More...
virtual Bool	addSceneObjects (PhysicsSceneID sceneID)
	Add internal context objects to the scene with the specified ID. More...
Public Member Functions inherited from om::physics::objects::PhysicsObject
const PhysicsObjectType &	getType () const
	Return an object representing the type of this object. More...
virtual Bool	upload ()
	Upload this object's current representation to the simulation. More...
virtual Bool	download ()
	Download the object's simulation representation to the object's local state. More...
Public Member Functions inherited from om::physics::context::PhysicsSceneObject
virtual Bool	addSceneObjects (PhysicsSceneID sceneID)
	Add internal context objects to the scene with the specified ID. More...
virtual Bool	removeSceneObjects (PhysicsSceneID sceneID)
	Remove internal context objects from the scene with the specified ID. More...
Public Member Functions inherited from om::physics::context::PhysicsContextObject
virtual	~PhysicsContextObject ()
	Destory this physics context object. More...
PhysicsContext *	getContext () const
	Return a pointer to the physics context this context object is using to do simulation. More...
Bool	clearContext ()
	Clear the previous context from this object. More...

Static Public Attributes
static const PhysicsObjectType	TYPE
	The object type for a character controller. More...
Static Public Attributes inherited from om::physics::objects::PhysicsObject
static const ResourceType	RESOURCE_TYPE
	The resource type for a physics object. More...

Additional Inherited Members
Protected Member Functions inherited from om::physics::objects::PhysicsObject
	PhysicsObject (const PhysicsObjectType *newType)
	Create a physics object that has the specified type. More...
Protected Member Functions inherited from om::physics::context::PhysicsContextObject
	PhysicsContextObject ()
	Create a new physics context object that doesn't have an associated physics context. More...
	PhysicsContextObject (PhysicsContext *newContext)
	Create a new physics context object that uses the specified context for simulation. More...
Protected Attributes inherited from om::physics::context::PhysicsContextObject
PhysicsContext *	context
	A pointer to the physics context this object is using. More...

Detailed Description

A class that implements.

Constructor & Destructor Documentation

om::physics::objects::CharacterController::CharacterController

(

)

Create a default physics object centered at the origin with no shape.

Member Function Documentation

const Vector3f& om::physics::objects::CharacterController::getPosition ( ) const

inline

Return the position of this character in world space.

void om::physics::objects::CharacterController::setPosition ( const Vector3f &  newPosition )

inline

Set the position of this character in world space.

const Matrix3f& om::physics::objects::CharacterController::getOrientation ( ) const

inline

Return a reference to this character's 3x3 orthonormal rotation matrix.

void om::physics::objects::CharacterController::setOrientation ( const Matrix3f &  newOrientation )

inline

Set this character's 3x3 orthonormal rotation matrix.

const Transform3f& om::physics::objects::CharacterController::getTransform ( ) const

inline

Return a const reference to this character's transformation.

void om::physics::objects::CharacterController::setTransform ( const Transform3f &  newTransform )

inline

Set this character's transformation.

const Vector2f& om::physics::objects::CharacterController::getHeading ( ) const

inline

Return a const reference to this character's current heading vector.

The length of the vector indicates the fraction of the maximum velocity the character controller should move at.

void om::physics::objects::CharacterController::setHeading ( const Vector2f &  newHeading )

inline

Set this character's heading vector.

The length of the vector indicates the fraction of the maximum velocity the character controller should move at.

const AABB2f& om::physics::objects::CharacterController::getMaxVelocity ( ) const

inline

Return a const reference to this character's maximum velocity in each local direction.

void om::physics::objects::CharacterController::setMaxVelocity ( const AABB2f &  newMaxVelocity )

inline

Set this character's maximum velocity in each local direction.

const AABB2f& om::physics::objects::CharacterController::getMaxForce ( ) const

inline

Return a const reference to this character's maximum force in each local direction.

void om::physics::objects::CharacterController::setMaxForce ( const AABB2f &  newMaxForce )

inline

Set this character's maximum force in each local direction.

virtual Bool om::physics::objects::CharacterController::setContext ( PhysicsContext *  newContext )

virtual

Set a pointer to the physics context this context object should use to do simulation.

Reimplemented from om::physics::context::PhysicsContextObject.

virtual Bool om::physics::objects::CharacterController::addSceneObjects ( PhysicsSceneID  sceneID )

virtual

Add internal context objects to the scene with the specified ID.

Member Data Documentation

const PhysicsObjectType om::physics::objects::CharacterController::TYPE

static

The object type for a character controller.

---

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

• omPhysicsCharacterController.h