StairsInspectorDialog Class Reference

Dialog for configuring a staircase item. More...

#include <StairsInspectorDialog.hh>

Inherits BaseInspectorDialog.

Signals
void	Applied ()
	Qt signal emitted to indicate that changes should be applied. More...

Public Member Functions
	StairsInspectorDialog (QWidget *_parent=0)
	Constructor. More...
	~StairsInspectorDialog ()
	Destructor. More...
common::Color	Color () const
	Get the color. More...
double	Depth () const
	Get the depth the staircase. More...
double	Height () const
	Get the height the staircase. More...
void	InitColorComboBox ()
	Initiate color combo box. More...
void	InitTextureComboBox ()
	Initiate texture combo box. More...
void	SetColor (const common::Color &_color)
	Set the color. More...
void	SetDepth (const double _depth)
	Set the depth of the staircase. More...
void	SetHeight (const double _height)
	Set the height of the staircase. More...
void	SetName (const std::string &_name)
	Set the name of the staircase. More...
void	SetStartPosition (const ignition::math::Vector2d &_pos)
	Set the start position of the staircase. More...
void	SetSteps (const int _steps)
	Set the number of steps in the staircase. More...
void	SetTexture (const std::string &_texture)
	Set the texture. More...
void	SetWidth (const double _width)
	Set the width of the staircase. More...
ignition::math::Vector2d	StartPosition () const
	Get start position (bottom-end) of the staircase. More...
int	Steps () const
	Get the number of steps in the staircase. More...
std::string	Texture () const
	Get the texture. More...
double	Width () const
	Get the width the staircase. More...

Protected Slots
void	OnApply ()
	Qt callback when the Apply button is pressed. More...
void	OnCancel ()
	Qt callback when the Cancel button is pressed. More...
void	OnOK ()
	Qt callback when the Ok button is pressed. More...

Protected Attributes
QComboBox *	colorComboBox
	Combo box for selecting the color. More...
QComboBox *	textureComboBox
	Combo box for selecting the texture. More...

Detailed Description

Dialog for configuring a staircase item.

Constructor & Destructor Documentation

StairsInspectorDialog()

StairsInspectorDialog

(

QWidget *

_parent = 0

)

Constructor.

Parameters

[in]

_parent

Parent QWidget.

~StairsInspectorDialog()

~StairsInspectorDialog

(

)

Destructor.

Member Function Documentation

Applied

void Applied ( )

signalinherited

Qt signal emitted to indicate that changes should be applied.

Color()

common::Color Color ( ) const

inherited

Get the color.

Returns

Color.

Depth()

double Depth

(

)

const

Get the depth the staircase.

Returns

Staircase depth in pixels.

Height()

double Height

(

)

const

Get the height the staircase.

Returns

Staircase height in pixels.

InitColorComboBox()

void InitColorComboBox ( )

inherited

Initiate color combo box.

InitTextureComboBox()

void InitTextureComboBox ( )

inherited

Initiate texture combo box.

OnApply

void OnApply ( )

protectedslotinherited

Qt callback when the Apply button is pressed.

OnCancel

void OnCancel ( )

protectedslotinherited

Qt callback when the Cancel button is pressed.

OnOK

void OnOK ( )

protectedslotinherited

Qt callback when the Ok button is pressed.

SetColor()

void SetColor ( const common::Color &  _color )

inherited

Set the color.

Parameters

[in]

_color

Color.

SetDepth()

void SetDepth

(

const double

_depth

)

Set the depth of the staircase.

Parameters

[in]

_depth

Depth in pixels.

SetHeight()

void SetHeight

(

const double

_height

)

Set the height of the staircase.

Parameters

[in]

_height

Height in pixels.

SetName()

void SetName

(

const std::string &

_name

)

Set the name of the staircase.

Parameters

[in]

_name

Name to set to.

SetStartPosition()

void SetStartPosition

(

const ignition::math::Vector2d &

_pos

)

Set the start position of the staircase.

Parameters

[in]

_pos

Start position in pixel coordinates.

SetSteps()

void SetSteps

(

const int

_steps

)

Set the number of steps in the staircase.

Parameters

[in]

_steps

Number of steps.

SetTexture()

void SetTexture ( const std::string &  _texture )

inherited

Set the texture.

Parameters

[in]

_texture

Texture.

SetWidth()

void SetWidth

(

const double

_width

)

Set the width of the staircase.

Parameters

[in]

_width

Width in pixels.

StartPosition()

ignition::math::Vector2d StartPosition

(

)

const

Get start position (bottom-end) of the staircase.

Returns

The start position of the staircase in pixel coordinates.

Steps()

int Steps

(

)

const

Get the number of steps in the staircase.

Returns

Number of steps in the staircase.

Texture()

std::string Texture ( ) const

inherited

Get the texture.

Returns

Texture.

Width()

double Width

(

)

const

Get the width the staircase.

Returns

Staircase width in pixels.

Member Data Documentation

colorComboBox

QComboBox* colorComboBox

protectedinherited

Combo box for selecting the color.

textureComboBox

QComboBox* textureComboBox

protectedinherited

Combo box for selecting the texture.

---

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

• StairsInspectorDialog.hh