VizKit::VisualStagePosition Class Reference

Dimensionless position of asset on stage. More...

#include <VisualStagePosition.h>

List of all members.

Public Member Functions
	VisualStagePosition ()
	The constructor.
	~VisualStagePosition ()
	The destructor.
	VisualStagePosition (const VisualStagePosition &other)
	Copy constructor.
VisualStagePosition &	operator= (const VisualStagePosition &other)
	Assignment operator.
bool	operator== (const VisualStagePosition &other) const
	Equality operator.
bool	operator!= (const VisualStagePosition &other)
	Inequality operator.
virtual VisualStagePosition *	clone (void) const
	Copies the current VisualStagePosition and returns a pointer to a new VisualStagePosition.
void	reset (void)
	Resets the values of the stage position to default.
Public Attributes
HorizontalAlignment	horizontalAlignment
	The horizontal alignment of the box.
VerticalAlignment	verticalAlignment
	The vertical alignment of the box.
DepthAlignment	depthAlignment
	The depth alignment of the box (z-dimension).
double	marginTop
	The top margin of the box.
double	marginLeft
	The left margin of the box.
double	marginBottom
	The bottom margin of the box.
double	marginRight
	The right margin of the box.
double	minMarginTop
	The minimum top margin of the box.
double	minMarginLeft
	The minimum left margin of the box.
double	minMarginBottom
	The minimum bottom margin of the box.
double	minMarginRight
	The minimum right margin of the box.
double	minWidth
	The minimum width of the box.
double	maxWidth
	The maximum width of the box.
double	minHeight
	The minimum height of the box.
double	maxHeight
	The maximum height of the box.
Unit	marginTopUnit
	The measure of the top margin value.
Unit	marginLeftUnit
	The measure of the left margin value.
Unit	marginRightUnit
	The measure of the right margin value.
Unit	marginBottomUnit
	The measure of the bottom margin value.
Unit	minMarginTopUnit
	The measure of the minimum top margin value.
Unit	minMarginLeftUnit
	The measure of the minimum left margin value.
Unit	minMarginRightUnit
	The measure of the minimum right margin value.
Unit	minMarginBottomUnit
	The measure of the minimum bottom margin value.
Unit	minWidthUnit
	The measure of the minimum width value.
Unit	maxWidthUnit
	The measure of the maximum width value.
Unit	minHeightUnit
	The measure of the minimum height value.
Unit	maxHeightUnit
	The measure of the maximum height value.
double	horizontalCoordOffset
	The horizontal offset (measured in coord values).
double	verticalCoordOffset
	The vertical offset (measured in coord values).
Private Member Functions
void	copy (const VisualStagePosition &other)
	Copy method for assignment operator and copy constructor.

---

Detailed Description

Dimensionless position of asset on stage.

---

Constructor & Destructor Documentation

VisualStagePosition::VisualStagePosition

(

)

The constructor.

VisualStagePosition::~VisualStagePosition

(

)

The destructor.

VisualStagePosition::VisualStagePosition

(

const VisualStagePosition &

other

)

Copy constructor.

Parameters:

other

Another VisualStagePosition.

---

Member Function Documentation

VisualStagePosition * VisualStagePosition::clone

(

void

)

const [virtual]

Copies the current VisualStagePosition and returns a pointer to a new VisualStagePosition.

void VisualStagePosition::copy

(

const VisualStagePosition &

other

)

[private]

Copy method for assignment operator and copy constructor.

Parameters:

other

Another VisualStagePosition.

bool VisualStagePosition::operator!=

(

const VisualStagePosition &

other

)

Inequality operator.

Parameters:

other

Another VisualStagePosition.

VisualStagePosition & VisualStagePosition::operator=

(

const VisualStagePosition &

other

)

Assignment operator.

Parameters:

other

Another VisualStagePosition.

bool VisualStagePosition::operator==

(

const VisualStagePosition &

other

)

const

Equality operator.

Parameters:

other

Another VisualStagePosition.

void VisualStagePosition::reset

(

void

)

Resets the values of the stage position to default.

---

Member Data Documentation

DepthAlignment VizKit::VisualStagePosition::depthAlignment

The depth alignment of the box (z-dimension).

HorizontalAlignment VizKit::VisualStagePosition::horizontalAlignment

The horizontal alignment of the box.

double VizKit::VisualStagePosition::horizontalCoordOffset

The horizontal offset (measured in coord values).

double VizKit::VisualStagePosition::marginBottom

The bottom margin of the box.

Unit VizKit::VisualStagePosition::marginBottomUnit

The measure of the bottom margin value.

double VizKit::VisualStagePosition::marginLeft

The left margin of the box.

Unit VizKit::VisualStagePosition::marginLeftUnit

The measure of the left margin value.

double VizKit::VisualStagePosition::marginRight

The right margin of the box.

Unit VizKit::VisualStagePosition::marginRightUnit

The measure of the right margin value.

double VizKit::VisualStagePosition::marginTop

The top margin of the box.

Unit VizKit::VisualStagePosition::marginTopUnit

The measure of the top margin value.

double VizKit::VisualStagePosition::maxHeight

The maximum height of the box.

Unit VizKit::VisualStagePosition::maxHeightUnit

The measure of the maximum height value.

double VizKit::VisualStagePosition::maxWidth

The maximum width of the box.

Unit VizKit::VisualStagePosition::maxWidthUnit

The measure of the maximum width value.

double VizKit::VisualStagePosition::minHeight

The minimum height of the box.

Unit VizKit::VisualStagePosition::minHeightUnit

The measure of the minimum height value.

double VizKit::VisualStagePosition::minMarginBottom

The minimum bottom margin of the box.

Unit VizKit::VisualStagePosition::minMarginBottomUnit

The measure of the minimum bottom margin value.

double VizKit::VisualStagePosition::minMarginLeft

The minimum left margin of the box.

Unit VizKit::VisualStagePosition::minMarginLeftUnit

The measure of the minimum left margin value.

double VizKit::VisualStagePosition::minMarginRight

The minimum right margin of the box.

Unit VizKit::VisualStagePosition::minMarginRightUnit

The measure of the minimum right margin value.

double VizKit::VisualStagePosition::minMarginTop

The minimum top margin of the box.

Unit VizKit::VisualStagePosition::minMarginTopUnit

The measure of the minimum top margin value.

double VizKit::VisualStagePosition::minWidth

The minimum width of the box.

Unit VizKit::VisualStagePosition::minWidthUnit

The measure of the minimum width value.

VerticalAlignment VizKit::VisualStagePosition::verticalAlignment

The vertical alignment of the box.

double VizKit::VisualStagePosition::verticalCoordOffset

The vertical offset (measured in coord values).

---

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

• vizkit/source/VisualStagePosition.h
• vizkit/source/VisualStagePosition.cpp