GL Studio API
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GlsText Class Reference

#include <gls_text.h>

Inheritance diagram for GlsText:
GLPolygon DisplayObject AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable GlsCTLTextBox GlsTextBox GlsTextGrid

Classes

struct  CharAttr_t
 Attributes for each character position in the grid. More...
 
struct  CharTraitsUnsignedShort
 
class  LineSegment_t
 

Public Types

enum  Justify_t
 Different text justifications.
 
- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum
 

Public Member Functions

 GlsText ()
 
virtual ~GlsText ()
 
virtual void SetAvailableAttributes (unsigned int value)
 
void Baseline (const float &baselineShift)
 
float Baseline ()
 
void BgColor (const glsColor &color)
 
glsColor BgColor ()
 
void Border (const float &units)
 
float Border () const
 
void CellHeight (float height)
 
float CellHeight () const
 
void CellWidth (float width)
 
float CellWidth () const
 
void Char (Char_t code)
 
CharAttr_t CharAttribs () const
 
CharAttr_t CharAttr (unsigned int index) const
 
void CharScaling (const float &newScale)
 
float CharScaling ()
 
void CharSpacing (const float &horizontalSpacing)
 
float CharSpacing ()
 
void ConstrainCellRatio (bool constrain)
 
bool ConstrainCellRatio () const
 
void ControlCellSize (bool control)
 
bool ControlCellSize () const
 
virtual void CopyGeometry (DisplayObject *src)
 
virtual void CopyProperties (DisplayObject *src)
 
void Erase ()
 
void FauxBold (const bool &bold)
 
bool FauxBold ()
 
GlsFontBaseFont () const
 
void Font (GlsFontBase *font)
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
 
void Halo (bool halo)
 
void HaloColor (const glsColor &color)
 
void InvalidateFont ()
 
void Inverse (const bool &inverse)
 
bool Inverse ()
 
void Justify (Justify_t justification)
 
Justify_t Justify () const
 
void LineSpacing (float spacing)
 
float LineSpacing () const
 
void LockCellSize (bool lock)
 
bool LockCellSize () const
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
 
virtual void SetValue (int spec, va_list &args)
 
void Shadow (bool shadow)
 
void ShadowColor (const glsColor &color)
 
void ShadowDistance (const float &dist)
 
void ShadowOffset (const Vector &offset)
 
void StrikeThru (const bool &strike)
 
bool StrikeThru ()
 
void String (const std::string &s)
 
void String (const char *s)
 
std::string String () const
 
void TextColor (const glsColor &color)
 
glsColor TextColor ()
 
void Underline (const bool &underline)
 
bool Underline ()
 
void Uppercase (bool uppercase)
 
void WrapText (bool wrap)
 
bool WrapText () const
 
void SetRebuild ()
 
- Public Member Functions inherited from GLPolygon
 GLPolygon (unsigned int nPoints, Vertex *vertices)
 
 GLPolygon (unsigned int nPoints, Vertex *vertices, Vertex &location)
 
 GLPolygon (void)
 
 GLPolygon (const GLPolygon &polygon, const bool generateNames)
 
virtual ~GLPolygon (void)
 
void ConfigureMetaData (void)
 
virtual DisplayObjectCloneObject (bool generateNames=false)
 
virtual void Draw (void)
 
virtual void CalculateTextureCoordinates (void)
 
virtual void CalcNormals (int windingOrder=1)
 
virtual void DeleteVertex (unsigned int index)
 
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &parentDrawn)
 
- Public Member Functions inherited from DisplayObject
 DisplayObject (float x, float y, float z)
 
 DisplayObject (const DisplayObject &object, const bool generateNames)
 
virtual ~DisplayObject (void)
 
void Destroy ()
 
virtual void AlphaMode (int mode)
 
virtual int AlphaMode (void)
 
virtual bool AntiAlias (void)
 
virtual void AntiAlias (bool alias)
 
void ApplyTextureSettings (int textureIndex=-1)
 
DistiAttribDictAttributes ()
 
virtual void SetBlendColor (const glsColor &color)
 
void GetBlendColor (unsigned char color[])
 
void GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
virtual glsColor GetBlendColor ()
 
void SetBlendColor (unsigned char color[])
 
void SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
bool BlinkedOff (void)
 
virtual bool Blinking (void)
 
virtual void Blinking (const bool blink)
 
virtual float BlinkRate (void)
 
virtual void BlinkRate (const float rate)
 
const VectorBoundingVolumeCenter () const
 
void BoundingVolumeCenter (const Vector &center)
 
bool BoundingVolumeHit (const Vector &start, const Vector &direction)
 
float BoundingVolumeRadius () const
 
void BoundingVolumeRadius (float radius)
 
virtual void Calculate (double time)
 
void CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)
 
virtual void CalculateParentBoundingBox (void)
 
bool GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
 
CallbackMethodCallerBaseCallbackCaller () const
 
void CallbackCaller (CallbackMethodCallerBase *cb)
 
virtual void GetCenter (Vector &center)
 
virtual glsColor GetColor ()
 
void GetColor (unsigned char c4[])
 
void GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
virtual void SetColor (const glsColor &color)
 
void SetColor (unsigned char c4[])
 
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual void CopyHierarchyProperties (DisplayObject *src, bool copyName)
 
virtual void CullBackFace (const bool val)
 
virtual bool CullBackFace (void)
 
bool Culled () const
 
bool CullTest (const GlsMatrixType *matrix, const Culler &culler)
 
GlsMatrixTypeDcsMatrix ()
 
void DcsMatrix (const GlsMatrixType &matrix)
 
virtual int DepthTest (void)
 
virtual void DepthTest (unsigned char zbuf)
 
const GlsMatrixTypeDrawMatrix ()
 
bool NeedCalcDrawMatrix ()
 
void DynamicRotate (float angle, int axis)
 
void DynamicRotate (const Vector &v)
 
void DynamicRotate (float angle[])
 
virtual void DynamicRotate (float x, float y, float z)
 
virtual void DynamicRotateRelative (float angle, int axis)
 
virtual float DynamicRotation (int axis)
 
virtual Vector DynamicScale ()
 
virtual void DynamicScale (float x, float y, float z)
 
void DynamicScale (const Vector &scale)
 
virtual void DynamicTranslate (float x, float y, float z, bool relative=false)
 
void DynamicTranslate (const Vertex &amount, bool relative)
 
void DynamicTranslate (const Vector &amount)
 
virtual void DynamicTranslate (float amount, int axis, bool relative=false)
 
virtual float DynamicTranslation (int axis)
 
virtual Vector DynamicTranslation ()
 
DisplayObjectEditor * Editor ()
 
const DisplayObjectEditor * Editor () const
 
void Editor (DisplayObjectEditor *editor)
 
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
 
void GetExtentsDCS (Vector &min, Vector &max)
 
void GetFillColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
void GetFillColor (unsigned char c4[])
 
virtual glsColor GetFillColor (void)
 
void SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
void SetFillColor (unsigned char c4[])
 
virtual void SetFillColor (const glsColor &color)
 
virtual DisplayObjecthandle (DisplayEvent *ev)
 
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
 
virtual bool HitUtil (float x, float y, float z, float scale, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector *collisionPoint)
 
virtual void InsertVertex (unsigned int index)
 
char * InstanceName (void)
 
void InstanceName (const char *name)
 
virtual bool LightingEnabled ()
 
virtual void LightingEnabled (bool lighting)
 
virtual int LineStippleMultiplier (void)
 
virtual void LineStippleMultiplier (int mult)
 
virtual int LineStipplePattern (void)
 
virtual void LineStipplePattern (int pattern)
 
virtual float LineWidth (void)
 
virtual void LineWidth (float width)
 
virtual const VertexLocation (void) const
 
virtual void Location (const Vertex &v)
 
virtual void Location (float x, float y, float z)
 
virtual void GetLocation (Vertex &v)
 
virtual void GetLocation (float &x, float &y, float &z)
 
float X (void) const
 
float Y (void) const
 
float Z (void) const
 
void X (const float x)
 
void Y (const float y)
 
void Z (const float z)
 
virtual int MaterialIndex ()
 
virtual void MaterialIndex (int index)
 
virtual DynamicArray< int > & MaterialIndices ()
 
virtual void MaterialIndices (DynamicArray< int > indices)
 
