##

SegmentItem Class Reference
GUI

2D line segment. More...

`#include <SegmentItem.hh>`

Inherits EditorItem, and QGraphicsLineItem.

Inherited by MeasureItem, and WallSegmentItem.

## 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

| SegmentItem (QGraphicsItem *_parent=0)
| Constructor. More...
| ~SegmentItem ()
| Destructor. More...
virtual ignition::math::Color | Color3d () const
| Get the associated 3D visual's color. More...
ignition::math::Vector2d | EndPoint () const
| Get the end point of the segment. More...
std::vector< GrabberHandle * > | Grabbers () const
| Get the grabber handles. 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...
double | Scale () const
| Get the scale of the segment item. More...
ignition::math::Vector3d | ScenePosition () const
| Get the scene position of editor item. More...
double | SceneRotation () const
| Get the scene rotation of the editor item. More...
void | SegmentChanged ()
| Emit segment changed Qt signals. More...
void | Set3dTransparency (const float _transparency)
| Set the transparency of the associated 3D visual. More...
void | SetColor (const ignition::math::Color &_color)
| Set the color of the segment item. More...
void | SetColor3d (const ignition::math::Color &_color)
| Set the associated 3D visual's color. More...
void | SetEndPoint (const ignition::math::Vector2d &_end)
| Set the end point of the segment. 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...
void | SetLine (const ignition::math::Vector2d &_start, const ignition::math::Vector2d &_end)
| Set the segment's line. More...
virtual void | SetName (const std::string &_name)
| Set the name of this editor item. More...
void | SetScale (const double _scale)
| Set the scale of the segment item. More...
void | SetStartPoint (const ignition::math::Vector2d &_start)
| Set the start point of the segment. More...
void | SetTexture3d (const std::string &_texture)
| Set the associated 3D visual's texture. More...
void | SetThickness (const double _thickness)
| Set the thickness of the segment item on the 2d view. More...
void | ShowHandles (const bool _show)
| Show the grabber handles of the segment item. More...
ignition::math::Vector3d | Size () const
| Get the size of the item in pixels. More...
ignition::math::Vector2d | StartPoint () const
| Get the start point of the segment. More...
virtual std::string | Texture3d () const
| Get the associated 3D visual's texture. More...
double | Thickness () const
| Get the thickness of the segment 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...

## Static Public Attributes

static const double | SnapAngle
| Angle to snap in degrees. More...
static const double | SnapLength
| Length to snap in meters. More...

## Protected Member Functions

virtual void | SegmentUpdated ()
| Update item. More...
void | UpdateLinkedGrabbers (GrabberHandle *_grabber, const ignition::math::Vector2d &_pos)
| Update the position of all grabbers linked to the given one. More...

## Protected Attributes

std::string | editorType
| Type of editor item. More...
std::vector< GrabberHandle * > | grabbers
| A list of grabber handles for this 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

2D line segment.

## Constructor & Destructor Documentation

## SegmentItem()

SegmentItem | ( | QGraphicsItem * | _parent = `0` | ) |

explicit

Constructor.

Parameters

  [in] | _parent | Parent graphics item.

## ~SegmentItem()

~SegmentItem | ( |  | ) |

Destructor.

## Member Function Documentation

## Color3d()

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

virtual inherited

Get the associated 3D visual's color.

Returns
  Color of the 3D visual.

## ColorChanged

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

signal inherited

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

Parameters

  [in] | _color | Color.

## DepthChanged

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

signal inherited

Qt signal emitted when the editor item depth has changed.

Parameters

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

## EndPoint()

ignition::math::Vector2d EndPoint | ( |  | ) | const

Get the end point of the segment.

Returns
  End point of the segment in pixel coordinates.

## Grabbers()

std::vector<GrabberHandle *> Grabbers | ( |  | ) | const

Get the grabber handles.

Returns
  Vector of grabber pointers.

## HeightChanged

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

signal inherited

Qt signal emitted when the editor item height has changed.

Parameters

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

## ItemDeleted

void ItemDeleted | ( |  | ) |

signal inherited

Qt signal emitted when the editor item is being deleted.

## ItemType()

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

virtual inherited

Get the type of the editor item.

Returns
  Type of the item.

## Level()

int Level | ( |  | ) | const

inherited

Get the level in which this building item is located.

## LevelBaseHeight()

double LevelBaseHeight | ( |  | ) | const

inherited

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

## LevelChanged

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

signal inherited

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

Parameters

  [in] | _level | Level.

## Name()

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

virtual inherited

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 inherited

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 inherited

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 inherited

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 inherited

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 inherited

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 inherited

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 inherited

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.

## Scale()

double Scale | ( |  | ) | const

Get the scale of the segment item.

Returns
  Scale of the segment item in px/m.

## ScenePosition()

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

virtual

Get the scene position of editor item.

Returns
  Scene position in pixel coordinates.

Reimplemented from EditorItem.

## SceneRotation()

double SceneRotation | ( |  | ) | const

virtual

Get the scene rotation of the editor item.

Returns
  Scene rotation in degrees.

Reimplemented from EditorItem.

## SegmentChanged()

void SegmentChanged | ( |  | ) |

Emit segment changed Qt signals.

## SegmentUpdated()

virtual void SegmentUpdated | ( |  | ) |

protected virtual

Update item.

Reimplemented in WallSegmentItem.

## Set3dTransparency()

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

inherited

Set the transparency of the associated 3D visual.

Parameters

  [in] | _transparency | Transparency.

## SetColor()

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

Set the color of the segment item.

Parameters

  [in] | _color | Color.

## SetColor3d()

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

inherited

Set the associated 3D visual's color.

Parameters

  [in] | _color | Color.

## SetEndPoint()

void SetEndPoint | ( | const ignition::math::Vector2d & | _end | ) |

Set the end point of the segment.

Parameters

  [in] | _end | End point of the segment in pixel coordinates.

## SetHighlighted()

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

virtual inherited

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 | ) |

inherited

Set the level of this building item.

Parameters

  [in] | _level | Level number.

## SetLevelBaseHeight()

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

inherited

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

Parameters

  [in] | _height | Base height.

## SetLine()

void SetLine | ( | const ignition::math::Vector2d & | _start,
|  | const ignition::math::Vector2d & | _end
| ) |  |

Set the segment's line.

Parameters

  [in] | _start | Start position of the line in pixel coordinates.
  [in] | _end | End position of the line in pixel coordinates.

## SetName()

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

virtual inherited

Set the name of this editor item.

Parameters

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

## SetScale()

void SetScale | ( | const double | _scale | ) |

Set the scale of the segment item.

param[in] _scale Scale of the segment item in px/m.

## SetStartPoint()

void SetStartPoint | ( | const ignition::math::Vector2d & | _start | ) |

Set the start point of the segment.

Parameters

  [in] | _start | Start point of the segment in pixel coordinates.

## SetTexture3d()

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

inherited

Set the associated 3D visual's texture.

Parameters

  [in] | _texture | Texture.

## SetThickness()

void SetThickness | ( | const double | _thickness | ) |

Set the thickness of the segment item on the 2d view.

Parameters

  [in] | _thickness | Thickness in pixels.

## ShowHandles()

void ShowHandles | ( | const bool | _show | ) |

Show the grabber handles of the segment item.

Parameters

  [in] | _show | True to draw the handles, and false to hide them.

## Size()

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

virtual

Get the size of the item in pixels.

Returns
  Size in pixels.

Reimplemented from EditorItem.

## SizeChanged

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

signal inherited

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.

## StartPoint()

ignition::math::Vector2d StartPoint | ( |  | ) | const

Get the start point of the segment.

Returns
  Start point of the segment in pixel coordinates.

## Texture3d()

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

virtual inherited

Get the associated 3D visual's texture.

Returns
  Texture of the 3D visual.

## TextureChanged

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

signal inherited

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

Parameters

  [in] | _texture | Texture.

## Thickness()

double Thickness | ( |  | ) | const

Get the thickness of the segment item.

Returns
  Thickness in pixels.

## TransparencyChanged

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

signal inherited

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

Parameters

  [in] | _transparency | Transparency.

## UpdateLinkedGrabbers()

void UpdateLinkedGrabbers | ( | GrabberHandle * | _grabber,
|  | const ignition::math::Vector2d & | _pos
| ) |  |

protected

Update the position of all grabbers linked to the given one.

Parameters

  [in] | _grabber | Original grabber.
  [in] | _pos | New position.

## WidthChanged

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

signal inherited

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 inherited

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

Parameters

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

## ZValueIdle()

int ZValueIdle | ( |  | ) | const

inherited

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

Returns
  Z value.

## ZValueSelected()

int ZValueSelected | ( |  | ) | const

inherited

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

Returns
  Z value.

## Member Data Documentation

## editorType

std::string editorType

protected inherited

Type of editor item.

## grabbers

std::vector<GrabberHandle *> grabbers

protected

A list of grabber handles for this item.

One grabber for each endpoint.

## highlighted

bool highlighted

protected inherited

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

## itemScale

double itemScale

protected inherited

Scale for converting from pixel to metric units.

## level

int level

protected inherited

Level that this item is on.

## levelBaseHeight

double levelBaseHeight

protected inherited

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

## name

std::string name

protected inherited

Name of editor item.

## SnapAngle

const double SnapAngle

static

Angle to snap in degrees.

## SnapLength

const double SnapLength

static

Length to snap in meters.

## visual3dColor

ignition::math::Color visual3dColor

protected inherited

Color of the associated 3D visual.

## visual3dTexture

std::string visual3dTexture

protected inherited

Texture of the associated 3D visual.

## visual3dTransparency

float visual3dTransparency

protected inherited

Transparency of the associated 3D visual.

## zValueIdle

int zValueIdle

protected inherited

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

## zValueSelected

int zValueSelected

protected inherited

Z ordering of the rect item when selected.

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

- SegmentItem.hh