rviz::Robot Class Reference

#include <robot.h>

List of all members.

Public Member Functions

void clear ()
 Clears all data loaded from a URDF.
float getAlpha ()
Ogre::SceneNode * getCollisionNode ()
RobotLinkgetLink (const std::string &name)
const std::string & getName ()
virtual const Ogre::Quaternion & getOrientation ()
Ogre::SceneNode * getOtherNode ()
virtual const Ogre::Vector3 & getPosition ()
Ogre::SceneNode * getVisualNode ()
bool isCollisionVisible ()
 Returns whether or not the collision representation is set to be visible.
bool isVisualVisible ()
 Returns whether or not the visual representation is set to be visible.
void load (TiXmlElement *root_element, urdf::Model &descr, bool visual=true, bool collision=true)
 Loads meshes/primitives from a robot description. Calls clear() before loading.
 Robot (DisplayContext *context, const std::string &name, Property *parent_property)
void setAlpha (float a)
void setCollisionVisible (bool visible)
 Set whether the collision meshes/primitives of the robot should be visible.
virtual void setOrientation (const Ogre::Quaternion &orientation)
virtual void setPosition (const Ogre::Vector3 &position)
virtual void setScale (const Ogre::Vector3 &scale)
void setVisible (bool visible)
 Set the robot as a whole to be visible or not.
void setVisualVisible (bool visible)
 Set whether the visual meshes of the robot should be visible.
void update (const LinkUpdater &updater)
 ~Robot ()

Protected Types

typedef std::map< std::string,
RobotLink * > 
M_NameToLink

Protected Member Functions

void updateLinkVisibilities ()
 Call RobotLink::updateVisibility() on each link.

Protected Attributes

float alpha_
bool collision_visible_
 Should we show the collision representation?
DisplayContextcontext_
M_NameToLink links_
 Map of name to link info, stores all loaded links.
Propertylinks_category_
std::string name_
Ogre::SceneNode * root_collision_node_
 Node all our collision nodes are children of.
Ogre::SceneNode * root_other_node_
Ogre::SceneNode * root_visual_node_
 Node all our visual nodes are children of.
Ogre::SceneManager * scene_manager_
bool visual_visible_
 Should we show the visual representation?

Detailed Description

A helper class to draw a representation of a robot, as specified by a URDF. Can display either the visual models of the robot, or the collision models.

Definition at line 90 of file robot.h.


Member Typedef Documentation

typedef std::map< std::string, RobotLink* > rviz::Robot::M_NameToLink [protected]

Definition at line 162 of file robot.h.


Constructor & Destructor Documentation

rviz::Robot::Robot ( DisplayContext context,
const std::string &  name,
Property parent_property 
)

Definition at line 34 of file robot.cpp.

rviz::Robot::~Robot (  ) 

Definition at line 53 of file robot.cpp.


Member Function Documentation

void rviz::Robot::clear (  ) 

Clears all data loaded from a URDF.

Definition at line 123 of file robot.cpp.

float rviz::Robot::getAlpha (  )  [inline]

Definition at line 140 of file robot.h.

Ogre::SceneNode* rviz::Robot::getCollisionNode (  )  [inline]

Definition at line 147 of file robot.h.

RobotLink * rviz::Robot::getLink ( const std::string &  name  ) 

Definition at line 184 of file robot.cpp.

const std::string& rviz::Robot::getName ( void   )  [inline]

Definition at line 144 of file robot.h.

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

Definition at line 246 of file robot.cpp.

Ogre::SceneNode* rviz::Robot::getOtherNode (  )  [inline]

Definition at line 148 of file robot.h.

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

Definition at line 241 of file robot.cpp.

Ogre::SceneNode* rviz::Robot::getVisualNode (  )  [inline]

Definition at line 146 of file robot.h.

bool rviz::Robot::isCollisionVisible (  ) 

Returns whether or not the collision representation is set to be visible.

Definition at line 104 of file robot.cpp.

bool rviz::Robot::isVisualVisible (  ) 

Returns whether or not the visual representation is set to be visible.

Definition at line 99 of file robot.cpp.

void rviz::Robot::load ( TiXmlElement *  root_element,
urdf::Model &  descr,
bool  visual = true,
bool  collision = true 
)

Loads meshes/primitives from a robot description. Calls clear() before loading.

Parameters:
descr The robot description to read from
visual Whether or not to load the visual representation
collision Whether or not to load the collision representation

Definition at line 148 of file robot.cpp.

void rviz::Robot::setAlpha ( float  a  ) 

Definition at line 109 of file robot.cpp.

void rviz::Robot::setCollisionVisible ( bool  visible  ) 

Set whether the collision meshes/primitives of the robot should be visible.

Parameters:
visible Whether the collision meshes/primitives should be visible

Definition at line 82 of file robot.cpp.

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

Definition at line 229 of file robot.cpp.

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

Definition at line 223 of file robot.cpp.

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

Definition at line 235 of file robot.cpp.

void rviz::Robot::setVisible ( bool  visible  ) 

Set the robot as a whole to be visible or not.

Parameters:
visible Should we be visible?

Definition at line 62 of file robot.cpp.

void rviz::Robot::setVisualVisible ( bool  visible  ) 

Set whether the visual meshes of the robot should be visible.

Parameters:
visible Whether the visual meshes of the robot should be visible

Definition at line 76 of file robot.cpp.

void rviz::Robot::update ( const LinkUpdater updater  ) 

Definition at line 196 of file robot.cpp.

void rviz::Robot::updateLinkVisibilities (  )  [protected]

Call RobotLink::updateVisibility() on each link.

Definition at line 88 of file robot.cpp.


Member Data Documentation

float rviz::Robot::alpha_ [protected]

Definition at line 176 of file robot.h.

Should we show the collision representation?

Definition at line 170 of file robot.h.

Definition at line 172 of file robot.h.

Map of name to link info, stores all loaded links.

Definition at line 163 of file robot.h.

Definition at line 173 of file robot.h.

std::string rviz::Robot::name_ [protected]

Definition at line 175 of file robot.h.

Ogre::SceneNode* rviz::Robot::root_collision_node_ [protected]

Node all our collision nodes are children of.

Definition at line 166 of file robot.h.

Ogre::SceneNode* rviz::Robot::root_other_node_ [protected]

Definition at line 167 of file robot.h.

Ogre::SceneNode* rviz::Robot::root_visual_node_ [protected]

Node all our visual nodes are children of.

Definition at line 165 of file robot.h.

Ogre::SceneManager* rviz::Robot::scene_manager_ [protected]

Definition at line 160 of file robot.h.

bool rviz::Robot::visual_visible_ [protected]

Should we show the visual representation?

Definition at line 169 of file robot.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