All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::rendering::SelectionObj Class Reference

A graphical selection object. More...

#include <rendering/rendering.hh>

Public Member Functions

 SelectionObj (Scene *_scene)
 Constructor.
 
virtual ~SelectionObj ()
 Destructor.
 
void Attach (VisualPtr _visual)
 Set the position of the node.
 
void Clear ()
 Clear the rendering::SelectionObj object.
 
std::string GetVisualName () const
 Get the name of the visual the selection obj is attached to.
 
void Init ()
 Initialize the rendering::SelectionObj object.
 
bool IsActive () const
 Return true if the user is move the selection obj.
 
void SetActive (bool _active)
 Set true if the user is moving the selection obj.
 
void SetHighlight (const std::string &_mod)
 Highlight the selection object based on a modifier.
 

Detailed Description

A graphical selection object.

Used to draw a visual around a selected object.

Constructor & Destructor Documentation

gazebo::rendering::SelectionObj::SelectionObj ( Scene _scene)

Constructor.

Parameters
[in]_sceneScene to use.
virtual gazebo::rendering::SelectionObj::~SelectionObj ( )
virtual

Destructor.

Member Function Documentation

void gazebo::rendering::SelectionObj::Attach ( VisualPtr  _visual)

Set the position of the node.

Parameters
[in]Thisdraws the selection object around the passed in visual.
void gazebo::rendering::SelectionObj::Clear ( )

Clear the rendering::SelectionObj object.

std::string gazebo::rendering::SelectionObj::GetVisualName ( ) const

Get the name of the visual the selection obj is attached to.

Returns
Name of the selected visual.
void gazebo::rendering::SelectionObj::Init ( )

Initialize the rendering::SelectionObj object.

bool gazebo::rendering::SelectionObj::IsActive ( ) const

Return true if the user is move the selection obj.

Returns
True if something is selected.
void gazebo::rendering::SelectionObj::SetActive ( bool  _active)

Set true if the user is moving the selection obj.

Parameters
[in]_activeTrue if the user is interacting with the selection object.
void gazebo::rendering::SelectionObj::SetHighlight ( const std::string &  _mod)

Highlight the selection object based on a modifier.

Parameters
[in]_modModifier used when highlighting the selection object.

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