Class description

Inheritance:

Public Methods

	GmContainer () Standard constructor
virtual void	addComponent (GmDrawable* component) Adds a drawable component to the container.
virtual void	applyLayout (float minX, float minY, float minZ, float maxX, float maxY, float maxZ) Repositions and resizes this component based on parameters passed into the method.
virtual int	findComponent (float x, float y) Given an (x,y) world coordinate, this attempts to find a contained component at that location.
GmLayoutManager*	getLayout () Gets this container's associated layout manager.
void	setLayout (GmLayoutManager* layoutManager) Sets this container's associated layout manager.
virtual	~GmContainer () Virtual destructor

Protected Fields

vector<GmDrawable*>	mComponents The components that this component encapsulates
GmLayoutManager*	mLayoutManager The associated layout manager for this container

Protected Methods

virtual void	applyLayout () Applies this container's layout to the components that it encapsulates
virtual void	render2d (GmTypes::RenderOptionType renderOptions) Renders this container and all of its sub-components to a 2D image buffer.
virtual void	render2dSelect (GmTypes::RenderOptionType renderOptions) Renders this container and all of its sub-components to a selection buffer.

Inherited from GmInteractiveWidget:

Public Fields

GmFocusEventHandler* focusEventHandler

GmKeyEventHandler* keyEventHandler

GmAnimation* mFocusGainAnim

GmAnimation* mFocusLoseAnim

GmTypes::FocusType mFocusState

unsigned int mFocusTimestamp

GmAnimation* mKeyPressAnim

GmAnimation* mKeyReleaseAnim

GmAnimation* mMouseExitAnim

GmAnimation* mMouseOverAnim

GmAnimation* mMousePressAnim

GmAnimation* mMouseReleaseAnim

WidgetIDType mWidgetId

GmToolTip* mWidgetToolTip

GmMouseEventHandler* mouseEventHandler

GmUserEventHandler* userEventHandler

GmWidgetEventHandler* widgetEventHandler

Public Methods

virtual void focusGainEvent(GmEvent* event)

virtual void focusLoseEvent(GmEvent* event)

virtual WidgetIDType getWidgetId()

virtual void keyPressEvent(GmEvent* event)

virtual void keyReleaseEvent(GmEvent* event)

virtual void mouseDragEvent(GmEvent* event)

virtual void mouseMoveEvent(GmEvent* event)

virtual void mousePressEvent(GmEvent* event)

virtual void mouseReleaseEvent(GmEvent* event)

virtual void setFocusEventHandler(GmFocusEventHandler* focusHandler, WidgetIDType widgetId)

virtual void setKeyEventHandler(GmKeyEventHandler* keyHandler, WidgetIDType widgetId)

virtual void setMouseEventHandler(GmMouseEventHandler* mouseHandler, WidgetIDType widgetId)

virtual void setToolTip(GmToolTip* tooltip)

virtual void setUserEventHandler(GmUserEventHandler* userHandler, WidgetIDType widgetId)

virtual void setWidgetEventHandler(GmWidgetEventHandler* widgetHandler, WidgetIDType widgetId)

virtual void userEvent(GmEvent* event)

virtual void wheelMoveEvent(GmEvent* event)

Protected Methods

virtual void render2dToolTip(GmTypes::RenderOptionType renderOptions)

Inherited from GmAnimatedWidget:

Public Methods

virtual void animationFinished(GmTypes::AnimationType animationType)

virtual void applyAnimationTransforms()

virtual void setEventAnimation(GmTypes::AnimationType animType, GmAnimation* animation)

Protected Fields

GmAnimation* mAppearAnimation

GmTypes::AnimationType mCurrentAnimation

GmAnimation* mIdleAnimation

GmAnimation* mVanishAnimation

Inherited from GmDrawable:

Public Methods

virtual GlmColor4* getBaseColor()

virtual GmTypes::CoordinateType getCoordType()

virtual float getDepth()

virtual float getGlDepth()

virtual void getGlExtents(float& width, float& height)

