GL Studio C++ Runtime API
GlsCTLTextBox Class Reference

The Gls CTL (Complex Text Layout) Text Box. More...

#include <gls_ctl_text_box.h>

Inheritance diagram for GlsCTLTextBox:
GlsText GLPolygon DisplayObject AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable

Classes

struct  GlyphMetrics
 

Public Types

enum  VerticalAlignment_t
 
enum  VerticalAlignmentCTL_t
 
enum  EllipsizeMode_t
 
enum  TextDirection_t
 
- Public Types inherited from GlsText
enum  Justify_t
 Different text justifications.
 
- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum
 

Public Member Functions

 GlsCTLTextBox ()
 
 GlsCTLTextBox (const GlsCTLTextBox &that, const bool generateNames)
 
virtual ~GlsCTLTextBox ()
 
virtual void SetAvailableAttributes (unsigned int value)
 
virtual DisplayObjectCloneObject (bool generateNames=false)
 
virtual void CopyGeometry (DisplayObject *src)
 
virtual void CopyProperties (DisplayObject *src)
 
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler)
 
virtual void Draw ()
 
virtual void SetVertices (unsigned int nPoints, Vertex *vertices)
 
virtual void Scale (float px, float py, float pz, Vertex *anchor, int handleBar)
 
virtual void VaString (const char *format,...)
 
virtual void VerticalAlignment (VerticalAlignment_t verticalAlignment)
 
virtual VerticalAlignment_t VerticalAlignment ()
 
virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
 
virtual void Rebuild ()
 
virtual EllipsizeMode_t EllipsizeMode ()
 
virtual void EllipsizeMode (const EllipsizeMode_t ellipsizeMode)
 
virtual unsigned int GetLineCount ()
 
virtual unsigned int GetGlyphCount ()
 
virtual GlyphMetrics GetGlyphMetrics (const unsigned int glyphIndex)
 
virtual void SetLayoutAutoDir (bool)
 
virtual void SetAltWidth (float width)
 
virtual void SetAltHeight (float height)
 
virtual void TextHorizontalScale (float value)
 
virtual float TextHorizontalScale ()
 
virtual void TextVerticalScale (float value)
 
virtual float TextVerticalScale ()
 
virtual TextDirection_t TextDirection ()
 
virtual void TextDirection (const TextDirection_t textDirection)
 
bool RequiresFontFile () const DISTI_METHOD_OVERRIDE
 
- Public Member Functions inherited from GlsText
 GlsText ()
 
virtual ~GlsText ()
 
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
 
void Erase ()
 
void FauxBold (const bool &bold)
 
bool FauxBold ()
 
GlsFontBaseFont () const
 
void Font (GlsFontBase *font)
 
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, const Vertex *vertices)
 
 GLPolygon (unsigned int nPoints, const Vertex *vertices, const Vertex &location)
 
 GLPolygon (void)
 
 GLPolygon (const GLPolygon &polygon, const bool generateNames)
 
virtual ~GLPolygon (void)
 
void ConfigureMetaData (void)
 
virtual void CalculateTextureCoordinates (void)
 
virtual void CalcNormals (int windingOrder=1)
 
virtual void DeleteVertexAt (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 void DeleteVertex (unsigned int indexAfter) final
 
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 void GenerateInstanceName (void)
 
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 InsertVertexAt (unsigned int index)
 
virtual void InsertVertex (unsigned int indexAfter) final
 
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)
 
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 () const
 
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 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 ()
 
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) override
 
virtual void SetPainter (GlsPainter *painter)
 
virtual GlsPainterGetPainter ()
 
void InvalidatePainter ()
 
virtual bool IsVisibleInScene (const DisplayObject *obj=NULL) const
 
- Public Member Functions inherited from AttributeChangedNotifier
virtual ~AttributeChangedNotifier ()
 
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef) override
 
void NotifyWeakReferenceDestroyed (WeakReference *ref) override
 

Static Public Attributes

static const unsigned int INTERNAL_BORDER = 1
 

Protected Member Functions

void AdjustImageVertsAndCoords (PangoRect &verts, PangoRect &texCoords)
 
virtual void DrawText ()
 
virtual void RecalcVertices ()
 
- Protected Member Functions inherited from GlsText
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 _altWidth
 
float _altHeight
 