GlsMatrixTypeModelMatrix ()
 
bool NeedCalculate ()
 
VectorNormals ()
 
virtual void SetNormals (unsigned int nPoints, Vector *vertices)
 
void VaSetNormals (unsigned int nPoints,...)
 
unsigned int NumberOfVertices () const
 
virtual float ObjectDepth (void)
 
virtual float ObjectHeight (void)
 
virtual float ObjectWidth (void)
 
virtual void SetOrigin (const Vertex &vert)
 
virtual void Parent (DisplayFrame *par)
 
DisplayFrameParent (void) const
 
virtual void ParentGroup (Group *group)
 
GroupParentGroup (void) const
 
unsigned char Pickable ()
 
virtual void Pickable (unsigned char pick)
 
virtual int PolygonEnd (void)
 
virtual void PolygonEnd (const int end)
 
virtual int PolygonMode (void)
 
virtual void PolygonMode (int mode)
 
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler)
 
GlsMatrixTypeProjMatrix ()
 
virtual void ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
 
virtual float RelativeAngle (const float x, const float y)
 
virtual DistiAttributeBaseResource (const char *name)
 
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
 
void RestoreAlpha (void)
 
void RestoreAntiAlias (void)
 
void RestoreLighting (void)
 
void RestoreLineStyle (void)
 
const VertexRotationPoint ()
 
virtual void RotationPoint (const Vertex &v)
 
virtual void RotationPoint (float x, float y, float z)
 
virtual void GetRotationPoint (Vertex &v)
 
virtual void Rotate (float angle, int axis=Z_AXIS)
 
virtual void Rotate (const Vector &origin, float angle, int axis=Z_AXIS)
 
void SaveMatrices ()
 
void Scale (int handleBar, float px, float py, Vertex *anchor=NULL)
 
virtual void Scale (float px, float py, float pz, Vertex *anchor, int handleBar=0)
 
void Set (int spec,...)
 
bool SetupAlpha (void)
 
bool SetupAntiAlias (void)
 
void SetupDepthTest (void)
 
void SetupLighting (void)
 
bool SetupLineStyle (void)
 
void SetupPolyDrawStyle (void)
 
void SetupShading (void)
 
bool SetupTexture (void)
 
virtual int Shading (void)
 
virtual void Shading (const int shading)
 
virtual void GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)
 
virtual void SetTexCoords (unsigned int nPoints, Vector *new_tex_coord, bool isVectorArray=true)
 
void SetTexCoords (unsigned int nPoints, Vertex *new_tex_coord)
 
void VaSetTexCoords (unsigned int nPoints,...)
 
VectorTextureCoordinates (void)
 
VectorGetTextureCoordinates (void)
 
virtual int TextureIndex (void)
 
virtual void TextureIndex (int textureIndex)
 
virtual VectorGetTexturePoints (void)
 
virtual bool TextureRepeat (void)
 
virtual void TextureRepeat (const int rep)
 
virtual int TextureMappingTechnique (void)
 
virtual void TextureMappingTechnique (const int map)
 
virtual int TextureMagnificationFilter (void)
 
virtual void TextureMagnificationFilter (const int filter)
 
virtual int TextureMinificationFilter (void)
 
virtual void TextureMinificationFilter (const int filter)
 
virtual void Translate (float tr[])
 
virtual void Translate (float x, float y, float z)
 
virtual void TranslateVertices (float x, float y, float z)
 
virtual void UpdateBoundingVolume (void)
 
void * UserData (void) const
 
void UserData (void *data)
 
virtual void SetVertexColor (unsigned int vertex, unsigned char CurrentFillColor[])
 
virtual VertexVertices ()
 
virtual void SetVertices (unsigned int nPoints, Vertex *vertices)
 
void VaSetVertices (unsigned int nPoints,...)
 
int * ViewMatrix ()
 
bool Visible (void) const
 
bool Visibility (void) const
 
virtual void Visibility (const bool vis)
 
virtual Vector WorldRotationPoint (void)
 
virtual void WorldRotationPoint (const Vector &vert)
 
virtual Vertex WorldVertex (unsigned int i)
 
virtual void WorldVertex (unsigned int i, const Vertex &vert)
 
