Jamoma API  0.6.0.a19
TTSpatEntity Class Reference

The TTSpatEntity class describes the geometry of a point. More...

#include <TTSpatEntity.h>

+ Inheritance diagram for TTSpatEntity:

Public Member Functions

 TTSpatEntity ()
 Constructor.
 
virtual ~TTSpatEntity ()
 Destructor.
 
void getPosition (TTFloat64 &x, TTFloat64 &y, TTFloat64 &z)
 Get the current position of the point. More...
 
void setPosition (TTFloat64 x, TTFloat64 y, TTFloat64 z)
 Set the position of the point. More...
 
void getOrientation (TTFloat64 &q1, TTFloat64 &q2, TTFloat64 &q3, TTFloat64 &q4)
 Get the orientation of the point expressed as quaternions. More...
 
void setOrientation (TTFloat64 q1, TTFloat64 q2, TTFloat64 q3, TTFloat64 q4)
 Set the orientation of the point expressed as quaternions. More...
 

Protected Attributes

std::array< TTFloat64, 3 > mPosition
 Position as Cartesian coordinates.
 
std::array< TTFloat64, 4 > mOrientation
 The orientation of the object using Euler coordinates.
 
std::array< TTFloat64, 4 > mData
 Storage for up to 4 values that can be used by subclasses.
 

Detailed Description

The TTSpatEntity class describes the geometry of a point.

It can be used to describe a source or a sink, and includes the minimum amount of descriptors as defined in the core section of the SpatDIF specs.

Definition at line 26 of file TTSpatEntity.h.

Member Function Documentation

void TTSpatEntity::getOrientation ( TTFloat64 q1,
TTFloat64 q2,
TTFloat64 q3,
TTFloat64 q4 
)

Get the orientation of the point expressed as quaternions.

Parameters
q1First coordinate of the point.
q2Second coordinate of the point.
q3Third coordinate of the point.
q4Fourth coordinate of the point.

Definition at line 49 of file TTSpatEntity.cpp.

References mOrientation.

void TTSpatEntity::getPosition ( TTFloat64 x,
TTFloat64 y,
TTFloat64 z 
)

Get the current position of the point.

Parameters
xCartesian x-coordinate of the point.
yCartesian y-coordinate of the point.
zCartesian z-coordinate of the point.

Definition at line 33 of file TTSpatEntity.cpp.

References mPosition.

void TTSpatEntity::setOrientation ( TTFloat64  q1,
TTFloat64  q2,
TTFloat64  q3,
TTFloat64  q4 
)

Set the orientation of the point expressed as quaternions.

Parameters
q1First coordinate of the point.
q2Second coordinate of the point.
q3Third coordinate of the point.
q4Fourth coordinate of the point.

Definition at line 58 of file TTSpatEntity.cpp.

References mOrientation.

void TTSpatEntity::setPosition ( TTFloat64  x,
TTFloat64  y,
TTFloat64  z 
)

Set the position of the point.

Parameters
xCartesian x-coordinate of the point.
yCartesian y-coordinate of the point.
zCartesian z-coordinate of the point.

Definition at line 41 of file TTSpatEntity.cpp.

References mPosition.


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