##

EditorItem Class Reference
GUI

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

`#include <EditorItem.hh>`

Inherits QObject.

Inherited by RectItem, and SegmentItem.

## Signals

void | ColorChanged (const ignition::math::Color &_color)
| Qt signal emitted when the editor item's 3D color has changed. More...
void | DepthChanged (const double _depth)
| Qt signal emitted when the editor item depth has changed. More...
void | HeightChanged (const 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 (const int _level)
| Qt signal emitted when the editor item's level has changed. More...
void | PoseChanged (const double _x, const double _y, const double _z, const double _roll, const double _pitch, const double _yaw)
| Qt signal emitted when the editor item pose has changed. More...
void | PoseOriginTransformed (const double _x, const double _y, const double _z, const double _roll, const double _pitch, const double _yaw)
| Qt signal emitted when the editor item pose origin has changed. More...
void | PositionChanged (const double _x, const double _y, const double _z)
| Qt signal emitted when the editor item position has changed. More...
void | PosXChanged (const double _posX)
| Qt signal emitted when the editor item's X position has changed. More...
void | PosYChanged (const double _posY)
| Qt signal emitted when the editor item's Y position has changed. More...
void | PosZChanged (const double _posZ)
| Qt signal emitted when the editor item's Z position has changed. More...
void | RotationChanged (const double _roll, const double _pitch, const double _yaw)
| Qt signal emitted when the editor item rotation has changed. More...
void | SizeChanged (const double _width, const double _depth, const double _height)
| Qt signal emitted when the editor item size has changed. More...
void | TextureChanged (const std::string &_texture)
| Qt signal emitted when the editor item's 3D texture has changed. More...
void | TransparencyChanged (const float _transparency)
| Qt signal emitted when the editor item's 3D transparency has changed. More...
void | WidthChanged (const double _width)
| Qt signal emitted when the editor item width has changed. More...
void | YawChanged (const double _yaw)
| Qt signal emitted when the editor item yaw rotation has changed. More...

## Public Member Functions

| EditorItem ()
| Constructor. More...
| ~EditorItem ()
| Destructor. More...
virtual ignition::math::Color | Color3d () const
| Get the associated 3D visual's color. More...
virtual std::string | ItemType () const
| Get the type of the editor item. More...
int | Level () const
| Get the level in which this building item is located. More...
double | LevelBaseHeight () const
| Get the base height of this level relative to the ground plane. More...
virtual std::string | Name () const
| Get the name of the editor item. More...
virtual ignition::math::Vector3d | ScenePosition () const
| Get the scene position of editor item. More...
virtual double | SceneRotation () const
| Get the scene rotation of the editor item. More...
void | Set3dTransparency (const float _transparency)
| Set the transparency of the associated 3D visual. More...
void | SetColor3d (const ignition::math::Color &_color)
| Set the associated 3D visual's color. More...
virtual void | SetHighlighted (const bool _highlighted)
| Set whether this item should be highlighted or not. More...
void | SetLevel (const int _level)
| Set the level of this building item. More...
void | SetLevelBaseHeight (const 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...
void | SetTexture3d (const std::string &_texture)
| Set the associated 3D visual's texture. More...
virtual ignition::math::Vector3d | Size () const
| Get the size of the item in pixels. More...
virtual std::string | Texture3d () const
| Get the associated 3D visual's texture. 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...
ignition::math::Color | visual3dColor
| Color of the associated 3D visual. More...
std::string | 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

## EditorItem()

EditorItem | ( |  | ) |

Constructor.

## ~EditorItem()

~EditorItem | ( |  | ) |

Destructor.

## Member Function Documentation

## Color3d()

virtual ignition::math::Color Color3d | ( |  | ) | const

virtual

Get the associated 3D visual's color.

Returns
  Color of the 3D visual.

## ColorChanged

void ColorChanged | ( | const ignition::math::Color & | _color | ) |

signal

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

Parameters

  [in] | _color | Color.

## DepthChanged

void DepthChanged | ( | const double | _depth | ) |

signal

Qt signal emitted when the editor item depth has changed.

Parameters

  [in] | _depth | Depth of item in pixels.

## HeightChanged

void HeightChanged | ( | const double | _height | ) |

signal

Qt signal emitted when the editor item height has changed.

Parameters

  [in] | _height | Height of item in pixels.

## ItemDeleted

void ItemDeleted | ( |  | ) |

signal

Qt signal emitted when the editor item is being deleted.

## ItemType()

virtual std::string ItemType | ( |  | ) | const

virtual

Get the type of the editor item.

Returns
  Type of the item.

## Level()

int Level | ( |  | ) | const

Get the level in which this building item is located.

## LevelBaseHeight()

double LevelBaseHeight | ( |  | ) | const

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

## LevelChanged

void LevelChanged | ( | const int | _level | ) |

signal

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

Parameters

  [in] | _level | Level.

## Name()

virtual std::string Name | ( |  | ) | const

virtual

Get the name of the editor item.

Returns
  Name of the item.

## PoseChanged

void PoseChanged | ( | const double | _x,
|  | const double | _y,
|  | const double | _z,
|  | const double | _roll,
|  | const double | _pitch,
|  | const double | _yaw
| ) |  |

signal

Qt signal emitted when the editor item pose has changed.

Parameters

  [in] | _x | X position of item in pixels.
  [in] | _y | Y position of item in pixels.
  [in] | _z | Z position of item in pixels.
  [in] | _roll | Roll rotation of item in degrees.
  [in] | _pitch | Pitch rotation of item in degrees.
  [in] | _yaw | Yaw rotation of item in degrees.

## PoseOriginTransformed

void PoseOriginTransformed | ( | const double | _x,
|  | const double | _y,
|  | const double | _z,
|  | const double | _roll,
|  | const double | _pitch,
|  | const double | _yaw
| ) |  |

signal

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

Parameters

  [in] | _x | X position of item in pixels.
  [in] | _y | Y position of item in pixels.
  [in] | _z | Z position of item in pixels.
  [in] | _roll | Roll rotation of item in degrees.
  [in] | _pitch | Pitch rotation of item in degrees.
  [in] | _yaw | Yaw rotation of item in degrees.

## PositionChanged

void PositionChanged | ( | const double | _x,
|  | const double | _y,
|  | const double | _z
| ) |  |

signal

Qt signal emitted when the editor item position has changed.

Parameters

  [in] | _x | X position of item in pixels.
  [in] | _y | Y position of item in pixels.
  [in] | _z | Z position of item in pixels.

## PosXChanged

void PosXChanged | ( | const double | _posX | ) |

signal

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

Parameters

  [in] | _x | X position of item in pixels.

## PosYChanged

void PosYChanged | ( | const double | _posY | ) |

signal

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

Parameters

  [in] | _y | Y position of item in pixels.

## PosZChanged

void PosZChanged | ( | const double | _posZ | ) |

signal

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

Parameters

  [in] | _z | Z position of item in pixels.

## RotationChanged

void RotationChanged | ( | const double | _roll,
|  | const double | _pitch,
|  | const double | _yaw
| ) |  |

signal

Qt signal emitted when the editor item rotation has changed.

Parameters

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

## ScenePosition()

virtual ignition::math::Vector3d ScenePosition | ( |  | ) | const

virtual

Get the scene position of editor item.

Returns
  Scene position in pixel coordinates.

Reimplemented in RectItem, SegmentItem, FloorItem, StairsItem, DoorItem, and WindowItem.

## SceneRotation()

virtual double SceneRotation | ( |  | ) | const

virtual

Get the scene rotation of the editor item.

Returns
  Scene rotation in degrees.

Reimplemented in RectItem, SegmentItem, FloorItem, StairsItem, DoorItem, and WindowItem.

## Set3dTransparency()

void Set3dTransparency | ( | const float | _transparency | ) |

Set the transparency of the associated 3D visual.

Parameters

  [in] | _transparency | Transparency.

## SetColor3d()

void SetColor3d | ( | const ignition::math::Color & | _color | ) |

Set the associated 3D visual's color.

Parameters

  [in] | _color | Color.

## SetHighlighted()

virtual void SetHighlighted | ( | const bool | _highlighted | ) |

virtual

Set whether this item should be highlighted or not.

Parameters

  [in] | _highlighted | True for highlighted.

Reimplemented in RectItem, and WallSegmentItem.

## SetLevel()

void SetLevel | ( | const int | _level | ) |

Set the level of this building item.

Parameters

  [in] | _level | Level number.

## SetLevelBaseHeight()

void SetLevelBaseHeight | ( | const double | _height | ) |

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

Parameters

  [in] | _height | Base height.

## SetName()

virtual void SetName | ( | const std::string & | _name | ) |

virtual

Set the name of this editor item.

Parameters

  [in] | _name | Name to set the editor item to.

## SetTexture3d()

void SetTexture3d | ( | const std::string & | _texture | ) |

Set the associated 3D visual's texture.

Parameters

  [in] | _texture | Texture.

## Size()

virtual ignition::math::Vector3d Size | ( |  | ) | const

virtual

Get the size of the item in pixels.

Returns
  Size in pixels.

Reimplemented in RectItem, SegmentItem, FloorItem, StairsItem, DoorItem, and WindowItem.

## SizeChanged

void SizeChanged | ( | const double | _width,
|  | const double | _depth,
|  | const double | _height
| ) |  |

signal

Qt signal emitted when the editor item size has changed.

Parameters

  [in] | _width | Width of item in pixels.
  [in] | _depth | Depth of item in pixels.
  [in] | _height | Height of item in pixels.

## Texture3d()

virtual std::string Texture3d | ( |  | ) | const

virtual

Get the associated 3D visual's texture.

Returns
  Texture of the 3D visual.

## TextureChanged

void TextureChanged | ( | const std::string & | _texture | ) |

signal

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

Parameters

  [in] | _texture | Texture.

## TransparencyChanged

void TransparencyChanged | ( | const float | _transparency | ) |

signal

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

Parameters

  [in] | _transparency | Transparency.

## WidthChanged

void WidthChanged | ( | const double | _width | ) |

signal

Qt signal emitted when the editor item width has changed.

Parameters

  [in] | _width | Width of item in pixels.

## YawChanged

void YawChanged | ( | const double | _yaw | ) |

signal

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

Parameters

  [in] | _yaw | Yaw rotation of item in degrees.

## ZValueIdle()

int ZValueIdle | ( |  | ) | const

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

Returns
  Z value.

## ZValueSelected()

int ZValueSelected | ( |  | ) | const

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

Returns
  Z value.

## Member Data Documentation

## editorType

std::string editorType

protected

Type of editor item.

## highlighted

bool highlighted

protected

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

## itemScale

double itemScale

protected

Scale for converting from pixel to metric units.

## level

int level

protected

Level that this item is on.

## levelBaseHeight

double levelBaseHeight

protected

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

## name

std::string name

protected

Name of editor item.

## visual3dColor

ignition::math::Color visual3dColor

protected

Color of the associated 3D visual.

## visual3dTexture

std::string visual3dTexture

protected

Texture of the associated 3D visual.

## visual3dTransparency

float visual3dTransparency

protected

Transparency of the associated 3D visual.

## zValueIdle

int zValueIdle

protected

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

## zValueSelected

int zValueSelected

protected

Z ordering of the rect item when selected.

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

- EditorItem.hh