WireBox Class Reference

Draws a wireframe box. More...

#include <rendering/rendering.hh>

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

Detailed Description

Draws a wireframe box.

Constructor & Destructor Documentation

WireBox ( VisualPtr  _parent, const math::Box &  _box  )

explicit

Constructor.

Parameters

[in]	_box	Dimension of the box to draw.
[in]	_parent	Parent visual of the box.

Deprecated:

See function that takes ignition::math

WireBox ( VisualPtr  _parent, const ignition::math::Box &  _box  )

explicit

Constructor.

Parameters

[in]	_box	Dimension of the box to draw.
[in]	_parent	Parent visual of the box.

~WireBox

(

)

Destructor.

Member Function Documentation

ignition::math::Box Box

(

)

const

Get the wireframe box.

Returns

The wireframe box.

math::Box GetBox

(

)

const

Get the wireframe box.

Returns

The wireframe box.

Deprecated:

See function that returns ignition::math

bool GetVisible

(

)

const

Get the visibility of the box.

Returns

True if the box is visual.

Deprecated:

See Visible()

void Init

(

const math::Box &

_box

)

Builds the wireframe line list.

Parameters

[in]

_box

Box to build a wireframe from.

Deprecated:

See function that takes ignition::math

void Init

(

const ignition::math::Box &

_box

)

Builds the wireframe line list.

Parameters

[in]

_box

Box to build a wireframe from.

void SetVisible

(

bool

_visible

)

Set the visibility of the box.

Parameters

[in]

_visible

True to make the box visible, False to hide.

bool Visible

(

)

const

Get the visibility of the box.

Returns

True if the box is visual.

---

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

• WireBox.hh