bool LogicalToWindow (const Vector &logical, Vector &winLoc, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
 
bool WindowToLogical (const Vector &winLoc, Vector &logical, Vector *directionVector=NULL, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
 
void LogicalToDCS (Vector logicalPoint, Vector &objectLocal, const Vector *directionVector, const Vector &planeNormal=Vector(0, 0, 1), const Vector &planePoint=Vector(), const GlsMatrixType *dcsMatrix=NULL)
 
void DCSToLogical (Vector dcsPoint, Vector &logicalPoint, const GlsMatrixType *dcsMatrix=NULL)
 
virtual bool GetPlaneVectorPoints (Vertex &p1, Vertex &p2, Vertex &p3, Vertex &planeVector)
 
void NotifyAttributeChanged (const AttributeName &name)
 
- Public Member Functions inherited from AttributeChangedNotifier
virtual ~AttributeChangedNotifier ()
 
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef)
 
void NotifyWeakReferenceDestroyed (WeakReference *ref)
 

Static Public Member Functions

static void DrawScalableLine (GLfloat x1, GLfloat y1, GLfloat x2, GLfloat y2)
 
- Static Public Member Functions inherited from DisplayObject
static void UseManualBlinkElapsedTime (bool useManualTime)
 
static void SetManualBlinkElapsedTime (double elapsedTime)
 

Protected Member Functions

char * FormatVarArgList (const int initialBufferLength, const char *format, va_list args)
 
- Protected Member Functions inherited from DisplayObject
virtual void VaListSetVertices (unsigned int nPoints, va_list args)
 
virtual void VaListSetNormals (unsigned int nPoints, va_list args)
 
virtual void VaListSetTexCoords (unsigned int nPoints, va_list args)
 
void AllocateModelMatrix ()
 
bool ApplyDynamicRotation (void)
 
virtual void CalcDrawMatrix ()
 
void CalcDrawMatrixIfExists ()
 
virtual void CalculateMatrices (const OpenGLMatrices &newMatrices)
 
bool InsideVertexExtents (float x, float y, unsigned int nVerts, Vertex *verts, float tolerance)
 
void NeedCalculate (bool val)
 
void PickSetup (float x, float y, float z, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector)
 
void PickCleanup (Vertex *vertices, unsigned int vertex_cnt)
 
int GetApplicableTextureIndex ()
 
int GetApplicableTextureRepeat ()
 
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin (void)
 
virtual ~WeakReferenceableMixin ()
 

Protected Attributes

float _border
 
CharAttrCont_t _chars
 
float _cellHeight
 
float _cellWidth
 
bool _constrainRatio
 
bool _controlCellSize
 
GlsFontBase_font
 
glsColor _haloColor
 
Justify_t _justify
 
float _lineSpacing
 
bool _lockCellSize
 
bool _needToRebuild
 
glsColor _shadowColor
 
Vector _shadowOffset
 
std::string _text
 
bool _uppercase
 
Vector _Vx
 
Vector _Vy
 
Vector _Vz
 
bool _wrapText
 
std::auto_ptr< RuntimeGlyphGenerationText > _runtimeGlyphGenerationText
 
- Protected Attributes inherited from DisplayObject
int _alphaMode
 
bool _antiAlias
 
bool _attributesAdded
 
bool _blinking
 
float _blinkRate
 
glsColor _color
 
bool _cullBackFace
 
GlsMatrixType _dcsMatrix
 
unsigned char _depthTest
 
GlsMatrixType_drawMatrix
 
unsigned char _lineStippleMultiplier
 
unsigned short _lineStipplePattern
 
float _lineWidth
 
Vertex _location
 
GlsMatrixType_modelMatrix
 
Vector_normals
 
unsigned int _nTex_vertices
 
unsigned int _nVertices
 
unsigned char _polygonEnd
 
unsigned char _polygonMode
 
int _polygonOffset
 
GlsMatrixType_projMatrix
 
unsigned char _shading
 
Vector_texCoord
 
glsColor _textureBlendColor
 
int _textureIndex
 
unsigned char _textureMagFilter
 
unsigned char _textureMinFilter
 
unsigned char _textureMap
 
Vector _texturePoints [4]
 
unsigned char _textureRepeat
 
void * _userData
 
Vertex_vertices
 
int * _viewMatrix
 
bool _visible
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Detailed Description

The GlsText class provides a base class for all GLStudio text components.

Constructor & Destructor Documentation

GlsText ( )

Class Constructor.

virtual ~GlsText ( )
virtual

Class Constructor.

Member Function Documentation

void Baseline ( const float &  baselineShift)

Sets the baseline shift for all characters.

Parameters
baselineShiftmultiplier used to shift the baseline. This will be multiplied by the character height to determine how much to shift. A value of 0 does not shift at all, a value of 1 will shift up by the height of 1 character.
float Baseline ( )

Gets the baseline shift for the first character

void BgColor ( const glsColor color)

Sets the background color for all characters

Parameters
colorThe background color to set
glsColor BgColor ( )

Gets the background color for the first character

void Border ( const float &  units)

Sets the spacing between the box outline and the text in logical units.

Parameters
unitsBorder offset value in logical units
float Border ( ) const
inline

Sets the spacing between the box outline and the text in logical units.

void CellHeight ( float  height)

Sets the height of a character cell of the grid in logical units when stretch to fit mode is in effect. When stretch to fit mode is not in effect, this call will not affect the grid since the font determines the cell size.

Parameters
heightthe new character cell height.
float CellHeight ( ) const
inline
Returns
the height of a char cell of the grid in logical units.
void CellWidth ( float  width)

Sets the width of a character cell of the grid in logical units when stretch to fit mode is in effect. When stretch to fit mode is not in effect, this call will not affect the grid since the font determines the cell size.

Parameters
widththe new character cell width.
float CellWidth ( ) const
inline
Returns
the width of a char cell of the grid in logical units.
void Char ( Char_t  code)

Sets the character code for all cell positions in the text grid

Parameters
codeThe ASCII character code to set
CharAttr_t CharAttr ( unsigned int  index) const
inline
Returns
a particular cell's character attributes.
CharAttr_t CharAttribs ( ) const
inline

Accessor method used by metadata to read and write the character attributes for this object. Currently only allows you to load and save attributes for the entire object, not on a per character basis.

Returns
The character attribute for the first character in the object and therefore for every character in the object
void CharScaling ( const float &  newScale)

Sets the scale factor of all characters NOTE: This is the size of the character in its cell not the overall scale of the entire object

Parameters
newScaleThe new scale factor of the characters (0.0 < newScale <= 1.0)
float CharScaling ( )

Gets the scale factor of the first character

void CharSpacing ( const float &  horizontalSpacing)

Sets the horizontal character spacing for all characters (spacing from the start of one character to the start of the next character. 1.0 is the default spacing 2.0 would be twice the normal spacing

Parameters
horizontalSpacingThe horizontalSpacing value
float CharSpacing ( )

Gets the horizontal character spacing for the first character

void ConstrainCellRatio ( bool  constrain)

Sets whether to constrain cell width and height proportions when in stretch to fit mode and changing the size of character cells.

Parameters
constraintrue to constrain proportions.
bool ConstrainCellRatio ( ) const
inline
Returns
whether to constrain cell width and height proportions when in stretch to fit mode and changing the size of character cells.
void ControlCellSize ( bool  control)

Sets whether or not the character cell size will stretch to fit this object's bounding box or if it is based on its font and font.

Parameters
controlTrue if stretch to fit will be enabled
bool ControlCellSize ( ) const
inline
Returns
whether or not the character cell size will stretch to fit this object's bounding box or if it is based on its font and font
virtual void CopyGeometry ( DisplayObject src)
virtual

Copies the geometry information from one object to another. Used by the undo mechanism to allow user to undo a geometry change.

Parameters
srcThe object to copy geometry from

Reimplemented from DisplayObject.

Reimplemented in GlsTextGrid, GlsCTLTextBox, and GlsTextBox.

virtual void CopyProperties ( DisplayObject src)
virtual

Copies the attributes except for geometry attributes from one object to another. Used by the undo mechanism to undo most attribute change operations.

Parameters
srcThe object to copy properties from

Reimplemented from DisplayObject.

Reimplemented in GlsTextGrid, GlsCTLTextBox, and GlsTextBox.

static void DrawScalableLine ( GLfloat  x1,
GLfloat  y1,
GLfloat  x2,
GLfloat  y2 
)
inlinestatic

Draw a line by rendering a filled polygon with a line around it so that the thickness scales and anti-aliasing will work if enabled.

void Erase ( )

Erase all characters.

void FauxBold ( const bool &  bold)

Set the bold state on or off for all characters

Parameters
boldBold state
bool FauxBold ( )

Gets the bold state on or off for the first character

GlsFontBase* Font ( ) const
inline
Returns
The font currently being used to render this text.
void Font ( GlsFontBase font)

Set the font used to render this text.

Parameters
fontPointer to a font instance to set
char* FormatVarArgList ( const int  initialBufferLength,
const char *  format,
va_list  args 
)
protected

Allocate a text buffer of the appropriate size for this grid and output snprintf style format into the buffer

Parameters
formatsnprintf style format spec
argsarguments for sprintf style formatting
initialBufferLengththe length of the initial character buffer
Returns
formatted textbuffer ( must be deleted by caller )
virtual InterfaceListType* GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)
virtual

Get the details of the Cpp Interface The actual interface is exposed in compiled code.

Parameters
addToThisListIf not NULL this list will be added to then returned. If NULL a new list will be created.
Returns
A templated list. The caller must call the corresponding free method to safely free the memory.

Reimplemented from DisplayObject.

Reimplemented in GlsTextGrid, GlsCTLTextBox, and GlsTextBox.

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)
virtual

Frees the memory allocated by a previous call to GetCppInterfaceDescription

Parameters
arrayMemory allocated by a previous call to GetCppInterfaceDescription

Reimplemented from DisplayObject.

Reimplemented in GlsTextGrid, GlsCTLTextBox, and GlsTextBox.

void Halo ( bool  halo)

Set the halo state to on or off for the text

Parameters
halohalo state
void HaloColor ( const glsColor color)

Set the color of the halo around the text

Parameters
colorhalo color
void InvalidateFont ( )

Invalidates the font for this object. If the font is invalidated, this object will draw using the default font. This is used in the editor and should not need to be called by any user code at run-time.

void Inverse ( const bool &  inverse)

Set the inverse video state on or off for all characters

Parameters
inverseinverse video state
bool Inverse ( )

Gets the inverse video state on or off for the first character

void Justify ( Justify_t  justification)

Set the justification mode for this text object

Parameters
justificationThe justification mode (LEFT, RIGHT, CENTER)
Justify_t Justify ( ) const
inline
Returns
the justification mode (LEFT, RIGHT, CENTER)
void LineSpacing ( float  spacing)

Sets the linespacing for the text object. A line spacing of 1.0 indicates normal "single spaced" text. 2.0 would be double spaced, etc.

Parameters
spacingThe new linespacing value
float LineSpacing ( ) const
inline
Returns
the linespacing for the text object.
void LockCellSize ( bool  lock)

