class GmTextArea

A TextArea displays more than one line of text and adheres to the given text justification and size constraints

Inheritance:

Public Methods
Protected Fields
Protected Methods

Inherited from GmTextWidget:

Public Methods
void getGlExtents(float& width, float& height)
void getOffset(float& xOffset, float& yOffset)
virtual char* getText()
GlmColor4* getTextColor()
void getTextJustification(GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical)
float getTextPointSize()
void setOffset(float xOffset, float yOffset)

Protected Fields
OGLFT::Face* mFontFace
char* mText
GlmColor4 mTextColor
GmTypes::JustificationType mTextHJustification
float mTextPointSize
GmTypes::JustificationType mTextVJustification
float mXOffset
float mYOffset

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 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 width, float height)
virtual void setRelativeGeometry(float x, float y, float z, float width, float height, float depth)
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 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

A TextArea displays more than one line of text and adheres to the given text justification and size constraints

bool mSplitTextReady

Indicates whether or not line-spitting of mText is complete

vector< pair<char*, float> > mSplitText

A vector to hold the text of mText which has been line-broken, along with a size of whitespace to place between tokens (if the text is to be fully justified)

vector<int> mDrawDisplayLists

A vector to keep track of the smaller display lists generated when fully justifying text

vector<int> mSupportDisplayLists

A vector to keep track of the smaller display lists generated by OGLFT when fully justifying text

GmTextArea()

Standard constructor

virtual ~GmTextArea()

Virtual destructor

virtual void render2d(GmTypes::RenderOptionType renderOptions)

Renders this label to a 2D image buffer.


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

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 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

virtual 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

virtual 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.

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 splitText()

Splits mText on whitespace at the required line breaks and caches the results

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

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

	GmTextArea () 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 void	render2d (GmTypes::RenderOptionType renderOptions) Renders this label to a 2D image buffer.
virtual void	setText (char* text) Sets the text of this text widget to the given text.
virtual 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.
virtual void	setTextJustification (GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical) Sets the horizontal and vertical text justification for the widget text.
virtual 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	~GmTextArea () Virtual destructor

vector<int>	mDrawDisplayLists A vector to keep track of the smaller display lists generated when fully justifying text
vector< pair<char*, float> >	mSplitText A vector to hold the text of mText which has been line-broken, along with a size of whitespace to place between tokens (if the text is to be fully justified)
bool	mSplitTextReady Indicates whether or not line-spitting of mText is complete
vector<int>	mSupportDisplayLists A vector to keep track of the smaller display lists generated by OGLFT when fully justifying text