Signals | Public Member Functions | Protected Attributes | List of all members
gazebo::gui::EditorItem Class Reference

Base class of an item in the editor. More...

#include <EditorItem.hh>

Inheritance diagram for gazebo::gui::EditorItem:
Inheritance graph
[legend]

Signals

void ColorChanged (QColor _color)
 Qt signal emitted when the editor item's 3D color has changed. More...
 
void DepthChanged (double _depth)
 Qt signal emitted when the editor item depth has changed. More...
 
void HeightChanged (double _height)
 Qt signal emitted when the editor item height has changed. More...
 
void ItemDeleted ()
 Qt signal emitted when the editor item is being deleted. More...
 
void LevelChanged (int _level)
 Qt signal emitted when the editor item's level has changed. More...
 
void PoseChanged (double _x, double _y, double _z, double _roll, double _pitch, double _yaw)
 Qt signal emitted when the editor item pose has changed. More...
 
void PoseOriginTransformed (double _x, double _y, double _z, double _roll, double _pitch, double _yaw)
 Qt signal emitted when the editor item pose origin has changed. More...
 
void PositionChanged (double _x, double _y, double _z)
 Qt signal emitted when the editor item position has changed. More...
 
void PosXChanged (double _posX)
 Qt signal emitted when the editor item's X position has changed. More...
 
void PosYChanged (double _posY)
 Qt signal emitted when the editor item's Y position has changed. More...
 
void PosZChanged (double _posZ)
 Qt signal emitted when the editor item's Z position has changed. More...
 
void RotationChanged (double _roll, double _pitch, double _yaw)
 Qt signal emitted when the editor item rotation has changed. More...
 
void SizeChanged (double _width, double _depth, double _height)
 Qt signal emitted when the editor item size has changed. More...
 
void TextureChanged (QString _texture)
 Qt signal emitted when the editor item's 3D texture has changed. More...
 
void TransparencyChanged (float _transparency)
 Qt signal emitted when the editor item's 3D transparency has changed. More...
 
void WidthChanged (double _width)
 Qt signal emitted when the editor item width has changed. More...
 
void YawChanged (double _yaw)
 Qt signal emitted when the editor item yaw rotation has changed. More...
 

Public Member Functions

 EditorItem ()
 Constructor. More...
 
 ~EditorItem ()
 Destructor. More...
 
virtual QColor Get3dColor () const
 Get the associated 3D visual's color. More...
 
virtual QString Get3dTexture () const
 Get the associated 3D visual's texture. More...
 
int GetLevel () const
 Get the level in which this building item is located. More...
 
double GetLevelBaseHeight () const
 Get the base height of this level relative to the ground plane. More...
 
virtual std::string GetName () const
 Get the name of the editor item. More...
 
virtual QVector3D GetScenePosition () const
 Get the scene position of editor item. More...
 
virtual double GetSceneRotation () const
 Get the scene rotation of the editor item. More...
 
virtual QVector3D GetSize () const
 Get the size of the item in pixels. More...
 
virtual std::string GetType () const
 Get the type of the editor item. More...
 
void Set3dColor (QColor _color)
 Set the associated 3D visual's color. More...
 
void Set3dTexture (QString _texture)
 Set the associated 3D visual's texture. More...
 
void Set3dTransparency (float _transparency)
 Set the transparency of the associated 3D visual. More...
 
virtual void SetHighlighted (bool _highlighted)
 Set whether this item should be highlighted or not. More...
 
void SetLevel (int _level)
 Set the level of this building item. More...
 
void SetLevelBaseHeight (double _height)
 Set the base height of this level relative to the ground plane. More...
 
virtual void SetName (const std::string &_name)
 Set the name of this editor item. More...
 
int ZValueIdle () const
 Get the z value of this item when in idle state. More...
 
int ZValueSelected () const
 Get the z value of this item when in selected state. More...
 

Protected Attributes

std::string editorType
 Type of editor item. More...
 
bool highlighted
 Flag to indicate whether this item is currently highlighted or not. More...
 
double itemScale
 Scale for converting from pixel to metric units. More...
 
int level
 Level that this item is on. More...
 
double levelBaseHeight
 Vertical distance from the building's base to the base of the level this editor is in. More...
 
std::string name
 Name of editor item. More...
 
QColor visual3dColor
 Color of the associated 3D visual. More...
 
QString visual3dTexture
 Texture of the associated 3D visual. More...
 
float visual3dTransparency
 Transparency of the associated 3D visual. More...
 
int zValueIdle
 Z ordering of the rect item when idle (unselected.) More...
 