Sets whether or not the cell size is locked while in stretch to fit mode. If locked, changing other attributes will not affect the cell size, but the box size instead. If not locked, changing certain attributes, eg. border, will affect the cell size.

Parameters
locktrue to lock cell size, false otherwise
bool LockCellSize ( ) const
inline
Returns
the setting of lock cell size.
virtual void Rotate ( const Vector orig,
float  angle,
const Vector axis 
)
virtual

Rotates the object (around the specified axis) by the angle indicated, at the point specified. Recalculates the vertex data.

Parameters
origThe point to rotate around
angleThe angle to rotate by, in degrees
axisThe arbitrary axis to rotate the object around

Reimplemented from DisplayObject.

virtual void SetAvailableAttributes ( unsigned int  value)
virtual

Specifies which attributes are available for the object. Currently the available attributes cannot be changed after they have been set. (Only the first call has an effect.)

Parameters
valueA bitfield specifying which types of attributes to make available.
See also
AvailableAttributesEnum

Reimplemented from DisplayObject.

Reimplemented in GlsCTLTextBox, GlsTextGrid, and GlsTextBox.

void SetRebuild ( )
inline

Sets the rebuild flag, which forces the text object to rebuild itself on the next call to Calculate, PreDraw, or Draw.

virtual void SetValue ( int  spec,
va_list &  args 
)
virtual

