rviz::Object Class Reference

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

#include <object.h>

Inheritance diagram for rviz::Object:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual const Ogre::Quaternion & getOrientation ()=0
 Get the local orientation of this object.
virtual const Ogre::Vector3 & getPosition ()=0
 Get the local position of this object.
 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].
virtual void setOrientation (const Ogre::Quaternion &orientation)=0
 Set the orientation of the object.
virtual void setPosition (const Ogre::Vector3 &position)=0
 Set the position of this object.
virtual void setScale (const Ogre::Vector3 &scale)=0
 Set the scale of the object. Always relative to the identity orientation of the object.
virtual void setUserData (const Ogre::Any &data)=0
 Set the user data on this object.
virtual ~Object ()

Protected Attributes

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

Detailed Description

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

Definition at line 49 of file object.h.


Constructor & Destructor Documentation

rviz::Object::Object ( Ogre::SceneManager *  scene_manager  ) 
Parameters:
scene_manager The scene manager this object should be part of.

Definition at line 35 of file object.cpp.

virtual rviz::Object::~Object (  )  [inline, virtual]

Definition at line 57 of file object.h.


Member Function Documentation

virtual const Ogre::Quaternion& rviz::Object::getOrientation (  )  [pure virtual]

Get the local orientation of this object.

Returns:
The orientation

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

virtual const Ogre::Vector3& rviz::Object::getPosition (  )  [pure virtual]

Get the local position of this object.

Returns:
The position

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

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::Arrow, rviz::Axes, rviz::BillboardLine, and rviz::Shape.

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::Arrow, rviz::Axes, rviz::BillboardLine, and rviz::Shape.

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::Arrow, rviz::Axes, rviz::BillboardLine, and rviz::Shape.

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::Axes, rviz::BillboardLine, and rviz::Shape.

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

Set the user data on this object.

Parameters:
data 

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


Member Data Documentation

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Wed Jun 6 11:25:48 2012