Class description

Inheritance:

Public Methods

	GmLayoutManager () Standard constructor
virtual void	apply (vector<GmDrawable*>* components) Applies the layout to the container.
float	getBottomInset () Returns the bottom inset amount.
float	getLeftInset () Returns the left inset amount.
float	getRightInset () Returns the right inset amount.
float	getTopInset () Returns the top inset amount.
void	setContainerDimensions (GlmPoint3& position, float& width, float& height, float& depth) Associates the container's position and dimensions with this layout manager.
void	setGlContainerDimensions (GlmPoint3& glPosition, float &glWidth, float& glHeight, float& glDepth) Associates the container's OpenGL position and dimensions with this layout manager.
void	setInsets (float left, float right, float top, float bottom) Sets the inset amounts.
virtual	~GmLayoutManager () Virtual destructor

Protected Fields

float	mBottomInset
float*	mCDepth
float*	mCGlDepth
float*	mCGlHeight
GlmPoint3*	mCGlPosition
float*	mCGlWidth
float*	mCHeight
GlmPoint3*	mCPosition
float*	mCWidth Dimensions of the container.
float	mLeftInset
float	mRightInset
float	mTopInset

Documentation

Class description

GlmPoint3* mCPosition

GlmPoint3* mCGlPosition

float* mCWidth

Dimensions of the container. Both in application units and OpenGL units.

float* mCHeight

float* mCDepth

float* mCGlWidth

float* mCGlHeight

float* mCGlDepth

float mLeftInset

float mRightInset

float mTopInset

float mBottomInset

GmLayoutManager()

Standard constructor

virtual ~GmLayoutManager()

Virtual destructor

virtual void apply(vector<GmDrawable*>* components) = 0

Applies the layout to the container. All components will be positioned according to the layout design. This function must be implemented by inheriting layout classes.

Parameters:

components - the vector of components in the container

void setContainerDimensions(GlmPoint3& position, float& width, float& height, float& depth)

Associates the container's position and dimensions with this layout manager. Association is used so that layout managers do not have to be updated if container positions or dimensions change.

Parameters:

position - the starting position of the constraint volume
width - the width of the constraint volume
height - the height of the constraint volume
depth - the depth of the constraint volume

void setGlContainerDimensions(GlmPoint3& glPosition, float &glWidth, float& glHeight, float& glDepth)

Associates the container's OpenGL position and dimensions with this layout manager. Association is used so that layout managers do not have to be updated if container positions or dimensions change.

Parameters:

glPosition - the starting position of the constraint volume
glWidth - the OpenGL unit width of the constraint volume
glHeight - the OpenGL unit height of the constraint volume
glDepth - the OpenGL unit depth of the constraint volume

void setInsets(float left, float right, float top, float bottom)

Sets the inset amounts.

Parameters:

left - sets the top left
right - sets the top right
top - sets the top inset
bottom - sets the top bottom

float getTopInset()

Returns the top inset amount.

Returns:

the top inset amount

float getBottomInset()

Returns the bottom inset amount.

Returns:

the bottom inset amount

float getLeftInset()

Returns the left inset amount.

Returns:

the left inset amount

float getRightInset()

Returns the right inset amount.

Returns:

the right inset amount

Direct child classes:

Gm2dLayout

Alphabetic index HTML hierarchy of classes or Java