ogre_tools::Axes Class Reference
An object that displays a set of X/Y/Z axes, with X=Red, Y=Green, Z=Blue.
More...
#include <axes.h>
List of all members.
Public Member Functions |
| Axes (Ogre::SceneManager *manager, Ogre::SceneNode *parent_node=NULL, float length=1.0f, float radius=0.1f) |
| Constructor.
|
virtual const Ogre::Quaternion & | getOrientation () |
| Get the local orientation of this object.
|
virtual const Ogre::Vector3 & | getPosition () |
| Get the local position of this object.
|
Ogre::SceneNode * | getSceneNode () |
| Get the scene node associated with this object.
|
Shape * | getXShape () |
Shape * | getYShape () |
Shape * | getZShape () |
void | set (float length, float radius) |
| Set the parameters on this object.
|
virtual void | setColor (float r, float g, float b, float a) |
| Set the color of the object. Values are in the range [0, 1].
|
virtual void | setOrientation (const Ogre::Quaternion &orientation) |
| Set the orientation of the object.
|
virtual void | setPosition (const Ogre::Vector3 &position) |
| Set the position of this object.
|
virtual void | setScale (const Ogre::Vector3 &scale) |
| Set the scale of the object. Always relative to the identity orientation of the object.
|
void | setToDefaultColors () |
void | setUserData (const Ogre::Any &data) |
| Sets user data on all ogre objects we own.
|
void | setXColor (const Ogre::ColourValue &col) |
void | setYColor (const Ogre::ColourValue &col) |
void | setZColor (const Ogre::ColourValue &col) |
virtual | ~Axes () |
Static Public Member Functions |
static const Ogre::ColourValue & | getDefaultXColor () |
static const Ogre::ColourValue & | getDefaultYColor () |
static const Ogre::ColourValue & | getDefaultZColor () |
Private Member Functions |
| Axes (const Axes &other) |
Axes & | operator= (const Axes &other) |
Private Attributes |
Ogre::SceneNode * | scene_node_ |
Shape * | x_axis_ |
| Cylinder for the X-axis.
|
Shape * | y_axis_ |
| Cylinder for the Y-axis.
|
Shape * | z_axis_ |
| Cylinder for the Z-axis.
|
Detailed Description
An object that displays a set of X/Y/Z axes, with X=Red, Y=Green, Z=Blue.
Definition at line 58 of file axes.h.
Constructor & Destructor Documentation
ogre_tools::Axes::Axes |
( |
Ogre::SceneManager * |
manager, |
|
|
Ogre::SceneNode * |
parent_node = NULL , |
|
|
float |
length = 1.0f , |
|
|
float |
radius = 0.1f | |
|
) |
| | |
Constructor.
- Parameters:
-
| manager | Scene manager this object is a part of |
| parent_node | A scene node to use as the parent of this object. If NULL, uses the root scene node. |
| length | Length of the axes |
| radius | Radius of the axes |
Definition at line 33 of file axes.cpp.
ogre_tools::Axes::~Axes |
( |
|
) |
[virtual] |
ogre_tools::Axes::Axes |
( |
const Axes & |
other |
) |
[inline, private] |
Member Function Documentation
const Ogre::ColourValue & ogre_tools::Axes::getDefaultXColor |
( |
|
) |
[static] |
const Ogre::ColourValue & ogre_tools::Axes::getDefaultYColor |
( |
|
) |
[static] |
const Ogre::ColourValue & ogre_tools::Axes::getDefaultZColor |
( |
|
) |
[static] |
const Ogre::Quaternion & ogre_tools::Axes::getOrientation |
( |
|
) |
[virtual] |
const Ogre::Vector3 & ogre_tools::Axes::getPosition |
( |
|
) |
[virtual] |
Ogre::SceneNode* ogre_tools::Axes::getSceneNode |
( |
|
) |
[inline] |
Get the scene node associated with this object.
- Returns:
- The scene node associated with this object
Definition at line 90 of file axes.h.
Shape* ogre_tools::Axes::getXShape |
( |
|
) |
[inline] |
Shape* ogre_tools::Axes::getYShape |
( |
|
) |
[inline] |
Shape* ogre_tools::Axes::getZShape |
( |
|
) |
[inline] |
Axes& ogre_tools::Axes::operator= |
( |
const Axes & |
other |
) |
[inline, private] |
void ogre_tools::Axes::set |
( |
float |
length, |
|
|
float |
radius | |
|
) |
| | |
Set the parameters on this object.
- Parameters:
-
| length | Length of the axes |
| radius | Radius of the axes |
Definition at line 59 of file axes.cpp.
void ogre_tools::Axes::setColor |
( |
float |
r, |
|
|
float |
g, |
|
|
float |
b, |
|
|
float |
a | |
|
) |
| | [virtual] |
Set the color of the object. Values are in the range [0, 1].
- Parameters:
-
| r | Red component |
| g | Green component |
| b | Blue component |
- Todo:
- should anything be done here?
Implements ogre_tools::Object.
Definition at line 89 of file axes.cpp.
void ogre_tools::Axes::setOrientation |
( |
const Ogre::Quaternion & |
orientation |
) |
[virtual] |
Set the orientation of the object.
- Parameters:
-
| Orientation | quaternion orientation to set to. |
Implements ogre_tools::Object.
Definition at line 79 of file axes.cpp.
void ogre_tools::Axes::setPosition |
( |
const Ogre::Vector3 & |
position |
) |
[virtual] |
Set the position of this object.
- Parameters:
-
| Position | vector position to set to. |
Implements ogre_tools::Object.
Definition at line 74 of file axes.cpp.
void ogre_tools::Axes::setScale |
( |
const Ogre::Vector3 & |
scale |
) |
[virtual] |
Set the scale of the object. Always relative to the identity orientation of the object.
- Parameters:
-
| Scale | vector scale to set to. |
Implements ogre_tools::Object.
Definition at line 84 of file axes.cpp.
void ogre_tools::Axes::setToDefaultColors |
( |
|
) |
|
void ogre_tools::Axes::setUserData |
( |
const Ogre::Any & |
data |
) |
[virtual] |
void ogre_tools::Axes::setXColor |
( |
const Ogre::ColourValue & |
col |
) |
|
void ogre_tools::Axes::setYColor |
( |
const Ogre::ColourValue & |
col |
) |
|
void ogre_tools::Axes::setZColor |
( |
const Ogre::ColourValue & |
col |
) |
|
Member Data Documentation
Cylinder for the X-axis.
Definition at line 117 of file axes.h.
Cylinder for the Y-axis.
Definition at line 118 of file axes.h.
Cylinder for the Z-axis.
Definition at line 119 of file axes.h.
The documentation for this class was generated from the following files: