2D representation of a staircase. More...

#include <StairsItem.hh>

Public Types
enum	ResizeFlags { NONE = 0x00, ITEM_WIDTH = 0x01, ITEM_HEIGHT = 0x02 }
	Resize flags used to indicate which dimension can be resized. More...

Signals
void	ColorChanged (const common::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
	StairsItem ()
	Constructor. More...

	~StairsItem ()
	Destructor. More...

double	AngleOnWall () const
	Get the angle of this item inside its parent wall. More...

virtual common::Color	Color3d () const
	Get the associated 3D visual's color. More...

void	DetachFromParent ()
	Detach the rect item from its parent. More...

double	Height () const
	Get the height of the rect item. 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	PositionOnWall () const
	Get the position of this item inside its parent wall. More...

virtual double	Rotation () const
	Get the rotation of the rect 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	SetAngleOnWall (const double _angleOnWall)
	Set the angle of this item inside its parent wall. More...

void	SetColor3d (const common::Color &_color)
	Set the associated 3D visual's color. More...

void	SetHeight (const int _height)
	Set the height of the rect item. More...

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

virtual void	SetPosition (const ignition::math::Vector2d &_pos)
	Set the position of the rect item. More...

virtual void	SetPosition (const double _x, const double _y)
	Set the position of the rect item. More...

void	SetPositionOnWall (const double _positionOnWall)
	Set the position of this item inside its parent wall. More...

virtual void	SetResizeFlag (const unsigned int _flag)
	Set the resize flag of the rect item. More...

virtual void	SetRotation (const double _angle)
	Set the rotation of the rect item. More...

void	SetSize (const ignition::math::Vector2i &_size)
	Set the size of the rect item. More...

void	SetTexture3d (const std::string &_texture)
	Set the associated 3D visual's texture. More...

void	SetWidth (const int _width)
	Set the width of the rect item. More...

void	ShowHandles (const bool _show)
	Show the grabber and rotate handles of the rect item. More...

virtual ignition::math::Vector3d	Size () const
	Get the size of the item in pixels. More...

void	StairsChanged ()
	Emit stairs changed Qt signals. More...

int	Steps () const
	Get the number of steps in the staircase. More...

virtual std::string	Texture3d () const
	Get the associated 3D visual's texture. More...

double	Width () const
	Get the width of the rect 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 Member Functions
virtual QRectF	boundingRect () const
	Get the bounding box of the rect item. More...

void	DrawBoundingBox (QPainter *_painter)
	Draw bounding box. More...

void	UpdateCornerPositions ()
	Helper method for Updating the corner positions of the rect item. More...

void	UpdateMeasures ()
	Update this item's measures. More...

Protected Attributes
common::Color	borderColor
	Border color of the rect item. More...

QAction *	deleteItemAct
	Qt action for deleting the item. More...

double	drawingHeight
	Actual height of rect item drawn in pixels. More...

double	drawingOriginX
	X origin of the rect item in pixels. More...

double	drawingOriginY
	Y origin of the rect item in pixels. More...

double	drawingWidth
	Actual width of rect item drawn in pixels. More...

std::string	editorType
	Type of editor item. More...

double	height
	Height of rect item in pixels. 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::vector< MeasureItem * >	measures
	A vector containing this item's measure items. More...

std::string	name
	Name of editor item. More...

QAction *	openInspectorAct
	Qt action for opening the inspector. More...

double	rotationAngle
	Rotation angle of the rect item in degrees. More...

common::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...

double	width
	Width of rect item in pixels. 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 representation of a staircase.

Member Enumeration Documentation

enum ResizeFlags

inherited

Resize flags used to indicate which dimension can be resized.

Enumerator
NONE	No dimensions.
ITEM_WIDTH	Width.
ITEM_HEIGHT	Height.

Constructor & Destructor Documentation

StairsItem ( )

Constructor.

~StairsItem ( )

Destructor.

Member Function Documentation

double AngleOnWall ( ) const

inherited

Get the angle of this item inside its parent wall.

Returns: Angle on parent wall in degrees.

virtual QRectF boundingRect ( ) const

protectedvirtualinherited

Get the bounding box of the rect item.

Returns: The bounding box of the rect item.

virtual common::Color Color3d ( ) const

virtualinherited

Get the associated 3D visual's color.

Returns: Color of the 3D visual.

void ColorChanged ( const common::Color & _color )

signalinherited

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

Parameters

[in] _color Color.

void DepthChanged ( const double _depth )

signalinherited

Qt signal emitted when the editor item depth has changed.

Parameters

[in] _depth Depth of item in pixels.

void DetachFromParent ( )

inherited

Detach the rect item from its parent.

void DrawBoundingBox ( QPainter * _painter )

protectedinherited

Draw bounding box.

Parameters

[in] _painter Qt painter object.

double Height ( ) const

inherited

Get the height of the rect item.

Returns: Height of the rect item in pixels.

void HeightChanged ( const double _height )

signalinherited

Qt signal emitted when the editor item height has changed.

Parameters

[in] _height Height of item in pixels.

void ItemDeleted ( )

signalinherited

Qt signal emitted when the editor item is being deleted.

virtual std::string ItemType ( ) const

virtualinherited

Get the type of the editor item.

Returns: Type of the item.

int Level ( ) const

inherited

Get the level in which this building item is located.

double LevelBaseHeight ( ) const

inherited

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

void LevelChanged ( const int _level )

signalinherited

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

Parameters

[in] _level Level.

virtual std::string Name ( ) const

virtualinherited

Get the name of the editor item.

Returns: Name of the item.

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

signalinherited

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.

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

signalinherited

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.

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

signalinherited

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.

double PositionOnWall ( ) const

inherited

Get the position of this item inside its parent wall.

Returns: Normalized position on parent wall.

void PosXChanged ( const double _posX )

signalinherited

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

Parameters

[in] _x X position of item in pixels.

void PosYChanged ( const double _posY )

signalinherited

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

Parameters

[in] _y Y position of item in pixels.

void PosZChanged ( const double _posZ )

signalinherited

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

Parameters

[in] _z Z position of item in pixels.

virtual double Rotation ( ) const

virtualinherited

Get the rotation of the rect item.

Returns: Rotation in degrees.

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

signalinherited

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.

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

virtual

Get the scene position of editor item.

Returns: Scene position in pixel coordinates.

Reimplemented from RectItem.

virtual double SceneRotation ( ) const

virtual

Get the scene rotation of the editor item.

Returns: Scene rotation in degrees.

Reimplemented from RectItem.

void Set3dTransparency ( const float _transparency )

inherited

Set the transparency of the associated 3D visual.

Parameters

[in] _transparency Transparency.

void SetAngleOnWall ( const double _angleOnWall )

inherited

Set the angle of this item inside its parent wall.

Parameters

[in] _angleOnWall New angle on wall, either 0 or 180 degrees.

void SetColor3d ( const common::Color & _color )

inherited

Set the associated 3D visual's color.

Parameters

[in] _color Color.

void SetHeight ( const int _height )

inherited

Set the height of the rect item.

Parameters

[in] _height Height of the rect item in pixels.

void SetHighlighted ( const bool _highlighted )

virtualinherited

Set whether this item should be highlighted or not.

Parameters

[in] _highlighted True for highlighted.

Reimplemented from EditorItem.

void SetLevel ( const int _level )

inherited

Set the level of this building item.

Parameters

[in] _level Level number.

void SetLevelBaseHeight ( const double _height )

inherited

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

Parameters

[in] _height Base height.

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

virtualinherited

Set the name of this editor item.

Parameters

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

virtual void SetPosition ( const ignition::math::Vector2d & _pos )

virtualinherited

Set the position of the rect item.

Parameters

[in] _pos Position in pixel coordinates.

virtual void SetPosition	(	const double	_x,
		const double	_y
	)

virtualinherited

Set the position of the rect item.

Parameters

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

void SetPositionOnWall ( const double _positionOnWall )

inherited

Set the position of this item inside its parent wall.

Parameters

[in] _positionOnWall New normalized position on wall.

virtual void SetResizeFlag ( const unsigned int _flag )

virtualinherited

Set the resize flag of the rect item.

Parameters

[in] _flag Resize flag which controls how the item can be resized.

virtual void SetRotation ( const double _angle )

virtualinherited

Set the rotation of the rect item.

Parameters

[in] _angle Rotation angle in degrees.

void SetSize ( const ignition::math::Vector2i & _size )

inherited

Set the size of the rect item.

Parameters

[in] _size Size of the rect item in pixels.

void SetTexture3d ( const std::string & _texture )

inherited

Set the associated 3D visual's texture.

Parameters

[in] _texture Texture.

void SetWidth ( const int _width )

inherited

Set the width of the rect item.

Parameters

[in] _width Width of the rect item in pixels.

void ShowHandles ( const bool _show )

inherited

Show the grabber and rotate handles of the rect item.

Parameters

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

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

virtual

Get the size of the item in pixels.

Returns: Size in pixels.

Reimplemented from RectItem.

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

signalinherited

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.

void StairsChanged ( )

Emit stairs changed Qt signals.

int Steps ( ) const

Get the number of steps in the staircase.

Returns: The number of steps in the staircase

virtual std::string Texture3d ( ) const

virtualinherited

Get the associated 3D visual's texture.

Returns: Texture of the 3D visual.

void TextureChanged ( const std::string & _texture )

signalinherited

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

Parameters

[in] _texture Texture.

void TransparencyChanged ( const float _transparency )

signalinherited

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

Parameters

[in] _transparency Transparency.

void UpdateCornerPositions ( )

protectedinherited

Helper method for Updating the corner positions of the rect item.

void UpdateMeasures ( )

protectedinherited

Update this item's measures.

double Width ( ) const

inherited

Get the width of the rect item.

Returns: Width of the rect item in pixels.

void WidthChanged ( const double _width )

signalinherited

Qt signal emitted when the editor item width has changed.

Parameters

[in] _width Width of item in pixels.

void YawChanged ( const double _yaw )

signalinherited

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

Parameters

[in] _yaw Yaw rotation of item in degrees.

int ZValueIdle ( ) const

inherited

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

Returns: Z value.

int ZValueSelected ( ) const

inherited

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

Returns: Z value.

Member Data Documentation

common::Color borderColor

protectedinherited

Border color of the rect item.

QAction* deleteItemAct

protectedinherited

Qt action for deleting the item.

double drawingHeight

protectedinherited

Actual height of rect item drawn in pixels.

double drawingOriginX

protectedinherited

X origin of the rect item in pixels.

double drawingOriginY

protectedinherited

Y origin of the rect item in pixels.

double drawingWidth

protectedinherited

Actual width of rect item drawn in pixels.

std::string editorType

protectedinherited

Type of editor item.

double height

protectedinherited

Height of rect item in pixels.

bool highlighted

protectedinherited

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

double itemScale

protectedinherited

Scale for converting from pixel to metric units.

int level

protectedinherited

Level that this item is on.

double levelBaseHeight

protectedinherited

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

std::vector<MeasureItem *> measures

protectedinherited

A vector containing this item's measure items.

Currently only used for windows and doors, containing one measure towards each end of this item's parent wall.

std::string name

protectedinherited

Name of editor item.

QAction* openInspectorAct

protectedinherited

Qt action for opening the inspector.

double rotationAngle

protectedinherited

Rotation angle of the rect item in degrees.

common::Color visual3dColor

protectedinherited

Color of the associated 3D visual.

std::string visual3dTexture

protectedinherited

Texture of the associated 3D visual.

float visual3dTransparency

protectedinherited

Transparency of the associated 3D visual.

double width

protectedinherited

Width of rect item in pixels.

int zValueIdle

protectedinherited

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

int zValueSelected

protectedinherited

Z ordering of the rect item when selected.

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

StairsItem.hh

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation