Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
rviz::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>

Inheritance diagram for rviz::Axes:
Inheritance graph
[legend]

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.
ShapegetXShape ()
ShapegetYShape ()
ShapegetZShape ()
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)
Axesoperator= (const Axes &other)

Private Attributes

Ogre::SceneNode * scene_node_
Shapex_axis_
 Cylinder for the X-axis.
Shapey_axis_
 Cylinder for the Y-axis.
Shapez_axis_
 Cylinder for the Z-axis.

Static Private Attributes

static const Ogre::ColourValue default_x_color_
static const Ogre::ColourValue default_y_color_
static const Ogre::ColourValue default_z_color_

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

rviz::Axes::Axes ( Ogre::SceneManager *  manager,
Ogre::SceneNode *  parent_node = NULL,
float  length = 1.0f,
float  radius = 0.1f 
)

Constructor.

Parameters:
managerScene manager this object is a part of
parent_nodeA scene node to use as the parent of this object. If NULL, uses the root scene node.
lengthLength of the axes
radiusRadius of the axes

Definition at line 43 of file axes.cpp.

rviz::Axes::~Axes ( ) [virtual]

Definition at line 60 of file axes.cpp.

rviz::Axes::Axes ( const Axes other) [inline, private]

Definition at line 112 of file axes.h.


Member Function Documentation

const Ogre::ColourValue & rviz::Axes::getDefaultXColor ( ) [static]

Definition at line 148 of file axes.cpp.

const Ogre::ColourValue & rviz::Axes::getDefaultYColor ( ) [static]

Definition at line 153 of file axes.cpp.

const Ogre::ColourValue & rviz::Axes::getDefaultZColor ( ) [static]

Definition at line 158 of file axes.cpp.

const Ogre::Quaternion & rviz::Axes::getOrientation ( ) [virtual]

Get the local orientation of this object.

Returns:
The orientation

Implements rviz::Object.

Definition at line 110 of file axes.cpp.

const Ogre::Vector3 & rviz::Axes::getPosition ( ) [virtual]

Get the local position of this object.

Returns:
The position

Implements rviz::Object.

Definition at line 105 of file axes.cpp.

Ogre::SceneNode* rviz::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.

Definition at line 97 of file axes.h.

Definition at line 98 of file axes.h.

Definition at line 99 of file axes.h.

Axes& rviz::Axes::operator= ( const Axes other) [inline, private]

Definition at line 113 of file axes.h.

void rviz::Axes::set ( float  length,
float  radius 
)

Set the parameters on this object.

Parameters:
lengthLength of the axes
radiusRadius of the axes

Definition at line 69 of file axes.cpp.

void rviz::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:
rRed component
gGreen component
bBlue component
Todo:
should anything be done here?

Implements rviz::Object.

Definition at line 99 of file axes.cpp.

void rviz::Axes::setOrientation ( const Ogre::Quaternion &  orientation) [virtual]

Set the orientation of the object.

Parameters:
Orientationquaternion orientation to set to.

Implements rviz::Object.

Definition at line 89 of file axes.cpp.

void rviz::Axes::setPosition ( const Ogre::Vector3 &  position) [virtual]

Set the position of this object.

Parameters:
Positionvector position to set to.

Implements rviz::Object.

Definition at line 84 of file axes.cpp.

void rviz::Axes::setScale ( const Ogre::Vector3 &  scale) [virtual]

Set the scale of the object. Always relative to the identity orientation of the object.

Parameters:
Scalevector scale to set to.

Implements rviz::Object.

Definition at line 94 of file axes.cpp.

Definition at line 137 of file axes.cpp.

void rviz::Axes::setUserData ( const Ogre::Any &  data) [virtual]

Sets user data on all ogre objects we own.

Implements rviz::Object.

Definition at line 115 of file axes.cpp.

void rviz::Axes::setXColor ( const Ogre::ColourValue &  col)

Definition at line 122 of file axes.cpp.

void rviz::Axes::setYColor ( const Ogre::ColourValue &  col)

Definition at line 127 of file axes.cpp.

void rviz::Axes::setZColor ( const Ogre::ColourValue &  col)

Definition at line 132 of file axes.cpp.


Member Data Documentation

const Ogre::ColourValue rviz::Axes::default_x_color_ [static, private]

Definition at line 121 of file axes.h.

const Ogre::ColourValue rviz::Axes::default_y_color_ [static, private]

Definition at line 122 of file axes.h.

const Ogre::ColourValue rviz::Axes::default_z_color_ [static, private]

Definition at line 123 of file axes.h.

Ogre::SceneNode* rviz::Axes::scene_node_ [private]

Definition at line 115 of file axes.h.

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:


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Mon Jan 6 2014 11:54:33