Class description

Inheritance:

Public Methods

	GmButton () Standard constructor
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 float	getBorderWidth () Gets the width of the border around the button.
virtual GmTypes::ButtonStateType	getState () Gets the state of the button.
virtual char*	getText () Gets the text that is currently associated with this widget
GlmColor4*	getTextColor () Gets the text color that is currently assigned to the text.
void	getTextJustification (GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical) Gets the type of justification for the text in this widget.
float	getTextPointSize () Gets the size of the text in points.
virtual void	mousePressEvent (GmEvent* event) Event processing function to process a mouse press event.
virtual void	mouseReleaseEvent (GmEvent* event) Event processing function to process a mouse release event.
virtual void	setAbsoluteGeometry (float x, float y, float z, float width, float height, float depth) Sets the absolute geometry to use for this drawable object.
virtual void	setBorderWidth (float borderWidth) Sets the width of the border around the button.
virtual void	setCoordType (GmTypes::CoordinateType coordType) Sets the coordinate type for this object.
virtual void	setDepth (float depth) Sets the depth of the drawable object in units.
virtual void	setHeight (float height) Sets the height of the drawable object in units.
virtual void	setPosition (float x, float y, float z) Sets the position of the drawable.
virtual void	setPosition (GlmPoint3* point) Sets the position of the drawable.
virtual void	setRelativeGeometry (float x, float y, float width, float height) Sets the relative geometry to use for this drawable object.
virtual void	setRelativeGeometry (float x, float y, float z, float width, float height, float depth) Sets the relative geometry to use for this drawable object.
virtual void	setState (GmTypes::ButtonStateType state) Sets the state of the button.
virtual void	setText (char* text) Sets the text of this text widget to the given text.
void	setTextColor (float r, float g, float b, float a) Sets the display color of the text to the given red, green, blue and alpha values.
void	setTextColor (GlmColor4* color) Sets the display color of the text.
void	setTextJustification (GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical) Sets the horizontal and vertical text justification for the widget text.
void	setTextPointSize (float pointSize) Sets the point size of the text, this will affect the size at which the font is rendered for the text string.
virtual void	setVisible (bool visible) Sets the visibility of the drawable object.
virtual void	setWidth (float width) Sets the width of the drawable object in units.
virtual	~GmButton () Virtual destructor

Protected Fields

float	mBorderWidth The width of the border around the button
GmTypes::ButtonStateType	mState The state of the button.
GmTextWidget*	mTextWidget Some text for labeling the button

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 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 setBaseColor(GlmColor4* color)

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

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 render2d(GmTypes::RenderOptionType renderOptions)

virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)

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

GmTypes::ButtonStateType mState

The state of the button. This can usually be GMBS_PRESSED or GMBS_UNPRESSED.

float mBorderWidth

The width of the border around the button

GmTextWidget* mTextWidget

Some text for labeling the button

GmButton()

Standard constructor

virtual ~GmButton()

Virtual destructor

virtual void setState(GmTypes::ButtonStateType state)

Sets the state of the button. A button can have two states, pressed and unpressed.

Parameters:

- state the state to set the button to

virtual GmTypes::ButtonStateType getState()

Gets the state of the button.

Returns:

the pressed state of the button.

virtual void setBorderWidth(float borderWidth)

Sets the width of the border around the button. The border width is the total percentage that the border should visually encompass on the button.

Parameters:

border - the width of the border around the button. The value is the total percentage that the border should visually encompass on the button

virtual float getBorderWidth()

Gets the width of the border around the button.

Returns:

the width of the border around the button

virtual void setText(char* text)

Sets the text of this text widget to the given text.

Parameters:

text - the text to set this widget to display

virtual char* getText()

Gets the text that is currently associated with this widget

Returns:

s a pointer to the text that this widget is set to display. THIS IS A BORROWED POINTER, DO NOT DELETE IT!

void setTextColor(GlmColor4* color)

Sets the display color of the text.

Parameters:

