class GmHyperlink

Class description

Inheritance:

Public Methods
Protected Fields
Protected Methods

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 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(GlmPoint3* point)
virtual void setPosition(float x, float y, float z)
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

GmLabel* mTextWidget

The text widget used to draw the text

float mTextWidth

The width of the text

float mTextHeight

The height of the text

GlmColor4 mTextColor

The text color for this hyperlink

GmHyperlink()

Standard constructor

virtual ~GmHyperlink()

Virtual destructor

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!

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

Renders this button to a 2D image buffer.


Parameters:: renderOptions - the render options to use when rendering the button.

virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)

Renders this button to a selection buffer.


Parameters:: renderOptions - the render options to use when rendering the button.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

This page was generated with the help of DOC++.

	GmHyperlink () 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 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	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	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	setText (char* text) Sets the text of this text widget to the given text.
void	setTextColor (GlmColor4* color) Sets the display color of the 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	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	~GmHyperlink () Virtual destructor

GlmColor4	mTextColor The text color for this hyperlink
float	mTextHeight The height of the text
GmLabel*	mTextWidget The text widget used to draw the text
float	mTextWidth The width of the text

virtual void	render2d (GmTypes::RenderOptionType renderOptions) Renders this button to a 2D image buffer.
virtual void	render2dSelect (GmTypes::RenderOptionType renderOptions) Renders this button to a selection buffer.