An object that displays a set of X/Y/Z axes, with X=Red, Y=Green, Z=Blue.
More...
#include <axes.h>
|
| Axes (Ogre::SceneManager *manager, Ogre::SceneNode *parent_node=nullptr, float length=1.0f, float radius=0.1f, float alpha=1.0f) |
| Constructor. More...
|
|
const Ogre::ColourValue & | getDefaultXColor () |
|
const Ogre::ColourValue & | getDefaultYColor () |
|
const Ogre::ColourValue & | getDefaultZColor () |
|
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...
|
|
Shape * | getXShape () |
|
Shape * | getYShape () |
|
Shape * | getZShape () |
|
void | set (float length, float radius, float alpha=1.0f) |
| 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) |
|
void | updateAlpha (float alpha) |
|
| ~Axes () override |
|
| Object (Ogre::SceneManager *scene_manager) |
|
virtual | ~Object () |
|
An object that displays a set of X/Y/Z axes, with X=Red, Y=Green, Z=Blue.
Definition at line 57 of file axes.h.
◆ Axes() [1/2]
rviz::Axes::Axes |
( |
Ogre::SceneManager * |
manager, |
|
|
Ogre::SceneNode * |
parent_node = nullptr , |
|
|
float |
length = 1.0f , |
|
|
float |
radius = 0.1f , |
|
|
float |
alpha = 1.0f |
|
) |
| |
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 |
alpha | Alpha channel value of the axes |
Definition at line 42 of file axes.cpp.
◆ ~Axes()
◆ Axes() [2/2]
rviz::Axes::Axes |
( |
const Axes & |
| ) |
|
|
privatedelete |
◆ getDefaultXColor()
const Ogre::ColourValue & rviz::Axes::getDefaultXColor |
( |
| ) |
|
◆ getDefaultYColor()
const Ogre::ColourValue & rviz::Axes::getDefaultYColor |
( |
| ) |
|
◆ getDefaultZColor()
const Ogre::ColourValue & rviz::Axes::getDefaultZColor |
( |
| ) |
|
◆ getOrientation()
const Ogre::Quaternion & rviz::Axes::getOrientation |
( |
| ) |
|
|
overridevirtual |
Get the local orientation of this object.
- Returns
- The orientation
Implements rviz::Object.
Definition at line 117 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 112 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 96 of file axes.h.
◆ getXShape()
Shape* rviz::Axes::getXShape |
( |
| ) |
|
|
inline |
◆ getYShape()
Shape* rviz::Axes::getYShape |
( |
| ) |
|
|
inline |
◆ getZShape()
Shape* rviz::Axes::getZShape |
( |
| ) |
|
|
inline |
◆ operator=()
Axes& rviz::Axes::operator= |
( |
const Axes & |
| ) |
|
|
privatedelete |
◆ set()
void rviz::Axes::set |
( |
float |
length, |
|
|
float |
radius, |
|
|
float |
alpha = 1.0f |
|
) |
| |
Set the parameters on this object.
- Parameters
-
length | Length of the axes |
radius | Radius of the axes |
alpha | Alpha channel value of the axes |
Definition at line 76 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
-
r | Red component |
g | Green component |
b | Blue component |
Implements rviz::Object.
Definition at line 107 of file axes.cpp.
◆ setOrientation()
void rviz::Axes::setOrientation |
( |
const Ogre::Quaternion & |
orientation | ) |
|
|
overridevirtual |
Set the orientation of the object.
- Parameters
-
Orientation | quaternion orientation to set to. |
Implements rviz::Object.
Definition at line 97 of file axes.cpp.
◆ setPosition()
void rviz::Axes::setPosition |
( |
const Ogre::Vector3 & |
position | ) |
|
|
overridevirtual |
Set the position of this object.
- Parameters
-
Position | vector position to set to. |
Implements rviz::Object.
Definition at line 92 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
-
Scale | vector scale to set to. |
Implements rviz::Object.
Definition at line 102 of file axes.cpp.
◆ setToDefaultColors()
void rviz::Axes::setToDefaultColors |
( |
| ) |
|
◆ setUserData()
void rviz::Axes::setUserData |
( |
const Ogre::Any & |
data | ) |
|
|
overridevirtual |
◆ setXColor()
void rviz::Axes::setXColor |
( |
const Ogre::ColourValue & |
col | ) |
|
◆ setYColor()
void rviz::Axes::setYColor |
( |
const Ogre::ColourValue & |
col | ) |
|
◆ setZColor()
void rviz::Axes::setZColor |
( |
const Ogre::ColourValue & |
col | ) |
|
◆ updateAlpha()
void rviz::Axes::updateAlpha |
( |
float |
alpha | ) |
|
◆ default_x_color_
Ogre::ColourValue rviz::Axes::default_x_color_ |
|
private |
◆ default_y_color_
Ogre::ColourValue rviz::Axes::default_y_color_ |
|
private |
◆ default_z_color_
Ogre::ColourValue rviz::Axes::default_z_color_ |
|
private |
◆ scene_node_
Ogre::SceneNode* rviz::Axes::scene_node_ |
|
private |
◆ x_axis_
Shape* rviz::Axes::x_axis_ |
|
private |
Cylinder for the X-axis.
Definition at line 136 of file axes.h.
◆ y_axis_
Shape* rviz::Axes::y_axis_ |
|
private |
Cylinder for the Y-axis.
Definition at line 137 of file axes.h.
◆ z_axis_
Shape* rviz::Axes::z_axis_ |
|
private |
Cylinder for the Z-axis.
Definition at line 138 of file axes.h.
The documentation for this class was generated from the following files:
rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:10