Sets an attribute of this object using variable arguments

Parameters
specA GLS_Initializer tag
argsA variable argument list

Reimplemented from DisplayObject.

Reimplemented in GlsTextGrid.

void Shadow ( bool  shadow)

Set the shadow state to on or off for the text

Parameters
shadowshadow state
void ShadowColor ( const glsColor color)

Set the color of the shadow behind the text

Parameters
colorshadow color
void ShadowDistance ( const float &  dist)
inline

Set the distance of the shadow from the text. Distance represent a percentage of the character width. Negative values are up and to the left. Positive values are down and to the right. Note that the corresponding getter was removed because ShadowDistance is deprecated in favor of ShadowOffset.

Parameters
distshadow distance
void ShadowOffset ( const Vector offset)

Set the Cartesian offset of the shadow from the text. Offset represent a percentage of the character width. Negative values are down and to the left. Positive values are up and to the right. Z component is ignored.

Parameters
offsetshadow offset
void StrikeThru ( const bool &  strike)

Sets the strikethru state for all characters

Parameters
strikeWhether or not set strikethru
bool StrikeThru ( )

Gets the strikethru state for the first character

void String ( const std::string &  s)

Sets the ASCII string to be displayed for this object

Parameters
sSTD Template Library String
void String ( const char *  s)
inline

Sets the ASCII string to be displayed for this object

Parameters
sC Style string
std::string String ( ) const
inline
Returns
The string currently stored in this object. NOTE: This can contain extra characters not being displayed in the grid if the string size is greater than will fit within the grid.
void TextColor ( const glsColor color)

Sets the foreground color for all characters in the text grid.

Parameters
colorThe foreground color to set
glsColor TextColor ( )

Gets the foreground color for the first character in the text grid.

void Underline ( const bool &  underline)

Turns on/off underlines for all characters

Parameters
underlineWhether or not to enable underline
bool Underline ( )

Gets the on/off state of underline for the first character

void Uppercase ( bool  uppercase)

Makes all characters uppercase when rendered.

Parameters
uppercaseWhether or not to enable uppercase
void WrapText ( bool  wrap)

Enable/disable word wrap behavior for this object

Parameters
wrapWhether or not to enable word wrap
bool WrapText ( ) const
inline
Returns
current word wrap behavior for this object

Member Data Documentation

float _border
protected

The border offset in logical units for this object. Defines the size of the empty space between the outline of the box and its text

float _cellHeight
protected

Height of each character cell in the grid in logical units

float _cellWidth
protected

Width of each character cell in the grid in logical units

CharAttrCont_t _chars
protected

Container of character attributes

bool _constrainRatio
protected

Only effective when _controlCellSize is true. Whether or not to constrain cell size ratio when changing cell height or width.

bool _controlCellSize
protected

If true, font size does not control cell size

GlsFontBase* _font
protected

Current font being used for the text

glsColor _haloColor
protected

Color of the halo effect behind the characters

Justify_t _justify
protected

Justification setting (LEFT, RIGHT, CENTER)

float _lineSpacing
protected

Line spacing between grid rows as a percentage

bool _lockCellSize
protected

Only effective when _controlCellSize is true. If true, changes to rows, columns, border, line spacing, column spacing, etc. will not change the cell size. Normally, when _controlCellSize is true these attributes affect the cell size.

bool _needToRebuild
protected

This is set to true whenever an attribute changes that will affect the size of the grid or its cells.

std::auto_ptr< RuntimeGlyphGenerationText > _runtimeGlyphGenerationText
protected

Pointer to the internal data needed for runtime glyph generation.

glsColor _shadowColor
protected

Color of the shadow effect behind the characters

Vector _shadowOffset
protected

Offset of the shadow effect from the characters. Z component is ignored.

std::string _text
protected

String of text to be displayed.

bool _uppercase
protected

If true, all characters will be displayed in uppercase

Vector _Vx
protected

Direction vector indicating direction of horizontal travel for rendering

Vector _Vy
protected

Direction vector indicating direction of vertical travel for rendering

Vector _Vz
protected

Normal to the Vx Vy plane

bool _wrapText
protected

Whether or not to word wrap text


The documentation for this class was generated from the following file: