Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::engine::base::Trajectory Class Reference

A class that stores a 3D transformation and velocity information for a moving object. More...

#include <omEngineTrajectory.h>

Public Member Functions

 Trajectory ()
 Create a default identity trajectory transformation with no motion. More...
 
 Trajectory (const Transform3f &newTransform)
 Create a trajectory with the specified static transformation. More...
 
 Trajectory (const Transform3f &newTransform, const Vector3f &newVelocity, const Vector3f &newAngularVelocity=Vector3f())
 Create a trajectory with the specified transformation and velocities. More...
 
const Vector3fgetPosition () const
 Return the position of this trajectory in world space. More...
 
void setPosition (const Vector3f &newPosition)
 Set the position of this trajectory in world space. More...
 
const Matrix3fgetOrientation () const
 Return a reference to this trajectory's 3x3 orthonormal rotation matrix. More...
 
void setOrientation (const Matrix3f &newOrientation)
 Set this trajectory's 3x3 orthonormal rotation matrix. More...
 
const Transform3fgetTransform () const
 Return a const reference to this trajectory's transformation. More...
 
void setTransform (const Transform3f &newTransform)
 Set this trajectory's transformation. More...
 
const Vector3fgetVelocity () const
 Return the linear velocity of this trajectory in world units per second. More...
 
void setVelocity (const Vector3f &newVelocity)
 Set the linear velocity of this trajectory in world units per second. More...
 
const Vector3fgetAngularVelocity () const
 Return the angular velocity of this trajectory in radians per second. More...
 
void setAngularVelocity (const Vector3f &newAngularVelocity)
 Set the angular velocity of this trajectory in radians per second. More...
 

Detailed Description

A class that stores a 3D transformation and velocity information for a moving object.

This class allows unrelated systems to communicate the positions of common objects. For example, a physics object can set a trajectory that is then read by a graphics object.

Constructor & Destructor Documentation

om::engine::base::Trajectory::Trajectory ( )
inline

Create a default identity trajectory transformation with no motion.

om::engine::base::Trajectory::Trajectory ( const Transform3f newTransform)
inline

Create a trajectory with the specified static transformation.

om::engine::base::Trajectory::Trajectory ( const Transform3f newTransform,
const Vector3f newVelocity,
const Vector3f newAngularVelocity = Vector3f() 
)
inline

Create a trajectory with the specified transformation and velocities.

Member Function Documentation

const Vector3f& om::engine::base::Trajectory::getPosition ( ) const
inline

Return the position of this trajectory in world space.

void om::engine::base::Trajectory::setPosition ( const Vector3f newPosition)
inline

Set the position of this trajectory in world space.

const Matrix3f& om::engine::base::Trajectory::getOrientation ( ) const
inline

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

This is the orthonormal matrix which defines the rotational transformation from object to world space.

void om::engine::base::Trajectory::setOrientation ( const Matrix3f newOrientation)
inline

Set this trajectory's 3x3 orthonormal rotation matrix.

This is the orthonormal matrix which defines the rotational transformation from object to world space.

const Transform3f& om::engine::base::Trajectory::getTransform ( ) const
inline

Return a const reference to this trajectory's transformation.

void om::engine::base::Trajectory::setTransform ( const Transform3f newTransform)
inline

Set this trajectory's transformation.

const Vector3f& om::engine::base::Trajectory::getVelocity ( ) const
inline

Return the linear velocity of this trajectory in world units per second.

void om::engine::base::Trajectory::setVelocity ( const Vector3f newVelocity)
inline

Set the linear velocity of this trajectory in world units per second.

const Vector3f& om::engine::base::Trajectory::getAngularVelocity ( ) const
inline

Return the angular velocity of this trajectory in radians per second.

void om::engine::base::Trajectory::setAngularVelocity ( const Vector3f newAngularVelocity)
inline

Set the angular velocity of this trajectory in radians per second.


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