Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
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]

Public Member Functions

 Axes (Ogre::SceneManager *manager, Ogre::SceneNode *parent_node=nullptr, float length=1.0f, float radius=0.1f)
 Constructor. More...
 
const Ogre::Quaternion & getOrientation () override
 Get the local orientation of this object. More...
 
const Ogre::Vector3 & getPosition () override
 Get the local position of this object. More...
 
Ogre::SceneNode * getSceneNode ()
 Get the scene node associated with this object. More...
 
ShapegetXShape ()
 
ShapegetYShape ()
 
ShapegetZShape ()
 
void set (float length, float radius)
 Set the parameters on this object. More...
 
void setColor (float r, float g, float b, float a) override
 Set the color of the object. Values are in the range [0, 1]. More...
 
void setOrientation (const Ogre::Quaternion &orientation) override
 Set the orientation of the object. More...
 
void setPosition (const Ogre::Vector3 &position) override
 Set the position of this object. More...
 
void setScale (const Ogre::Vector3 &scale) override
 Set the scale of the object. Always relative to the identity orientation of the object. More...
 
void setToDefaultColors ()
 
void setUserData (const Ogre::Any &data) override
 Sets user data on all ogre objects we own. More...
 
void setXColor (const Ogre::ColourValue &col)
 
void setYColor (const Ogre::ColourValue &col)
 
void setZColor (const Ogre::ColourValue &col)
 
 ~Axes () override
 
- Public Member Functions inherited from rviz::Object
 Object (Ogre::SceneManager *scene_manager)
 
virtual ~Object ()
 

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 &)=delete
 
Axesoperator= (const Axes &)=delete
 

Private Attributes

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

Static Private Attributes

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

Additional Inherited Members

- Protected Attributes inherited from rviz::Object
Ogre::SceneManager * scene_manager_
 Ogre scene manager this object is part of. More...
 

Detailed Description

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

Definition at line 59 of file axes.h.

Constructor & Destructor Documentation

◆ Axes() [1/2]

rviz::Axes::Axes ( Ogre::SceneManager *  manager,
Ogre::SceneNode *  parent_node = nullptr,
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 42 of file axes.cpp.

◆ ~Axes()

rviz::Axes::~Axes ( )
override

Definition at line 59 of file axes.cpp.

◆ Axes() [2/2]

rviz::Axes::Axes ( const Axes )
privatedelete

Member Function Documentation

◆ getDefaultXColor()

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

Definition at line 146 of file axes.cpp.

◆ getDefaultYColor()

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

Definition at line 151 of file axes.cpp.

◆ getDefaultZColor()

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

Definition at line 156 of file axes.cpp.

◆ getOrientation()

const Ogre::Quaternion & rviz::Axes::getOrientation ( )
overridevirtual

Get the local orientation of this object.

Returns
The orientation

Implements rviz::Object.

Definition at line 108 of file axes.cpp.

◆ getPosition()

const Ogre::Vector3 & rviz::Axes::getPosition ( )
overridevirtual

Get the local position of this object.

Returns
The position

Implements rviz::Object.

Definition at line 103 of file axes.cpp.

◆ getSceneNode()

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 95 of file axes.h.

◆ getXShape()

Shape* rviz::Axes::getXShape ( )
inline

Definition at line 105 of file axes.h.

◆ getYShape()

Shape* rviz::Axes::getYShape ( )
inline

Definition at line 109 of file axes.h.

◆ getZShape()

Shape* rviz::Axes::getZShape ( )
inline

Definition at line 113 of file axes.h.

◆ operator=()

Axes& rviz::Axes::operator= ( const Axes )
privatedelete

◆ set()

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 68 of file axes.cpp.

◆ setColor()

void rviz::Axes::setColor ( float  r,
float  g,
float  b,
float  a 
)
overridevirtual

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

Parameters
rRed component
gGreen component
bBlue component

Implements rviz::Object.

Definition at line 98 of file axes.cpp.

◆ setOrientation()

void rviz::Axes::setOrientation ( const Ogre::Quaternion &  orientation)
overridevirtual

Set the orientation of the object.

Parameters
Orientationquaternion orientation to set to.

Implements rviz::Object.

Definition at line 88 of file axes.cpp.

◆ setPosition()

void rviz::Axes::setPosition ( const Ogre::Vector3 &  position)
overridevirtual

Set the position of this object.

Parameters
Positionvector position to set to.

Implements rviz::Object.

Definition at line 83 of file axes.cpp.

◆ setScale()

void rviz::Axes::setScale ( const Ogre::Vector3 &  scale)
overridevirtual

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 93 of file axes.cpp.

◆ setToDefaultColors()

void rviz::Axes::setToDefaultColors ( )

Definition at line 135 of file axes.cpp.

◆ setUserData()

void rviz::Axes::setUserData ( const Ogre::Any &  data)
overridevirtual

Sets user data on all ogre objects we own.

Implements rviz::Object.

Definition at line 113 of file axes.cpp.

◆ setXColor()

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

Definition at line 120 of file axes.cpp.

◆ setYColor()

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

Definition at line 125 of file axes.cpp.

◆ setZColor()

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

Definition at line 130 of file axes.cpp.

Member Data Documentation

◆ default_x_color_

const Ogre::ColourValue rviz::Axes::default_x_color_
staticprivate

Definition at line 137 of file axes.h.

◆ default_y_color_

const Ogre::ColourValue rviz::Axes::default_y_color_
staticprivate

Definition at line 138 of file axes.h.

◆ default_z_color_

const Ogre::ColourValue rviz::Axes::default_z_color_
staticprivate

Definition at line 139 of file axes.h.

◆ scene_node_

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

Definition at line 131 of file axes.h.

◆ x_axis_

Shape* rviz::Axes::x_axis_
private

Cylinder for the X-axis.

Definition at line 133 of file axes.h.

◆ y_axis_

Shape* rviz::Axes::y_axis_
private

Cylinder for the Y-axis.

Definition at line 134 of file axes.h.

◆ z_axis_

Shape* rviz::Axes::z_axis_
private

Cylinder for the Z-axis.

Definition at line 135 of file axes.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:17