gazebo::gui::BuildingModelManip Class Reference

Manipulate a 3D visual associated to a 2D editor item. More...

#include <BuildingModelManip.hh>

Inheritance diagram for gazebo::gui::BuildingModelManip:

Collaboration diagram for gazebo::gui::BuildingModelManip:

Public Member Functions
	BuildingModelManip ()
	Constructor. More...
virtual	~BuildingModelManip ()
	Destructor. More...
void	AttachManip (BuildingModelManip *_manip)
	Attach a manip as a child to this manip. More...
void	DetachFromParent ()
	Detach this manip from its parent. More...
void	DetachManip (BuildingModelManip *_manip)
	Detach a child manip from this manip. More...
BuildingModelManip *	GetAttachedManip (unsigned int _index) const
	Get a child manip by index. More...
unsigned int	GetAttachedManipCount () const
	Get the number of child manips attached to this manip. More...
std::string	GetName () const
	Get the name of the manip object. More...
BuildingModelManip *	GetParent () const
	Get the parent of this manip. More...
rendering::VisualPtr	GetVisual () const
	Get the visual this manip manages. More...
bool	IsAttached () const
	Get whether or not this manip is attached to another. More...
void	SetAttachedTo (BuildingModelManip *_parent)
	Set the parent manip of this manip. More...
void	SetMaker (BuildingMaker *_maker)
	Set the maker that the manip is managed by. More...
void	SetName (const std::string &_name)
	Set the name of the manip object. More...
void	SetPose (double _x, double _y, double _z, double _roll, double _pitch, double _yaw)
	Set the pose of the manip. More...
void	SetPosition (double _x, double _y, double _z)
	Set the position of the manip. More...
void	SetRotation (double _roll, double _pitch, double _yaw)
	Set the rotation of the manip. More...
void	SetSize (double _width, double _depth, double _height)
	Set the size of the manip. More...
void	SetVisual (const rendering::VisualPtr &_visual)
	Set the visual this manip manages. More...

Detailed Description

Manipulate a 3D visual associated to a 2D editor item.

Constructor & Destructor Documentation

gazebo::gui::BuildingModelManip::BuildingModelManip

(

)

Constructor.

virtual gazebo::gui::BuildingModelManip::~BuildingModelManip ( )

virtual

Destructor.

Member Function Documentation

void gazebo::gui::BuildingModelManip::AttachManip

(

BuildingModelManip *

_manip

)

Attach a manip as a child to this manip.

Parameters

[in]

_manip

manip to be attached.

void gazebo::gui::BuildingModelManip::DetachFromParent

(

)

Detach this manip from its parent.

void gazebo::gui::BuildingModelManip::DetachManip

(

BuildingModelManip *

_manip

)

Detach a child manip from this manip.

Parameters

[in]

_manip

manip to be detached.

BuildingModelManip* gazebo::gui::BuildingModelManip::GetAttachedManip

(

unsigned int

_index

)

const

Get a child manip by index.

Parameters

[in]

_index

Index of the child manip.

Returns

The attached manip at index _index.

unsigned int gazebo::gui::BuildingModelManip::GetAttachedManipCount

(

)

const

Get the number of child manips attached to this manip.

Parameters

[in]

_index

Index of the child manip.

Returns

The number of attached manips.

std::string gazebo::gui::BuildingModelManip::GetName

(

)

const

Get the name of the manip object.

Returns

Name of the manip object.

BuildingModelManip* gazebo::gui::BuildingModelManip::GetParent

(

)

const

Get the parent of this manip.

Returns

Parent manip.

rendering::VisualPtr gazebo::gui::BuildingModelManip::GetVisual

(

)

const

Get the visual this manip manages.

Returns

A pointer to the visual object.

bool gazebo::gui::BuildingModelManip::IsAttached

(

)

const

Get whether or not this manip is attached to another.

Returns

True if attached, false otherwise.

void gazebo::gui::BuildingModelManip::SetAttachedTo

(

BuildingModelManip *

_parent

)

Set the parent manip of this manip.

Parameters

[in]

_parent

Parent manip

void gazebo::gui::BuildingModelManip::SetMaker

(

BuildingMaker *

_maker

)

Set the maker that the manip is managed by.

Parameters

[in]

_maker

Maker that manages the manip.

void gazebo::gui::BuildingModelManip::SetName

(

const std::string &

_name

)

Set the name of the manip object.

Parameters

[in]

_name

Name to set the manip to.

void gazebo::gui::BuildingModelManip::SetPose	(	double	_x,
		double	_y,
		double	_z,
		double	_roll,
		double	_pitch,
		double	_yaw
	)

Set the pose of the manip.

Parameters

[in]	_x	X position in pixel coordinates.
[in]	_y	Y position in pixel coordinates.
[in]	_z	Z position in pixel coordinates.
[in]	_roll	Roll rotation in degrees.
[in]	_pitch	Pitch rotation in degrees.
[in]	_yaw	Yaw rotation in degrees.

void gazebo::gui::BuildingModelManip::SetPosition	(	double	_x,
		double	_y,
		double	_z
	)

Set the position of the manip.

Parameters

[in]	_x	X position in pixel coordinates.
[in]	_y	Y position in pixel coordinates.
[in]	_z	Z position in pixel coordinates.

void gazebo::gui::BuildingModelManip::SetRotation	(	double	_roll,
		double	_pitch,
		double	_yaw
	)

Set the rotation of the manip.

Parameters

[in]	_roll	Roll rotation in degrees.
[in]	_pitch	Pitch rotation in degrees.
[in]	_yaw	Yaw rotation in degrees.

void gazebo::gui::BuildingModelManip::SetSize	(	double	_width,
		double	_depth,
		double	_height
	)

Set the size of the manip.

Parameters

[in]	_width	Width in pixels.
[in]	_depth	Depth in pixels.
[in]	_height	Height pixels.

void gazebo::gui::BuildingModelManip::SetVisual

(

const rendering::VisualPtr &

_visual

)

Set the visual this manip manages.

Parameters

[in]

_visual

A pointer of the visual object.

---

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

• BuildingModelManip.hh