rviz::Object Class Reference

Base class for visible objects, providing a minimal generic interface. More...

#include <object.h>

Inheritance diagram for rviz::Object:

Public Member Functions
virtual const Ogre::Quaternion &	getOrientation ()=0
	Get the local orientation of this object. More...
virtual const Ogre::Vector3 &	getPosition ()=0
	Get the local position of this object. More...
	Object (Ogre::SceneManager *scene_manager)
virtual void	setColor (float r, float g, float b, float a)=0
	Set the color of the object. Values are in the range [0, 1]. More...
virtual void	setOrientation (const Ogre::Quaternion &orientation)=0
	Set the orientation of the object. More...
virtual void	setPosition (const Ogre::Vector3 &position)=0
	Set the position of this object. More...
virtual void	setScale (const Ogre::Vector3 &scale)=0
	Set the scale of the object. Always relative to the identity orientation of the object. More...
virtual void	setUserData (const Ogre::Any &data)=0
	Set the user data on this object. More...
virtual	~Object ()

Protected Attributes
Ogre::SceneManager *	scene_manager_
	Ogre scene manager this object is part of. More...

Detailed Description

Base class for visible objects, providing a minimal generic interface.

Definition at line 47 of file object.h.

Constructor & Destructor Documentation

Object()

rviz::Object::Object

(

Ogre::SceneManager *

scene_manager

)

Parameters

scene_manager

The scene manager this object should be part of.

Definition at line 34 of file object.cpp.

~Object()

virtual rviz::Object::~Object ( )

inlinevirtual

Definition at line 55 of file object.h.

Member Function Documentation

getOrientation()

virtual const Ogre::Quaternion& rviz::Object::getOrientation ( )

pure virtual

Get the local orientation of this object.

Returns

The orientation

Implemented in rviz::CovarianceVisual, rviz::Arrow, rviz::Line, rviz::Shape, rviz::Axes, and rviz::BillboardLine.

getPosition()

virtual const Ogre::Vector3& rviz::Object::getPosition ( )

pure virtual

Get the local position of this object.

Returns

The position

Implemented in rviz::CovarianceVisual, rviz::Arrow, rviz::Line, rviz::Shape, rviz::Axes, and rviz::BillboardLine.

setColor()

virtual void rviz::Object::setColor ( float  r, float  g, float  b, float  a  )

pure virtual

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

Parameters

r	Red component
g	Green component
b	Blue component

Implemented in rviz::CovarianceVisual, rviz::Arrow, rviz::Line, rviz::Axes, rviz::Shape, and rviz::BillboardLine.

setOrientation()

virtual void rviz::Object::setOrientation ( const Ogre::Quaternion &  orientation )

pure virtual

Set the orientation of the object.

Parameters

Orientation

quaternion orientation to set to.

Implemented in rviz::CovarianceVisual, rviz::Arrow, rviz::Shape, rviz::Axes, rviz::BillboardLine, and rviz::Line.

setPosition()

virtual void rviz::Object::setPosition ( const Ogre::Vector3 &  position )

pure virtual

Set the position of this object.

Parameters

Position

vector position to set to.

Implemented in rviz::CovarianceVisual, rviz::Arrow, rviz::Shape, rviz::Axes, rviz::BillboardLine, and rviz::Line.

setScale()

virtual void rviz::Object::setScale ( const Ogre::Vector3 &  scale )

pure virtual

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

Parameters

Scale

vector scale to set to.

Implemented in rviz::Arrow, rviz::Shape, rviz::Axes, rviz::Line, rviz::BillboardLine, and rviz::CovarianceVisual.

setUserData()

virtual void rviz::Object::setUserData ( const Ogre::Any &  data )

pure virtual

Set the user data on this object.

Parameters

data

Implemented in rviz::CovarianceVisual, rviz::Arrow, rviz::Line, rviz::Shape, rviz::Axes, and rviz::BillboardLine.

Member Data Documentation

scene_manager_

Ogre::SceneManager* rviz::Object::scene_manager_

protected

Ogre scene manager this object is part of.

Definition at line 103 of file object.h.

---

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

• object.h
• object.cpp