color - the color to set the text color to

void setTextColor(float r, float g, float b, float a)

Sets the display color of the text to the given red, green, blue and alpha values.

Parameters:

r - the red component of the color
g - the green component of the color
b - the blue component of the color
a - the alpha component of the color

GlmColor4* getTextColor()

Gets the text color that is currently assigned to the text.

Returns:

the text color as a GlmColor4 object, THIS IS A BORROWED REFERENCE, DO NOT DELETE IT!

void setTextPointSize(float pointSize)

Sets the point size of the text, this will affect the size at which the font is rendered for the text string.

Parameters:

pointSize - the size of the text in points

float getTextPointSize()

Gets the size of the text in points.

Returns:

the point size of the text that is to be rendered by this widget.

void setTextJustification(GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical)

Sets the horizontal and vertical text justification for the widget text.

Parameters:

horizontal - the horizontal justification to use for the text widget.
vertical - the vertical justification to use for the text widget.

void getTextJustification(GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical)

Gets the type of justification for the text in this widget.

Parameters:

horizontal - the horizontal text justification for the widget
vertical - the vertical text justification for the widget

virtual void setCoordType(GmTypes::CoordinateType coordType)

Sets the coordinate type for this object. The coordinate type can either be CT_ABSOLUTE or CT_RELATIVE. Absolute placement is where the object should be placed in world coordinates, where relative placement is done as a percentage of the parent container. For objects of container classes, the only coordinate type available are relative coordinates.

Parameters:

coordType - the coordinate type to set this drawable object to

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

Sets the position of the drawable. The top-left most pixel of the rendered image will be located at the given point if the coordinate type is CT_ABSOLUTE. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

- x the X position of the drawable object
- y the Y position of the drawable object
z - the Z position of the drawable object

virtual void setPosition(GlmPoint3* point)

Sets the position of the drawable. The top-left most pixel of the rendered image will be located at the given point if the coordinate type is CT_ABSOLUTE. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

point - the point to use as the top-left rendering location of the drawable.

virtual void setWidth(float width)

Sets the width of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

width - the width to set the drawable object's width to.

virtual void setHeight(float height)

Sets the height of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

height - the height to set the drawable object's height to.

virtual void setDepth(float depth)

Sets the depth of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

depth - the depth to set the drawable object's depth to.

virtual void setVisible(bool visible)

Sets the visibility of the drawable object. If the visibility is set to false, the object is not drawn. If the visibility is set to true, the object will be drawn.

Parameters:

visible - the visibility status to set this drawable object to

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

Sets the absolute geometry to use for this drawable object. This method is provided merely for convenience.

Parameters:

- x the absolute X value for this drawable
- y the absolute Y value for this drawable
z - the absolute Z value for this drawable
width - the width of this drawable
height - the height of this drawable
depth - the depth of this drawable

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

Sets the relative geometry to use for this drawable object. This method is provided merely for convenience. This method is intended to be used with 2d layouts.

Parameters:

- x the absolute X value for this drawable
- y the absolute Y value for this drawable
width - the width of this drawable
height - the height of this drawable

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

Sets the relative geometry to use for this drawable object. This method is provided merely for convenience.

Parameters:

- x the absolute X value for this drawable
- y the absolute Y value for this drawable
z - the absolute Z value for this drawable
width - the width of this drawable
height - the height of this drawable
depth - the depth of this drawable

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 or parent layout manager.

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
maxX - the ending X position of the constraint volume
maxY - the ending X position of the constraint volume
maxZ - the ending Z position of the constraint volume

virtual void mousePressEvent(GmEvent* event)

Event processing function to process a mouse press event.

Parameters:

event - the mouse press event for this object to process

virtual void mouseReleaseEvent(GmEvent* event)

Event processing function to process a mouse release event.

Parameters:

event - the mouse release event for this object to process

Direct child classes:

GmMenu
GmGraphicButton
GmCheckBox

Alphabetic index HTML hierarchy of classes or Java