Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
rviz::Shape Class Reference

#include <shape.h>

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

List of all members.

Public Types

enum  Type { Cone, Cube, Cylinder, Sphere }

Public Member Functions

Ogre::Entity * getEntity ()
virtual const Ogre::Quaternion & getOrientation ()
 Get the local orientation of this object.
virtual const Ogre::Vector3 & getPosition ()
 Get the local position of this object.
Ogre::SceneNode * getRootNode ()
 Get the root scene node (pivot node) for this object.
Type getType ()
virtual void setColor (float r, float g, float b, float a)
 Set the color of the object. Values are in the range [0, 1].
void setColor (const Ogre::ColourValue &c)
void setOffset (const Ogre::Vector3 &offset)
 Set the offset for this shape.
virtual void setOrientation (const Ogre::Quaternion &orientation)
 Set the orientation of the object.
virtual void setPosition (const Ogre::Vector3 &position)
 Set the position of this object.
virtual void setScale (const Ogre::Vector3 &scale)
 Set the scale of the object. Always relative to the identity orientation of the object.
void setUserData (const Ogre::Any &data)
 Sets user data on all ogre objects we own.
 Shape (Type shape_type, Ogre::SceneManager *scene_manager, Ogre::SceneNode *parent_node=NULL)
 Constructor.
virtual ~Shape ()

Static Public Member Functions

static Ogre::Entity * createEntity (const std::string &name, Type shape_type, Ogre::SceneManager *scene_manager)

Private Attributes

Ogre::Entity * entity_
Ogre::MaterialPtr material_
std::string material_name_
Ogre::SceneNode * offset_node_
Ogre::SceneNode * scene_node_
Type type_

Detailed Description

Definition at line 51 of file shape.h.


Member Enumeration Documentation

Enumerator:
Cone 
Cube 
Cylinder 
Sphere 

Definition at line 54 of file shape.h.


Constructor & Destructor Documentation

rviz::Shape::Shape ( Type  shape_type,
Ogre::SceneManager *  scene_manager,
Ogre::SceneNode *  parent_node = NULL 
)

Constructor.

Parameters:
scene_managerThe scene manager this object is associated with
parent_nodeA scene node to use as the parent of this object. If NULL, uses the root scene node.

Definition at line 73 of file shape.cpp.

rviz::Shape::~Shape ( ) [virtual]

Definition at line 106 of file shape.cpp.


Member Function Documentation

Ogre::Entity * rviz::Shape::createEntity ( const std::string &  name,
Type  shape_type,
Ogre::SceneManager *  scene_manager 
) [static]

Definition at line 45 of file shape.cpp.

Ogre::Entity* rviz::Shape::getEntity ( ) [inline]

Definition at line 102 of file shape.h.

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

Get the local orientation of this object.

Returns:
The orientation

Implements rviz::Object.

Definition at line 174 of file shape.cpp.

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

Get the local position of this object.

Returns:
The position

Implements rviz::Object.

Definition at line 169 of file shape.cpp.

Ogre::SceneNode* rviz::Shape::getRootNode ( ) [inline]

Get the root scene node (pivot node) for this object.

Returns:
The root scene node of this object

Definition at line 95 of file shape.h.

Type rviz::Shape::getType ( ) [inline]

Definition at line 71 of file shape.h.

void rviz::Shape::setColor ( float  r,
float  g,
float  b,
float  a 
) [virtual]

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 144 of file shape.cpp.

void rviz::Shape::setColor ( const Ogre::ColourValue &  c)

Definition at line 127 of file shape.cpp.

void rviz::Shape::setOffset ( const Ogre::Vector3 &  offset)

Set the offset for this shape.

The default is no offset, which puts the pivot point directly in the center of the object.

Parameters:
offsetAmount to offset the center of the object from the pivot point

Definition at line 149 of file shape.cpp.

void rviz::Shape::setOrientation ( const Ogre::Quaternion &  orientation) [virtual]

Set the orientation of the object.

Parameters:
Orientationquaternion orientation to set to.

Implements rviz::Object.

Definition at line 159 of file shape.cpp.

void rviz::Shape::setPosition ( const Ogre::Vector3 &  position) [virtual]

Set the position of this object.

Parameters:
Positionvector position to set to.

Implements rviz::Object.

Definition at line 154 of file shape.cpp.

void rviz::Shape::setScale ( const Ogre::Vector3 &  scale) [virtual]

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 164 of file shape.cpp.

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

Sets user data on all ogre objects we own.

Implements rviz::Object.

Definition at line 179 of file shape.cpp.


Member Data Documentation

Ogre::Entity* rviz::Shape::entity_ [private]

Definition at line 109 of file shape.h.

Ogre::MaterialPtr rviz::Shape::material_ [private]

Definition at line 110 of file shape.h.

std::string rviz::Shape::material_name_ [private]

Definition at line 111 of file shape.h.

Ogre::SceneNode* rviz::Shape::offset_node_ [private]

Definition at line 108 of file shape.h.

Ogre::SceneNode* rviz::Shape::scene_node_ [private]

Definition at line 107 of file shape.h.

Definition at line 113 of file shape.h.


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


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Mon Jan 6 2014 11:54:34