float _textHorizontalScale
 
float _textVerticalScale
 
ScopedPtr< GlsPangoWrapper > _glsPangoWrapper
 
- Protected Attributes inherited from GlsText
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
 
ScopedPtr< 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
 

Additional Inherited Members

- Static Public Member Functions inherited from GlsText
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)
 

Detailed Description

The Gls CTL (Complex Text Layout) Text Box.

On certain platforms, the text layout library is unavailable, and complex text rendering in the runtime will be missing.

To account for this, the GlsCTLTextBox will 'Fallback' to being treated as a GlsTextBox. In those cases, certain GlsCTLTextBox functions will not have no effect.

Member Enumeration Documentation

The ellipsize mode types.

The text direction types. TEXT_DIRECTION_LTR - Use Left to Right as the base direction for rendering text. TEXT_DIRECTION_RTL - Use Right to Left as the base direction for rendering text. TEXT_DIRECTION_AUTOMATIC - Determine the base direction for rendering text from the first strongly directioned character. TEXT_DIRECTION_AUTO_BY_LINE - Determine the base direction for rendering text for each individual EOL-seperated line in the text string.

The vertical alignment types.

Deprecated

Constructor & Destructor Documentation

Default constructor.

GlsCTLTextBox ( const GlsCTLTextBox that,
const bool  generateNames 
)

The copy constructor for GlsCTLTextBox

Parameters
thatThe GlsCTLTextBox object that is being copied
generateNamesWhether or not to generate a new instance name
virtual ~GlsCTLTextBox ( )
virtual

Destructor.

Member Function Documentation

void AdjustImageVertsAndCoords ( PangoRect &  verts,
PangoRect &  texCoords 
)
protected

makes adjustment to the image verts and texture coords for the alt width / height and text scaling properties

Parameters
[in,out]vertsthe image verts
[in,out]texCoordsthe image texture coords
virtual DisplayObject* CloneObject ( bool  generateNames = false)
virtual

Copy+Create operation in one method. In derived classes, this method will create a new instance of the derived class and then copy the object into the new instance. The cut,copy,paste and undo operations use this method.

Parameters
generateNamesWhether or not to generate new names for cloned objects
Returns
A new object, identical to the original, except for the instance name

Reimplemented from GLPolygon.

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

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

virtual void Draw ( )
virtual

Draws this object on the current display frame (_parent member).

Reimplemented from GLPolygon.

virtual void DrawText ( )
protectedvirtual

Draws the polygons that make up the characters.

virtual EllipsizeMode_t EllipsizeMode ( )
virtual

Gets the type of automatic ellipsize if the text does not fit in the boundary.

Returns
The type of automatic ellipsize if the text does not fit in the boundary.
Note
In CTL Fallback mode, returns ELLIPSIZE_MODE_NONE.
virtual void EllipsizeMode ( const EllipsizeMode_t  ellipsizeMode)
virtual

Sets the type of automatic ellipsize if the text does not fit in the boundary.

Parameters
[in]ellipsizeModeThe type of automatic ellipsize if the text does not fit in the boundary.
Note
In CTL Fallback mode, has no effect.
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 GlsText.

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

virtual unsigned int GetGlyphCount ( )
virtual

Gets the number of glyphs in the layout.

Returns
The number of glyphs in the layout.
Note
In CTL Fallback mode, returns 0.
virtual GlyphMetrics GetGlyphMetrics ( const unsigned int  glyphIndex)
virtual

Gets the glyph metrics for the given glyph index.

Parameters
[in]glyphIndexThe index of the glyph in the layout line to get the glyph metrics for.
Returns
The glyph metrics for the given glyph index.
Note
In CTL Fallback mode, returns a default GlyphMetrics struct.
virtual unsigned int GetLineCount ( )
virtual

Gets the number of lines in the layout.

Returns
The number of lines in the layout.
Note
In CTL Fallback mode, returns 0.
virtual void PreDraw ( const OpenGLMatrices current,
Culler culler 
)
virtual

Traverses the hierarchy calculating the _modelMatrix, _projMatrix, _viewMatrix as needed.

Parameters
currentCurrent matrices inherited from parent
cullerObject that possibly marks this object for culling

Reimplemented from DisplayObject.

virtual void Rebuild ( )
virtual