int zValueSelected
 Z ordering of the rect item when selected. More...
 

Detailed Description

Base class of an item in the editor.

Constructor & Destructor Documentation

gazebo::gui::EditorItem::EditorItem ( )

Constructor.

gazebo::gui::EditorItem::~EditorItem ( )

Destructor.

Member Function Documentation

void gazebo::gui::EditorItem::ColorChanged ( QColor  _color)
signal

Qt signal emitted when the editor item's 3D color has changed.

Parameters
[in]_colorColor.
void gazebo::gui::EditorItem::DepthChanged ( double  _depth)
signal

Qt signal emitted when the editor item depth has changed.

Parameters
[in]_depthDepth of item in pixels.
virtual QColor gazebo::gui::EditorItem::Get3dColor ( ) const
virtual

Get the associated 3D visual's color.

Returns
Color of the 3D visual.
virtual QString gazebo::gui::EditorItem::Get3dTexture ( ) const
virtual

Get the associated 3D visual's texture.

Returns
Texture of the 3D visual.
int gazebo::gui::EditorItem::GetLevel ( ) const

Get the level in which this building item is located.

double gazebo::gui::EditorItem::GetLevelBaseHeight ( ) const

Get the base height of this level relative to the ground plane.

virtual std::string gazebo::gui::EditorItem::GetName ( ) const
virtual

Get the name of the editor item.

Returns
Name of the item.
virtual QVector3D gazebo::gui::EditorItem::GetScenePosition ( ) const
virtual

Get the scene position of editor item.

Returns
Scene position in pixel coordinates.

Reimplemented in gazebo::gui::RectItem, gazebo::gui::SegmentItem, gazebo::gui::FloorItem, gazebo::gui::StairsItem, gazebo::gui::DoorItem, and gazebo::gui::WindowItem.

virtual double gazebo::gui::EditorItem::GetSceneRotation ( ) const
virtual

Get the scene rotation of the editor item.

Returns
Scene rotation in degrees.

Reimplemented in gazebo::gui::RectItem, gazebo::gui::SegmentItem, gazebo::gui::FloorItem, gazebo::gui::StairsItem, gazebo::gui::DoorItem, and gazebo::gui::WindowItem.

virtual QVector3D gazebo::gui::EditorItem::GetSize ( ) const
virtual

Get the size of the item in pixels.

Returns
Size in pixels.

Reimplemented in gazebo::gui::RectItem, gazebo::gui::SegmentItem, gazebo::gui::FloorItem, gazebo::gui::StairsItem, gazebo::gui::DoorItem, and gazebo::gui::WindowItem.

virtual std::string gazebo::gui::EditorItem::GetType ( ) const
virtual

Get the type of the editor item.

Returns
Type of the item.
void gazebo::gui::EditorItem::HeightChanged ( double  _height)
signal

Qt signal emitted when the editor item height has changed.

Parameters
[in]_heightHeight of item in pixels.
void gazebo::gui::EditorItem::ItemDeleted ( )
signal

Qt signal emitted when the editor item is being deleted.

void gazebo::gui::EditorItem::LevelChanged ( int  _level)
signal

Qt signal emitted when the editor item's level has changed.

Parameters
[in]_levelLevel.
void gazebo::gui::EditorItem::PoseChanged ( double  _x,
double  _y,
double  _z,
double  _roll,
double  _pitch,
double  _yaw 
)
signal

Qt signal emitted when the editor item pose has changed.

Parameters
[in]_xX position of item in pixels.
[in]_yY position of item in pixels.
[in]_zZ position of item in pixels.
[in]_rollRoll rotation of item in degrees.
[in]_pitchPitch rotation of item in degrees.
[in]_yawYaw rotation of item in degrees.
void gazebo::gui::EditorItem::PoseOriginTransformed ( double  _x,
double  _y,
double  _z,
double  _roll,
double  _pitch,
double  _yaw 
)
signal

Qt signal emitted when the editor item pose origin has changed.

Parameters
[in]_xX position of item in pixels.
[in]_yY position of item in pixels.
[in]_zZ position of item in pixels.
[in]_rollRoll rotation of item in degrees.
[in]_pitchPitch rotation of item in degrees.
[in]_yawYaw rotation of item in degrees.
void gazebo::gui::EditorItem::PositionChanged ( double  _x,
double  _y,
double  _z 
)
signal

Qt signal emitted when the editor item position has changed.

Parameters
[in]_xX position of item in pixels.
[in]_yY position of item in pixels.
[in]_zZ position of item in pixels.
void gazebo::gui::EditorItem::PosXChanged ( double  _posX)
signal

