All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for gazebo::gui::BuildingModelManip:
Collaboration graph
[legend]

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...
 
BuildingModelManipGetAttachedManip (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...
 
BuildingModelManipGetParent () 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]_manipmanip 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]_manipmanip to be detached.
BuildingModelManip* gazebo::gui::BuildingModelManip::GetAttachedManip ( unsigned int  _index) const

Get a child manip by index.

Parameters
[in]_indexIndex 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]_indexIndex 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]_parentParent manip
void gazebo::gui::BuildingModelManip::SetMaker ( BuildingMaker _maker)

Set the maker that the manip is managed by.

Parameters
[in]_makerMaker that manages the manip.
void gazebo::gui::BuildingModelManip::SetName ( const std::string &  _name)

Set the name of the manip object.

Parameters
[in]_nameName 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]_xX position in pixel coordinates.
[in]_yY position in pixel coordinates.
[in]_zZ position in pixel coordinates.
[in]_rollRoll rotation in degrees.
[in]_pitchPitch rotation in degrees.
[in]_yawYaw rotation in degrees.
void gazebo::gui::BuildingModelManip::SetPosition ( double  _x,
double  _y,
double  _z 
)

Set the position of the manip.

Parameters
[in]_xX position in pixel coordinates.
[in]_yY position in pixel coordinates.
[in]_zZ position in pixel coordinates.
void gazebo::gui::BuildingModelManip::SetRotation ( double  _roll,
double  _pitch,
double  _yaw 
)

Set the rotation of the manip.

Parameters
[in]_rollRoll rotation in degrees.
[in]_pitchPitch rotation in degrees.
[in]_yawYaw rotation in degrees.
void gazebo::gui::BuildingModelManip::SetSize ( double  _width,
double  _depth,
double  _height 
)

Set the size of the manip.

Parameters
[in]_widthWidth in pixels.
[in]_depthDepth in pixels.
[in]_heightHeight pixels.
void gazebo::gui::BuildingModelManip::SetVisual ( const rendering::VisualPtr _visual)

Set the visual this manip manages.

Parameters
[in]_visualA pointer of the visual object.

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