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:

Public Member Functions
	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

Public Member Functions inherited from rviz::Object
	Object (Ogre::SceneManager *scene_manager)

virtual	~Object ()

Private Member Functions
	Axes (const Axes &)=delete

Axes &	operator= (const Axes &)=delete

Private Attributes
Ogre::ColourValue	default_x_color_

Ogre::ColourValue	default_y_color_

Ogre::ColourValue	default_z_color_

Ogre::SceneNode *	scene_node_

Shape *	x_axis_
	Cylinder for the X-axis. More...

Shape *	y_axis_
	Cylinder for the Y-axis. More...

Shape *	z_axis_
	Cylinder for the Z-axis. More...

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 57 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`,
		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()

rviz::Axes::~Axes ( )

override

Definition at line 67 of file axes.cpp.

◆ Axes() [2/2]

rviz::Axes::Axes ( const Axes & )

privatedelete

Member Function Documentation

◆ getDefaultXColor()

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

Definition at line 158 of file axes.cpp.

◆ getDefaultYColor()

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

Definition at line 163 of file axes.cpp.

◆ getDefaultZColor()

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

Definition at line 168 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 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

Definition at line 106 of file axes.h.

◆ getYShape()

Shape* rviz::Axes::getYShape ( )

inline

Definition at line 110 of file axes.h.

◆ getZShape()

Shape* rviz::Axes::getZShape ( )

inline

Definition at line 114 of file axes.h.

◆ 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 ( )

Definition at line 151 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 122 of file axes.cpp.

◆ setXColor()

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

Definition at line 129 of file axes.cpp.

◆ setYColor()

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

Definition at line 134 of file axes.cpp.

◆ setZColor()

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

Definition at line 139 of file axes.cpp.

◆ updateAlpha()

void rviz::Axes::updateAlpha ( float alpha )

Definition at line 144 of file axes.cpp.

Member Data Documentation

◆ default_x_color_

Ogre::ColourValue rviz::Axes::default_x_color_

private

Definition at line 140 of file axes.h.

◆ default_y_color_

Ogre::ColourValue rviz::Axes::default_y_color_

private

Definition at line 141 of file axes.h.

◆ default_z_color_

Ogre::ColourValue rviz::Axes::default_z_color_

private

Definition at line 142 of file axes.h.

◆ scene_node_

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

private

Definition at line 134 of file axes.h.

◆ 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:

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Axes() [1/2]

◆ ~Axes()

◆ Axes() [2/2]

Member Function Documentation

◆ getDefaultXColor()

◆ getDefaultYColor()

◆ getDefaultZColor()

◆ getOrientation()

◆ getPosition()

◆ getSceneNode()

◆ getXShape()

◆ getYShape()

◆ getZShape()

◆ operator=()

◆ set()

◆ setColor()

◆ setOrientation()

◆ setPosition()

◆ setScale()

◆ setToDefaultColors()

◆ setUserData()

◆ setXColor()

◆ setYColor()

◆ setZColor()

◆ updateAlpha()

Member Data Documentation

◆ default_x_color_

◆ default_y_color_

◆ default_z_color_

◆ scene_node_

◆ x_axis_

◆ y_axis_

◆ z_axis_