Qt signal emitted when the editor item's X position has changed.

Parameters
[in]_xX position of item in pixels.
void gazebo::gui::EditorItem::PosYChanged ( double  _posY)
signal

Qt signal emitted when the editor item's Y position has changed.

Parameters
[in]_yY position of item in pixels.
void gazebo::gui::EditorItem::PosZChanged ( double  _posZ)
signal

Qt signal emitted when the editor item's Z position has changed.

Parameters
[in]_zZ position of item in pixels.
void gazebo::gui::EditorItem::RotationChanged ( double  _roll,
double  _pitch,
double  _yaw 
)
signal

Qt signal emitted when the editor item rotation has changed.

Parameters
[in]_rollRoll rotation of item in degrees.
[in]_pitchPitch rotation of item in degrees.
[in]_yawYaw rotation of item in degrees.
void gazebo::gui::EditorItem::Set3dColor ( QColor  _color)

Set the associated 3D visual's color.

Parameters
[in]_colorColor.
void gazebo::gui::EditorItem::Set3dTexture ( QString  _texture)

Set the associated 3D visual's texture.

Parameters
[in]_textureTexture.
void gazebo::gui::EditorItem::Set3dTransparency ( float  _transparency)

Set the transparency of the associated 3D visual.

Parameters
[in]_transparencyTransparency.
virtual void gazebo::gui::EditorItem::SetHighlighted ( bool  _highlighted)
virtual

Set whether this item should be highlighted or not.

Parameters
[in]_highlightedTrue for highlighted.

Reimplemented in gazebo::gui::RectItem, and gazebo::gui::WallSegmentItem.

void gazebo::gui::EditorItem::SetLevel ( int  _level)

Set the level of this building item.

Parameters
[in]_levelLevel number.
void gazebo::gui::EditorItem::SetLevelBaseHeight ( double  _height)

Set the base height of this level relative to the ground plane.

Parameters
[in]_heightBase height.
virtual void gazebo::gui::EditorItem::SetName ( const std::string &  _name)
virtual

Set the name of this editor item.

Parameters
[in]_nameName to set the editor item to.
void gazebo::gui::EditorItem::SizeChanged ( double  _width,
double  _depth,
double  _height 
)
signal

Qt signal emitted when the editor item size has changed.

Parameters
[in]_widthWidth of item in pixels.
[in]_depthDepth of item in pixels.
[in]_heightHeight of item in pixels.
void gazebo::gui::EditorItem::TextureChanged ( QString  _texture)
signal

Qt signal emitted when the editor item's 3D texture has changed.

Parameters
[in]_textureTexture.
void gazebo::gui::EditorItem::TransparencyChanged ( float  _transparency)
signal

Qt signal emitted when the editor item's 3D transparency has changed.

Parameters
[in]_transparencyTransparency.
void gazebo::gui::EditorItem::WidthChanged ( double  _width)
signal

Qt signal emitted when the editor item width has changed.

Parameters
[in]_widthWidth of item in pixels.
void gazebo::gui::EditorItem::YawChanged ( double  _yaw)
signal

Qt signal emitted when the editor item yaw rotation has changed.

Parameters
[in]_yawYaw rotation of item in degrees.
int gazebo::gui::EditorItem::ZValueIdle ( ) const

Get the z value of this item when in idle state.

Returns
Z value.
int gazebo::gui::EditorItem::ZValueSelected ( ) const

Get the z value of this item when in selected state.

Returns
Z value.

Member Data Documentation

std::string gazebo::gui::EditorItem::editorType
protected

Type of editor item.

bool gazebo::gui::EditorItem::highlighted
protected

Flag to indicate whether this item is currently highlighted or not.

double gazebo::gui::EditorItem::itemScale
protected

Scale for converting from pixel to metric units.

int gazebo::gui::EditorItem::level
protected

Level that this item is on.

double gazebo::gui::EditorItem::levelBaseHeight
protected

Vertical distance from the building's base to the base of the level this editor is in.

std::string gazebo::gui::EditorItem::name
protected

Name of editor item.

QColor gazebo::gui::EditorItem::visual3dColor
protected

Color of the associated 3D visual.

QString gazebo::gui::EditorItem::visual3dTexture
protected

Texture of the associated 3D visual.

float gazebo::gui::EditorItem::visual3dTransparency
protected

Transparency of the associated 3D visual.

int gazebo::gui::EditorItem::zValueIdle
protected

Z ordering of the rect item when idle (unselected.)

int gazebo::gui::EditorItem::zValueSelected
protected

Z ordering of the rect item when selected.


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