virtual float getGlHeight()

virtual GlmPoint3* getGlPosition()

virtual float getGlWidth()

virtual float getHeight()

virtual void getMinimumGeometry(float& width, float& height, float& depth)

virtual GlmPoint3* getPosition()

virtual bool getVisible()

virtual float getWidth()

virtual void render(GmTypes::RenderOptionType renderOptions)

virtual void setAbsoluteGeometry(float x, float y, float z, float width, float height, float depth)

virtual void setBaseColor(GlmColor4* color)

virtual void setBaseColor(float r, float g, float b, float a)

virtual void setCoordType(GmTypes::CoordinateType coordType)

virtual void setDepth(float depth)

virtual void setHeight(float height)

virtual void setPosition(float x, float y, float z)

virtual void setPosition(GlmPoint3* point)

virtual void setRelativeGeometry(float x, float y, float z, float width, float height, float depth)

virtual void setRelativeGeometry(float x, float y, float width, float height)

virtual void setVisible(bool visible)

virtual void setWidth(float width)

Protected Fields

GlmColor4 mBaseColor

GmTypes::CoordinateType mCoordType

float mDepth

bool mDisplayListGenerate

int mDisplayListId

float mGlDepth

float mGlHeight

GlmPoint3 mGlPosition

float mGlWidth

float mHeight

GlmPoint3 mPosition

bool mVisible

float mWidth

Protected Methods

virtual bool getDisplayListGenerate()

virtual int getDisplayListId()

virtual void setDisplayListGenerate(bool generate)

virtual void setDisplayListId(int id)

Inherited from GmObject:

Public Methods

unsigned short getObjectId()

Protected Fields

The object ID is used to uniquely identify each GmObject unsigned short mObjectId

Inherited from GmAnimationEventHandler:

Documentation

Class description

vector<GmDrawable*> mComponents

The components that this component encapsulates

GmLayoutManager* mLayoutManager

The associated layout manager for this container

virtual void applyLayout()

Applies this container's layout to the components that it encapsulates

GmContainer()

Standard constructor

virtual ~GmContainer()

Virtual destructor

virtual void addComponent(GmDrawable* component)

Adds a drawable component to the container.

Parameters:

component - the component to add to the container. DO NOT DELETE THIS ARGUMENT AFTER THE METHOD CALL. The container doesn't make a copy, rather it uses the object that is passed in directly. This class will handle the components finalization/deletion.

virtual void applyLayout(float minX, float minY, float minZ, float maxX, float maxY, float maxZ)

Repositions and resizes this component based on parameters passed into the method. These parameters are usually passed in by the parent class. Container classes in turn call all of their components for restructuring.

Parameters:

minX - the starting X position of the constraint volume
minY - the starting Y position of the constraint volume
minZ - the starting Z position of the constraint volume
minX - the ending X position of the constraint volume
minY - the ending Y position of the constraint volume
minZ - the ending Z position of the constraint volume

void setLayout(GmLayoutManager* layoutManager)

Sets this container's associated layout manager.

Parameters:

layoutManager - the new layout manager for this container

GmLayoutManager* getLayout()

Gets this container's associated layout manager.

Returns:

this container's layout manager

virtual int findComponent(float x, float y)

Given an (x,y) world coordinate, this attempts to find a contained component at that location. If one is found, its index is returned. If not, -1 is returned.

Parameters:

- x the to-be-matched x coordinate
- y the to-be-matched y coordinate

Returns:

if found, the index of the target component, if not, -1

virtual void render2d(GmTypes::RenderOptionType renderOptions)

Renders this container and all of its sub-components to a 2D image buffer.

Parameters:

renderOptions - the render options to use when rendering the container.

virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)

Renders this container and all of its sub-components to a selection buffer.

Parameters:

renderOptions - the render options to use when rendering the container.

Direct child classes:

GmViewport
GmTable
GmTabbedPanel
GmRadioButtonGroup
GmPanel
GmMenuBar
GmDialog

Alphabetic index HTML hierarchy of classes or Java