Rebuilds this text box layout. This may be an expensive call, so it should only be called when a property changes.

Note
In CTL Fallback mode, GlsText::SetRebuild will be called instead, as this is a protected method in GlsTextBox.
virtual void RecalcVertices ( )
protectedvirtual

Rebuilds the vertices of the text box.

bool RequiresFontFile ( ) const
inlinevirtual
See also
GlsText

Reimplemented from GlsText.

virtual void Scale ( float  px,
float  py,
float  pz,
Vertex anchor,
int  handleBar 
)
virtual

Scales the object, either the handleBar, or the Anchor is used to translate the object, not both. Anchor takes presidence, if it is set HandleBar is ignored. The footprint is different from the 2D scale so the compiler can destinguish the two.

Parameters
pxValue of the percentage of scale in x-axis
pyValue of the percentage of scale in y-axis
pzValue of the percentage of scale in z-axis
anchorAnchor from which to scale object relative to
handleBarVertex that is being dragged

Reimplemented from DisplayObject.

virtual void SetAltHeight ( float  height)
virtual

Set height used to render the text. If the height of the vertices is smaller than this height, the text will be truncated. If the value is 0.0, the text will be rendered to the full height of the vertices

Note
In CTL Fallback mode, has no effect.
virtual void SetAltWidth ( float  width)
virtual

Set width used to render the text. If the width of the vertices is smaller than this width, the text will be truncated. If the value is 0.0, the text will be rendered to the full width of the vertices

Note
In CTL Fallback mode, has no effect.
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 GlsText.

virtual void SetLayoutAutoDir ( bool  )
inlinevirtual

Set the Pango Layout auto dir, exposes pango_layout_set_auto_dir () see: https://developer.gnome.org/pango/stable/pango-Layout-Objects.html#pango-layout-set-auto-dir

Parameters
[in]autoDirWhether or not the layout should automatically determine base direction based on content
Note
In CTL Fallback mode, has no effect.
Deprecated:
virtual void SetVertices ( unsigned int  nPoints,
Vertex vertices 
)
virtual

Sets the vertex data for this polygon You should call UpdateBoundingVolume after changing an object's extents.

See also
UpdateBoundingVolume
Parameters
nPointsThe number of vertices in the object
verticesThe vertex data for the object

Reimplemented from DisplayObject.

virtual TextDirection_t TextDirection ( )
virtual

Gets the base direction used in applying the Unicode bidirectional algorithm.

Returns
the text direction
Note
In CTL Fallback mode, returns TEXT_DIRECTION_AUTOMATIC.
virtual void TextDirection ( const TextDirection_t  textDirection)
virtual

Sets the base direction used in applying the Unicode bidirectional algorithm.

Parameters
[in]textDirectionThe text direction.
Note
In CTL Fallback mode, has no effect.
virtual void TextHorizontalScale ( float  value)
virtual

Scales the text horizontally by the given value. Text is still clamped by the bounds of the text box

Parameters
valuethe horizontal scale
virtual float TextHorizontalScale ( )
virtual

Get the horizontal scale

virtual void TextVerticalScale ( float  value)
virtual

Scales the text vertically by the given value. Text is still clamped by the bounds of the text box

Parameters
valuethe vertical scale
virtual float TextVerticalScale ( )
virtual

Get the vertical scale

virtual void VaString ( const char *  format,
  ... 
)
virtual

Print a string into this text object. Replaces the entire string.

Parameters
formatprintf style varargs formatting string.
virtual void VerticalAlignment ( VerticalAlignment_t  verticalAlignment)
virtual

Set the vertical alignment for this text object

Parameters
[in]verticalAlignmentThe vertical alignment type.
virtual VerticalAlignment_t VerticalAlignment ( )
virtual

Get the vertical alignment for this text object

Returns
The vertical alignment type.

Member Data Documentation

float _altHeight
protected

Height used to render the text

float _altWidth
protected

Width used to render the text

ScopedPtr<GlsPangoWrapper> _glsPangoWrapper
protected

Pointer to the internal data needed for Pango.

float _textHorizontalScale
protected

the horizontal scale

float _textVerticalScale
protected

the vertical scale

const unsigned int INTERNAL_BORDER = 1
static

The internal border between the layout edges and the glyph edges. This will keep the glyph edges from appearing cut-off when linear texture filtering is applied.


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