Class Axes

Inheritance Relationships

Base Type

Class Documentation

class Axes : public rviz_rendering::Object

An object that displays a set of X/Y/Z axes, with X=Red, Y=Green, Z=Blue.

Public Functions

explicit RVIZ_RENDERING_PUBLIC Axes(Ogre::SceneManager *manager, Ogre::SceneNode *parent_node = nullptr, 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

~Axes() override
RVIZ_RENDERING_PUBLIC void set (float length, float radius)

Set the parameters on this object.

Parameters:

  • length – Length of the axes

  • radius – Radius of the axes

virtual RVIZ_RENDERING_PUBLIC void setOrientation (const Ogre::Quaternion &orientation) override

Set the orientation of the object.

Parameters:

Orientation – quaternion orientation to set to.

virtual RVIZ_RENDERING_PUBLIC void setPosition (const Ogre::Vector3 &position) override

Set the position of this object.

Parameters:

Position – vector position to set to.

virtual RVIZ_RENDERING_PUBLIC void setScale (const Ogre::Vector3 &scale) override

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

Parameters:

Scale – vector scale to set to.

virtual RVIZ_RENDERING_PUBLIC void setColor (float r, float g, float b, float a) override

Set the color of the object. Values are in the range [0, 1].

Parameters:

  • r – Red component

  • g – Green component

  • b – Blue component

virtual RVIZ_RENDERING_PUBLIC const Ogre::Vector3 & getPosition () override

Get the local position of this object.

Returns:

The position

virtual RVIZ_RENDERING_PUBLIC const Ogre::Quaternion & getOrientation () override

Get the local orientation of this object.

Returns:

The orientation

inline Ogre::SceneNode *getSceneNode()

Get the scene node associated with this object.

Returns:

The scene node associated with this object

virtual RVIZ_RENDERING_PUBLIC void setUserData (const Ogre::Any &data) override

Sets user data on all ogre objects we own.

inline RVIZ_RENDERING_PUBLIC Shape & getXShape ()
inline RVIZ_RENDERING_PUBLIC Shape & getYShape ()
inline RVIZ_RENDERING_PUBLIC Shape & getZShape ()
RVIZ_RENDERING_PUBLIC void setXColor (const Ogre::ColourValue &col)
RVIZ_RENDERING_PUBLIC void setYColor (const Ogre::ColourValue &col)
RVIZ_RENDERING_PUBLIC void setZColor (const Ogre::ColourValue &col)
RVIZ_RENDERING_PUBLIC void setToDefaultColors ()

Public Static Functions

static RVIZ_RENDERING_PUBLIC const Ogre::ColourValue & getDefaultXColor ()
static RVIZ_RENDERING_PUBLIC const Ogre::ColourValue & getDefaultYColor ()
static RVIZ_RENDERING_PUBLIC const Ogre::ColourValue & getDefaultZColor ()