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

Draws a wireframe box. More...

#include <rendering/rendering.hh>

Public Member Functions

 WireBox (VisualPtr _parent, const math::Box &_box)
 Constructor. More...
 
 ~WireBox ()
 Destructor. More...
 
math::Box GetBox () const
 Get the wireframe box. More...
 
bool GetVisible () const
 Get the visibility of the box. More...
 
void Init (const math::Box &_box)
 Builds the wireframe line list. More...
 
void SetVisible (bool _visible)
 Set the visibility of the box. More...
 

Detailed Description

Draws a wireframe box.

Constructor & Destructor Documentation

gazebo::rendering::WireBox::WireBox ( VisualPtr  _parent,
const math::Box _box 
)
explicit

Constructor.

Parameters
[in]_boxDimension of the box to draw.
[in]_parentParent visual of the box.
gazebo::rendering::WireBox::~WireBox ( )

Destructor.

Member Function Documentation

math::Box gazebo::rendering::WireBox::GetBox ( ) const

Get the wireframe box.

Returns
The wireframe box.
bool gazebo::rendering::WireBox::GetVisible ( ) const

Get the visibility of the box.

Returns
True if the box is visual.
void gazebo::rendering::WireBox::Init ( const math::Box _box)

Builds the wireframe line list.

Parameters
[in]_boxBox to build a wireframe from.
void gazebo::rendering::WireBox::SetVisible ( bool  _visible)

Set the visibility of the box.

Parameters
[in]_visibleTrue to make the box visible, False to hide.

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