This is a base class for render layers that render text. More...

#include <textlayer.h>

Inheritance diagram for Mezzanine::UI::TextLayer:

Collaboration diagram for Mezzanine::UI::TextLayer:

Public Types
typedef std::list< Character * >	CharacterContainer
	Basic container type for the storage of Character instances by this class.

typedef CharacterContainer::iterator	CharacterIterator
	Iterator type for Character instances stored by this class.

typedef std::pair < CharacterIterator, CharacterIterator >	CharacterIteratorPair
	An std::pair type storing two character iterators, usually used to express a range.

typedef std::pair< Boolean, Integer >	CharIndexPair
	An std::pair type used as a return for index-offset conversions.

typedef std::pair< Boolean, Vector2 >	CharOffsetPair
	An std::pair type used as a return for index-offset conversions.

typedef CharacterContainer::const_iterator	ConstCharacterIterator
	Const Iterator type for Character instances stored by this class.

typedef CharacterContainer::const_reverse_iterator	ConstReverseCharacterIterator
	Const Reverse Iterator type for Character instances stored by this class.

typedef TextLineContainer::const_iterator	ConstTextLineIterator
	Const Iterator type for TextLine instances stored by this class.

typedef CharacterContainer::reverse_iterator	ReverseCharacterIterator
	Reverse Iterator type for Character instances stored by this class.

enum	ScalingMode { SM_NoAutoScaling = 0, SM_ScreenRelative = 1, SM_ParentRelative = 2, SM_LayerRelative = 3 }

typedef std::vector< TextLine * >	TextLineContainer
	Basic container type for the storate of TextLine instances by this class.

typedef TextLineContainer::iterator	TextLineIterator
	Iterator type for TextLine instances stored by this class.

Public Types inherited from Mezzanine::UI::RenderLayer
enum	RenderLayerType { RLT_Image, RLT_MultiLineText, RLT_SingleLineText }
	This enum describes the type of RenderLayer this is for use in casting.

Public Member Functions
CharacterIterator	BeginCharacter ()
	Gets an iterator to the first Character. More...

ConstCharacterIterator	BeginCharacter () const
	Gets a const iterator to the first Character. More...

virtual TextLineIterator	BeginTextLine ()
	Gets an iterator to the first TextLine. More...

virtual ConstTextLineIterator	BeginTextLine () const
	Gets a const iterator to the first TextLine. More...

virtual void	ClearAllTextLines ()
	Removes all characters from all TextLines belonging to this layer.

virtual void	ClearHighlights ()
	Clears all the highlights in this layer.

virtual TextLine *	CreateTextLine ()
	Creates a new TextLine. More...

virtual void	DestroyAllCharacters ()
	Destroy's all characters in this TextLayer.

virtual void	DestroyAllTextLines ()
	Destroys all TextLines in this layer.

CharacterIterator	EndCharacter ()
	Gets an iterator to one passed the last Character. More...

ConstCharacterIterator	EndCharacter () const
	Gets an iterator to one passed the last Character. More...

virtual TextLineIterator	EndTextLine ()
	Gets an iterator to one passed the last TextLine. More...

virtual ConstTextLineIterator	EndTextLine () const
	Gets a const iterator to one passed the last TextLine. More...

virtual const ColourValue &	GetActiveHighlightBackgroundColour () const
	Gets the colour of the highlight when the quad is being focused. More...

virtual Real	GetAutoTextScalar () const
	Gets the relative scalar being used to automatically scale text generated by this layer. More...

virtual TextLayer::ScalingMode	GetAutoTextScalingMode () const
	Gets the automatic scaling mode being used by this textlayer. More...

virtual Character *	GetCharacterAtIndex (const Integer Index) const
	Gets a Character by index. More...

virtual Character *	GetCharacterAtOffset (const Vector2 &Offset) const
	Gets a Character by offset position. More...

virtual CharacterIterator	GetCharacterIteratorAtIndex (const Integer Index)
	Gets an iterator to the character at the specified index. More...

virtual ConstCharacterIterator	GetCharacterIteratorAtIndex (const Integer Index) const
	Gets a const iterator to the character at the specified index. More...

virtual TextCursor *	GetCursor () const
	Gets the TextCursor in use by this layer. More...

virtual bool	GetCursorEnabled () const
	Gets whether or not the Text Cursor is enabled. More...

virtual FontData *	GetDefaultFont ()
	Gets the default font in use by this layer. More...

virtual String	GetDerivedSerializableName () const
	Gets the most derived serializable name of this Renderable. More...

virtual Real	GetDesiredLineHeight () const
	Gets the height in pixels this layer is configured to render it's text. More...

virtual Integer	GetHighlightEnd () const
	Gets the index of this last character that is highlighted in this layer. More...

virtual Integer	GetHighlightStart () const
	Gets the index of the first character that is highlighted in this layer. More...

virtual const ColourValue &	GetInactiveHighlightBackgroundColour () const
	Gets the colour of the highlight when the quad is being focused. More...

virtual CharIndexPair	GetIndexAtOffset (const Vector2 &Offset)
	Gets the index of the character at the specified offset position. More...

virtual const Vector2 &	GetManualTextScale () const
	Gets the scaling currently being applied to the rendered text. More...

virtual MarkupParser *	GetMarkupParser () const
	Gets the MarkupParser being used by this TextLayer. More...

virtual Whole	GetNumCharacters () const
	Gets the number of characters being rendered by this TextLayer. More...

virtual UInt32	GetNumTextLines () const
	Gets the number of TextLines this layer contains. More...

virtual CharOffsetPair	GetOffsetAtIndex (const Integer Index)
	Gets the offset position of the character at the provided index. More...

virtual String	GetText () const
	Gets the text displayed within this layer. More...

virtual const ColourValue &	GetTextColour () const
	Gets the default colour of the tect being rendered by this layer. More...

virtual TextLine *	GetTextLineAtOffset (const Real &Offset)
	Gets the TextLine at the specified offset position. More...

virtual UI::LinearAlignment	GetTextlineVerticalAlignment () const
	Gets the current set alignment for positioning textlines in this layer. More...

virtual UI::TextOrdering	GetTextOrder () const
	Gets the currently set direction of advancement for characters on the horizontal axis created by this layer. More...

virtual Real	GetTotalHeight () const
	Gets the combined height of all the text lines in this layer. More...

virtual void	Highlight ()
	Highlights all characters in this layer.

virtual void	Highlight (const Integer Index)
	Highlights the character at the specified index. More...

virtual void	Highlight (const Integer StartIndex, const Integer EndIndex)
	Highlights all characters in a provided range. More...

virtual void	InsertCharacterAtIndex (const Integer Index, const UInt32 GlyphID)
	Creates a character from a Glyph ID and inserts it into the layer at the specified index. More...

virtual void	InsertCharactersAtIndex (const Integer Index, const Char8 *Characters, const UInt32 BufSize)
	Creates a series of characters from a UTF-8 encoded string to be inserted into this layer. More...

virtual void	InsertCharactersAtIndex (const Integer Index, const UInt32 *Characters, const UInt32 BufSize)
	Creates a series of characters from a UTF-32 encoded string to be inserted into this layer. More...

virtual void	PopulateTextLines ()
	Populates text lines in this layer with parsed characters.

virtual void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...

virtual void	ProtoDeSerializeCursor (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the TextCursor of this object with it. More...

virtual void	ProtoDeSerializeProperties (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the properties of this object with it. More...

virtual void	ProtoDeSerializeText (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the Text of this object with it. More...

virtual void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...

virtual void	ProtoSerializeCursor (XML::Node &SelfRoot) const
	Convert the TextCursor of this class to an XML::Node ready for seriailization. More...

virtual void	ProtoSerializeProperties (XML::Node &SelfRoot) const
	Convert the properties of this class to an XML::Node ready for serialization. More...

virtual void	ProtoSerializeText (XML::Node &SelfRoot) const
	Convert the Text of this class to an XML::Node ready for serialization. More...

virtual void	RemoveCharacterAtIndex (const Integer Index)
	Removes a character from the layer at the specified index. More...

virtual void	RemoveCharacterRange (const Integer First, const Integer Last)
	Removes a range of characters from the text in this layer. More...

virtual void	RemoveCharactersAtIndex (const Integer Index, const UInt32 Length)
	Removes a length of characters from this layer at the specified index. More...

virtual void	SetActiveHighlightBackgroundColour (const ColourValue &Colour)
	Sets the colour of the highlight when the quad is being focused. More...

virtual void	SetAutoTextScale (const TextLayer::ScalingMode Mode, const Real Scalar)
	Sets the mode and scaler of auto-scaling applied to the text generated by this textlayer. More...

virtual void	SetCursorEnabled (bool Enable)
	Enables (or disables) the cursor for use in this layer. More...

virtual void	SetDefaultFont (FontData *NewFont)
	Sets the default font to be used with this layer. More...

virtual void	SetDefaultFont (const String &FontName)
	Sets the default font to be used with this layer. More...

virtual void	SetDefaultFont (const String &FontName, const String &Atlas)
	Sets the default font to be used with this layer. More...

virtual void	SetInactiveHighlightBackgroundColour (const ColourValue &Colour)
	Sets the colour of the highlight when the quad is not focused. More...

virtual void	SetManualTextScale (const Vector2 &Scale)
	Sets the scaling to be applied to the text being rendered. More...

virtual bool	SetMarkupParser (MarkupParser *Parser)
	Sets the MarkupParser to be used by this TextLayer. More...

virtual bool	SetMarkupParser (const String &ParserName)
	Sets the MarkupParser to be used by this TextLayer via it's registered name. More...

virtual void	SetScale (const Vector2 &Scaling)
	Sets the scaling to be applied to this render layer. More...

virtual void	SetText (const String &Text)
	Sets the text displayed within this layer. More...

virtual void	SetTextColour (const ColourValue &Colour)
	Sets the default colour of the text being rendered by this layer. More...

virtual void	SetTextlineVerticalAlignment (const UI::LinearAlignment Align)
	Sets the alignment used to determine the start position of the textlines in this layer. More...

virtual void	SetTextOrder (const UI::TextOrdering Order)
	Sets the ordering for characters in this layer. More...

Public Member Functions inherited from Mezzanine::UI::RenderLayer
virtual	~RenderLayer ()
	Class destructor.

virtual void	_MarkDirty ()
	Marks this renderable as well as all parent objects as dirty. More...

virtual void	_UpdateIndex (const Whole Index)
	Notifies this RenderLayer that it's index in the parent QuadRenderable has been updated. More...

virtual Rect	GetAreaRect () const
	Gets a rect containing the actual position and size of this layer. More...

virtual Whole	GetIndex () const
	Gets the index position of this RenderLayer in it's parent. More...

virtual RenderLayerType	GetLayerType () const =0
	Gets the type of render layer this is. More...

virtual QuadRenderable *	GetParent () const
	Gets the parent of this render layer. More...

virtual Real	GetRotationDegrees () const
	Gets the current rotation applied to this renderable in degrees. More...

virtual Real	GetRotationRadians () const
	Gets the current rotation applied to this renderable in radians. More...

virtual Vector2	GetScale () const
	Gets the scaling currently applied to this render layer. More...

virtual Screen *	GetScreen () const
	Gets the screen the parent renderable is being rendered on. More...

virtual void	NotifyActive ()
	Notifies this RenderLayer that the group this layer belongs to has become the active group. More...

virtual void	NotifyInactive ()
	Notifies this RenderLayer that the group this layer belongs to is no longer the active group. More...

virtual void	SetRotationDegrees (const Real &Degrees)
	Sets the rotation to be applied to this renderable. More...

virtual void	SetRotationRadians (const Real &Radians)
	Sets the rotation to be applied to this renderable. More...

Static Public Member Functions
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::UI::RenderLayer
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::UI::QuadRenderer
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::UI::SimpleRenderer
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...

Protected Member Functions
	TextLayer (QuadRenderable *ParentRenderable)
	No-Font constructor. More...

	TextLayer (const String &FontName, QuadRenderable *ParentRenderable)
	Class constructor. More...

	TextLayer (const Real &LineHeight, QuadRenderable *ParentRenderable)
	Text-Scaling constructor. More...

virtual	~TextLayer ()
	Class destructor.

virtual CharIndexPair	GetIndexAtOffsetImpl (const Vector2 &Position)=0
	Gets the index of the character at the specified offset position. More...

virtual CharOffsetPair	GetOffsetAtIndexImpl (const Integer Index)=0
	Gets the position of the character at the specified index. More...

virtual void	PopulateTextLinesImpl ()=0
	Clears and then places characters belonging to this layer in the appropriate text lines. More...

virtual void	RecalculateOffsets ()
	Recalculates the offset for every text line in this layer. More...

virtual void	RedrawImpl (bool Force)
	Provides the class specific implementation for regenerating vertices for this renderable. More...

Protected Member Functions inherited from Mezzanine::UI::RenderLayer
	RenderLayer (QuadRenderable *ParentRenderable)
	Class constructor. More...

virtual void	RotationTransform (Vector2 &Point, const Vector2 &RotationCenter)
	Applies rotation to a point in 2D space. More...

virtual void	RotationTransform (Vector2 &TopLeft, Vector2 &TopRight, Vector2 &BottomLeft, Vector2 &BottomRight)
	Applies rotation to a quad in 2D space. More...

Protected Member Functions inherited from Mezzanine::UI::QuadRenderer
	QuadRenderer ()
	Class constructor.

virtual	~QuadRenderer ()
	Class destructor.

virtual void	PushQuad (Vector2 Positions, Vector2 UVs, ColourValue *Colours, const String &Atlas)
	Pushes vertex information for a quad to a vector. Equivalent to calling "PushTriangle" twice.

virtual void	PushQuad2 (Vector2 Positions, Vector2 UVs, const ColourValue &Colour, const String &Atlas)
	Pushes vertex information for a quad to a vector. Equivalent to calling "PushTriangle" twice.

Protected Member Functions inherited from Mezzanine::UI::SimpleRenderer
	SimpleRenderer ()
	Class constructor.

virtual	~SimpleRenderer ()
	Class destructor.

virtual void	PushTriangle (const Vector2 &A, const Vector2 &B, const Vector2 &C, const Vector2 &UV, const ColourValue &Colour, const String &Atlas)
	Pushes vertex information for a triangle to a vector. Equivalent to calling "PushVertex" three times. More...

virtual void	PushVertex (const Real &X, const Real &Y, const Vector2 &UV, const ColourValue &Colour, const String &Atlas)
	Collects all the relevant information for a single vertex and pushes it to a vector. More...

Protected Attributes
ColourValue	ActiveHLColour
	The colour of the highlight when this layer belongs to a focused widget. More...

Real	AutoCharScaling
	The auto-scaling height the text is to be in relative units. More...

ScalingMode	AutoCharScalingMode
	The auto-scaling mode that is to be used on text generated by this textlayer. More...

CharacterContainer	Characters
	Container with all this layers Characters. More...

TextCursor *	Cursor
	The cursor to be used for insert and manipulation operations. More...

CharacterTraits	DefaultCharTraits
	Default set of traits all characters generated inside this layer are to have. More...

Integer	HighlightEnd
	The index of the character at the end of the highlight sequence. More...

Integer	HighlightStart
	The index of the character at the start of the highlight sequence. More...

UI::TextOrdering	HorizontalOrder
	The order text will have in TextLines. More...

ColourValue	InactiveHLColour
	The colour of the highlight when this layer belongs to a widget not being focused. More...

Vector2	ManualCharScaling
	The scaling to apply to all characters in this layer. More...

MarkupParser *	MUParser
	The parser to use when converting raw strings to renderable characters. More...

Boolean	ScalingChanged
	Flag indicating the scaling for the layer has been altered. More...

TextLineContainer	TextLines
	Container with all this layers TextLines. More...

TokenString *	TextTokens
	The actual text parsed into tokens used for generating characters. More...

UI::LinearAlignment	VerticalAlign
	The alignment TextLines will have. More...

Protected Attributes inherited from Mezzanine::UI::RenderLayer
Whole	IndexID
	Stores the index of this RenderLayer in it's parent QuadRenderable. More...

QuadRenderable *	Parent
	A pointer to the parent of this RenderLayer. More...

Real	RotAngle
	The amount of rotation to be applied to this RenderLayer in radians. More...

Vector2	Scale
	The scaling applied to this RenderLayer. More...

Detailed Description

This is a base class for render layers that render text.

Definition at line 64 of file textlayer.h.

Member Enumeration Documentation

enum Mezzanine::UI::TextLayer::ScalingMode

Enumerator
SM_NoAutoScaling	There is no auto-scaling applied to text in this layer. Any scaling has to be done explicitly.
SM_ScreenRelative	The provided scaler will be treated as relative to the Screen Y size.
SM_ParentRelative	The provided scaler will be treated as relative to the parent widget Y size.
SM_LayerRelative	The provided scaler will be treated as relative to this layers Y size after layer scaling.

Definition at line 92 of file textlayer.h.

Constructor & Destructor Documentation

Mezzanine::UI::TextLayer::TextLayer ( QuadRenderable * ParentRenderable)

protected

No-Font constructor.

Parameters

ParentRenderable The renderable that created this layer.

Definition at line 61 of file textlayer.cpp.

Mezzanine::UI::TextLayer::TextLayer	(	const String &	FontName,
		QuadRenderable *	ParentRenderable
	)

protected

Class constructor.

Parameters

FontName	The name of the font to use for this layer.
ParentRenderable	The renderable that created this layer.

Definition at line 94 of file textlayer.cpp.

Mezzanine::UI::TextLayer::TextLayer	(	const Real &	LineHeight,
		QuadRenderable *	ParentRenderable
	)

protected

Text-Scaling constructor.

Note: This constructor defaults to Screen Relative text, but this can be altered after construction.

Parameters

LineHeight	The relative scalar to be used when determining the size of characters generated by this text layer.
ParentRenderable	The renderable that created this layer.

Definition at line 128 of file textlayer.cpp.

Member Function Documentation

TextLayer::CharacterIterator Mezzanine::UI::TextLayer::BeginCharacter ( )

Gets an iterator to the first Character.

Returns: Returns an iterator to the first Character being stored by this TextLine.

Definition at line 868 of file textlayer.cpp.

TextLayer::ConstCharacterIterator Mezzanine::UI::TextLayer::BeginCharacter ( ) const

Gets a const iterator to the first Character.

Returns: Returns a const iterator to the first Character being stored by this TextLine.

Definition at line 874 of file textlayer.cpp.

TextLayer::TextLineIterator Mezzanine::UI::TextLayer::BeginTextLine ( )

virtual

Gets an iterator to the first TextLine.

Returns: Returns an iterator to the first TextLine being stored by this TextLayer.

Definition at line 708 of file textlayer.cpp.

TextLayer::ConstTextLineIterator Mezzanine::UI::TextLayer::BeginTextLine ( ) const

virtual

Gets a const iterator to the first TextLine.

Returns: Returns a const iterator to the first TextLine being stored by this TextLayer.

Definition at line 714 of file textlayer.cpp.

TextLine * Mezzanine::UI::TextLayer::CreateTextLine ( )

virtual

Creates a new TextLine.

Returns: Returns a pointer to the created TextLine.

Definition at line 632 of file textlayer.cpp.

TextLayer::CharacterIterator Mezzanine::UI::TextLayer::EndCharacter ( )

Gets an iterator to one passed the last Character.

Returns: Returns an iterator to one passed the last Character being stored by this TextLine.

Definition at line 871 of file textlayer.cpp.

TextLayer::ConstCharacterIterator Mezzanine::UI::TextLayer::EndCharacter ( ) const

Gets an iterator to one passed the last Character.

Returns: Returns an iterator to one passed the last Character being stored by this TextLine.

Definition at line 877 of file textlayer.cpp.

TextLayer::TextLineIterator Mezzanine::UI::TextLayer::EndTextLine ( )

virtual

Gets an iterator to one passed the last TextLine.

Returns: Returns an iterator to one passed the last TextLine being stored by this TextLayer.

Definition at line 711 of file textlayer.cpp.

TextLayer::ConstTextLineIterator Mezzanine::UI::TextLayer::EndTextLine ( ) const

virtual

Gets a const iterator to one passed the last TextLine.

Returns: Returns a const iterator to one passed the last TextLine being stored by this TextLayer.

Definition at line 717 of file textlayer.cpp.

const ColourValue & Mezzanine::UI::TextLayer::GetActiveHighlightBackgroundColour ( ) const

virtual

Gets the colour of the highlight when the quad is being focused.

Returns: Returns a const ColourValue reference containing the colour used to render highlights while the parent quad is focused.

Definition at line 498 of file textlayer.cpp.

Real Mezzanine::UI::TextLayer::GetAutoTextScalar ( ) const

virtual

Gets the relative scalar being used to automatically scale text generated by this layer.

Returns: Returns a Real representing the relative Y size to use when detmining how to uniformly scale text in this layer.

Definition at line 452 of file textlayer.cpp.

TextLayer::ScalingMode Mezzanine::UI::TextLayer::GetAutoTextScalingMode ( ) const

virtual

Gets the automatic scaling mode being used by this textlayer.

Returns: Returns a ScalingMode enum value describing what the relative scaler is relative to, if auto-scaling is enabled at all.

Definition at line 447 of file textlayer.cpp.

Character * Mezzanine::UI::TextLayer::GetCharacterAtIndex ( const Integer Index) const

virtual

Gets a Character by index.

Note: The index is counted from the left to the right, regardless of text order.

Parameters

Index The index of the Character to retrieve.

Returns: Returns a pointer to the requested Character.

Definition at line 723 of file textlayer.cpp.

Character * Mezzanine::UI::TextLayer::GetCharacterAtOffset ( const Vector2 & Offset) const

virtual

Gets a Character by offset position.

Warning: Depending on what has been updated there is a chance this may not get the proper character for the current configuration until after the next frame is drawn. In most cases this will be safe, but may not always be.

Parameters

Offset The position relative to the top-left corner of this layer.

Returns: Returns a pointer to the character under the provided position, or NULL if the position is invalid.

Todo:: The way this logic works, in the event of a slight bit of clipping at the bottom of the quad space that isn't enough for the next line, this logic will assume that space is a part of the last line. Is that a problem?

Todo:: In the event that letter spacing for the font is big ( >0 ), and the point provided rests on a gap in the spacing, this algorithm will grab the character to the right as the hovered character. Is that a problem?

Definition at line 728 of file textlayer.cpp.

TextLayer::CharacterIterator Mezzanine::UI::TextLayer::GetCharacterIteratorAtIndex ( const Integer Index)

virtual

Gets an iterator to the character at the specified index.

Parameters

Index The index of the Character to retrieve.

Returns: Returns an iterator to the requested Character.

Definition at line 764 of file textlayer.cpp.

TextLayer::ConstCharacterIterator Mezzanine::UI::TextLayer::GetCharacterIteratorAtIndex ( const Integer Index) const

virtual

Gets a const iterator to the character at the specified index.

Parameters

Index The index of the Character to retrieve.

Returns: Returns a const iterator to the requested Character.

Definition at line 780 of file textlayer.cpp.

TextCursor * Mezzanine::UI::TextLayer::GetCursor ( ) const

virtual

Gets the TextCursor in use by this layer.

Returns: Returns a pointer to this layers TextCursor, or NULL if it is disabled.

Definition at line 624 of file textlayer.cpp.

bool Mezzanine::UI::TextLayer::GetCursorEnabled ( ) const

virtual

Gets whether or not the Text Cursor is enabled.

Returns: Returns true if the cursor is being rendered, false otherwise.

Definition at line 619 of file textlayer.cpp.

FontData * Mezzanine::UI::TextLayer::GetDefaultFont ( )

virtual

Gets the default font in use by this layer.

The font is defined in your mta file.

Returns: Returns a pointer to the font in use by this layer.

Definition at line 482 of file textlayer.cpp.

String Mezzanine::UI::TextLayer::GetDerivedSerializableName ( ) const

virtual

Gets the most derived serializable name of this Renderable.

Note: When creating a new Renderable class verify this method has a valid return for it in order for serialization to work properly.

Returns: Returns the name of the XML tag from the most derived class of "this".

Reimplemented from Mezzanine::UI::RenderLayer.

Reimplemented in Mezzanine::UI::SingleLineTextLayer, and Mezzanine::UI::MultiLineTextLayer.

Definition at line 1049 of file textlayer.cpp.

Real Mezzanine::UI::TextLayer::GetDesiredLineHeight ( ) const

virtual

Gets the height in pixels this layer is configured to render it's text.

Returns: Returns a Real representing the pixel height of text lines in this layer that is desired.

Definition at line 352 of file textlayer.cpp.

Integer Mezzanine::UI::TextLayer::GetHighlightEnd ( ) const

virtual

Gets the index of this last character that is highlighted in this layer.

Returns: Returns the index of the last character in the highlighted range, or -1 if nothing is highlighted.

Definition at line 556 of file textlayer.cpp.

Integer Mezzanine::UI::TextLayer::GetHighlightStart ( ) const

virtual

Gets the index of the first character that is highlighted in this layer.

Returns: Returns the index of the first character in the highlighted range, or -1 if nothing is highlighted.

Definition at line 551 of file textlayer.cpp.

const ColourValue & Mezzanine::UI::TextLayer::GetInactiveHighlightBackgroundColour ( ) const

virtual

Gets the colour of the highlight when the quad is being focused.

Returns: Returns a const ColourValue reference containing the colour used to render highlights while the parent quad is not focused.

Definition at line 511 of file textlayer.cpp.

TextLayer::CharIndexPair Mezzanine::UI::TextLayer::GetIndexAtOffset ( const Vector2 & Offset)

virtual

Gets the index of the character at the specified offset position.

Parameters

Offset The offset position of the character to get the index of.

Returns: Returns a CharIndexPair where the first value is a bool which will be false if the position is invalid for whatever reason. The second value will be in the index. If the second value is -1 then the position is to the right of the last character.

Definition at line 367 of file textlayer.cpp.

virtual CharIndexPair Mezzanine::UI::TextLayer::GetIndexAtOffsetImpl ( const Vector2 & Position)

protectedpure virtual

Gets the index of the character at the specified offset position.

Implemented in Mezzanine::UI::SingleLineTextLayer, and Mezzanine::UI::MultiLineTextLayer.

const Vector2 & Mezzanine::UI::TextLayer::GetManualTextScale ( ) const

virtual

Gets the scaling currently being applied to the rendered text.

Returns: Returns a Vector2 representing the scale applied to the text in this layer. <1.0 means smaller, >1.0 means larger.

Definition at line 433 of file textlayer.cpp.

MarkupParser * Mezzanine::UI::TextLayer::GetMarkupParser ( ) const

virtual

Gets the MarkupParser being used by this TextLayer.

Returns: Returns a pointer to the MarkupParser currently being used by this TextLayer.

Definition at line 328 of file textlayer.cpp.

Whole Mezzanine::UI::TextLayer::GetNumCharacters ( ) const

virtual

Gets the number of characters being rendered by this TextLayer.

Returns: Returns a Whole representing the number of rendered characters being rendered by this TextLayer.

Definition at line 796 of file textlayer.cpp.

UInt32 Mezzanine::UI::TextLayer::GetNumTextLines ( ) const

virtual

Gets the number of TextLines this layer contains.

Returns: Returns a UInt32 representing the number of lines of text this layer has.

Definition at line 661 of file textlayer.cpp.

TextLayer::CharOffsetPair Mezzanine::UI::TextLayer::GetOffsetAtIndex ( const Integer Index)

virtual

Gets the offset position of the character at the provided index.

Parameters

Index The index of the character position to retrieve.

Returns: Returns a CharOffsetPair where the first value is a bool which will be false if the index is invalid for any reason, and the second value is the offset position of the character at the specified index if the first value is true.

Definition at line 377 of file textlayer.cpp.

virtual CharOffsetPair Mezzanine::UI::TextLayer::GetOffsetAtIndexImpl ( const Integer Index)

protectedpure virtual

Gets the position of the character at the specified index.

Implemented in Mezzanine::UI::SingleLineTextLayer, and Mezzanine::UI::MultiLineTextLayer.

String Mezzanine::UI::TextLayer::GetSerializableName ( )

static

Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.

Returns: A string containing the name of this class.

Definition at line 1052 of file textlayer.cpp.

String Mezzanine::UI::TextLayer::GetText ( ) const

virtual

Gets the text displayed within this layer.

Returns: Returns the text being displayed.

Definition at line 408 of file textlayer.cpp.

const ColourValue & Mezzanine::UI::TextLayer::GetTextColour ( ) const

virtual

Gets the default colour of the tect being rendered by this layer.

Returns: Returns a const ColourValue reference containing the colour used to render this layer's text.

Definition at line 421 of file textlayer.cpp.

TextLine * Mezzanine::UI::TextLayer::GetTextLineAtOffset ( const Real & Offset)

virtual

Gets the TextLine at the specified offset position.

Parameters

Offset The offset from the top edge of the parent layer.

Returns: Returns a pointer to the TextLine at the requested offset, or NULL if none exists.

Definition at line 642 of file textlayer.cpp.

UI::LinearAlignment Mezzanine::UI::TextLayer::GetTextlineVerticalAlignment ( ) const

virtual

Gets the current set alignment for positioning textlines in this layer.

Returns: Returns the current TextLine position alignment.

Definition at line 703 of file textlayer.cpp.

UI::TextOrdering Mezzanine::UI::TextLayer::GetTextOrder ( ) const

virtual

Gets the currently set direction of advancement for characters on the horizontal axis created by this layer.

Returns: Returns the direction of advancement for characters on the horizontal axis.

Definition at line 595 of file textlayer.cpp.

Real Mezzanine::UI::TextLayer::GetTotalHeight ( ) const

virtual

Gets the combined height of all the text lines in this layer.

Returns: Returns a Real representing the pixel height of all the textlines in this layer.

Definition at line 342 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::Highlight ( const Integer Index)

virtual

Highlights the character at the specified index.

Parameters

Index The index of the character to highlight.

Definition at line 523 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::Highlight	(	const Integer	StartIndex,
		const Integer	EndIndex
	)

virtual

Highlights all characters in a provided range.

Parameters

StartIndex	The index of the first character in the range to highlight.
EndIndex	The index of the last character in the range to highlight.

Definition at line 535 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::InsertCharacterAtIndex	(	const Integer	Index,
		const UInt32	GlyphID
	)

virtual

Creates a character from a Glyph ID and inserts it into the layer at the specified index.

Parameters

Index	The index at which the character should be inserted.
GlyphID	The ID of the Glyph to be inserted.

Definition at line 801 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::InsertCharactersAtIndex	(	const Integer	Index,
		const Char8 *	Characters,
		const UInt32	BufSize
	)

virtual

Creates a series of characters from a UTF-8 encoded string to be inserted into this layer.

Parameters

Index	The index at which the characters will be inserted.
Characters	An array of Char8's encoded in UTF-8 to be inserted.
BufSize	The size of the array of Char8's passed in.

Definition at line 810 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::InsertCharactersAtIndex	(	const Integer	Index,
		const UInt32 *	Characters,
		const UInt32	BufSize
	)

virtual

Creates a series of characters from a UTF-32 encoded string to be inserted into this layer.

Parameters

Index	The index at which the characters will be inserted.
Characters	An array of UInt32's encoded in UTF-32 to be inserted.
BufSize	The size of the array of Char8's passed in.

Definition at line 819 of file textlayer.cpp.

virtual void Mezzanine::UI::TextLayer::PopulateTextLinesImpl ( )

protectedpure virtual

Clears and then places characters belonging to this layer in the appropriate text lines.

Implemented in Mezzanine::UI::SingleLineTextLayer, and Mezzanine::UI::MultiLineTextLayer.

void Mezzanine::UI::TextLayer::ProtoDeSerialize ( const XML::Node & SelfRoot)

virtual

Take the data stored in an XML Node and overwrite this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::UI::SimpleRenderer.

Definition at line 943 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::ProtoDeSerializeCursor ( const XML::Node & SelfRoot)

virtual

Take the data stored in an XML Node and overwrite the TextCursor of this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Definition at line 1020 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::ProtoDeSerializeProperties ( const XML::Node & SelfRoot)

virtual

Take the data stored in an XML Node and overwrite the properties of this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::UI::RenderLayer.

Reimplemented in Mezzanine::UI::SingleLineTextLayer, and Mezzanine::UI::MultiLineTextLayer.

Definition at line 957 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::ProtoDeSerializeText ( const XML::Node & SelfRoot)

virtual

Take the data stored in an XML Node and overwrite the Text of this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Definition at line 1031 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::ProtoSerialize ( XML::Node & ParentNode) const

virtual

Convert this class to an XML::Node ready for serialization.

Parameters

ParentNode The point in the XML hierarchy that all this renderable should be appended to.

Reimplemented from Mezzanine::UI::SimpleRenderer.

Definition at line 883 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::ProtoSerializeCursor ( XML::Node & SelfRoot) const

virtual

Convert the TextCursor of this class to an XML::Node ready for seriailization.

Parameters

SelfRoot The root node containing all the serialized data for this instance.

Definition at line 923 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::ProtoSerializeProperties ( XML::Node & SelfRoot) const

virtual

Convert the properties of this class to an XML::Node ready for serialization.

Parameters

SelfRoot The root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::UI::RenderLayer.

Reimplemented in Mezzanine::UI::SingleLineTextLayer, and Mezzanine::UI::MultiLineTextLayer.

Definition at line 892 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::ProtoSerializeText ( XML::Node & SelfRoot) const

virtual

Convert the Text of this class to an XML::Node ready for serialization.

Parameters

SelfRoot The root node containing all the serialized data for this instance.

Definition at line 931 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::RecalculateOffsets ( )

protectedvirtual

Recalculates the offset for every text line in this layer.

Definition at line 286 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::RedrawImpl ( bool Force)

protectedvirtual

Provides the class specific implementation for regenerating vertices for this renderable.

Implements Mezzanine::UI::SimpleRenderer.

Definition at line 171 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::RemoveCharacterAtIndex ( const Integer Index)

virtual

Removes a character from the layer at the specified index.

Parameters

Index The index of the character to be removed.

Definition at line 828 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::RemoveCharacterRange	(	const Integer	First,
		const Integer	Last
	)

virtual

Removes a range of characters from the text in this layer.

Parameters

First	The first character in the range to be removed.
Last	The last character in the range to be removed.

Definition at line 846 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::RemoveCharactersAtIndex	(	const Integer	Index,
		const UInt32	Length
	)

virtual

Removes a length of characters from this layer at the specified index.

Parameters

Index	The index of the start of the range of characters to be removed.
Length	The number of characters being removed.

Definition at line 837 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetActiveHighlightBackgroundColour ( const ColourValue & Colour)

virtual

Sets the colour of the highlight when the quad is being focused.

Note: Being focused is a property of Widgets, which the parent quad may not be. In general highlighting in a non-Widget is likely or recommended.

Parameters

Colour The highlight colour while being focused.

Definition at line 490 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetAutoTextScale	(	const TextLayer::ScalingMode	Mode,
		const Real	Scalar
	)

virtual

Sets the mode and scaler of auto-scaling applied to the text generated by this textlayer.

Remarks: There are a lot of considerations to be made with auto-scaling. Auto-scaling will adjust the size of the provided font automatically based on the scaling mode that is set, which really decides what the relative scalar provided for auto-scaling is relative to. If auto-scaling is relative to the screen, then the text will only change in size when the screen does. Parent and layer relative scaling are very similiar since layers get their dimensions from the parent widget they belong to. The difference comes from scaling applied to the layer itself. Parent relative scaling ignores the layer scaling, while layer relative factors it in.

In addition to the relative component to the scaling, manual scaling will also be applied after the auto-scaling is. Auto-scaling will be completely ignored if the custom size on a character is set.

Parameters

Mode	A ScalingMode enum value describing what the provided scaler will be relative to.
Scalar	The relative value that will be used to determine the needed scaling to be applied to text in this layer.

Definition at line 438 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetCursorEnabled ( bool Enable)

virtual

Enables (or disables) the cursor for use in this layer.

Note: The default state for the Text Cursor is disabled.

Parameters

Enable True to enable the cursor and make it available for manipulation/rendering, false to disable it.

Definition at line 603 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetDefaultFont ( FontData * NewFont)

virtual

Sets the default font to be used with this layer.

Parameters

NewFont The default font to use for this layer.

Todo:: Throw an error?

Definition at line 460 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetDefaultFont ( const String & FontName)

virtual

Sets the default font to be used with this layer.

The font name is defined in your mta file. This class can change which glyph is uses with it's markup language. This simply defines which to use when one isn't specified.

Parameters

FontName The name of the font to use for this layer.

Definition at line 470 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetDefaultFont	(	const String &	FontName,
		const String &	Atlas
	)

virtual

Sets the default font to be used with this layer.

The font is defined in your mta file. This class can change which glyph is uses with it's markup language. This simply defines which to use when one isn't specified.

Parameters

FontName	The name of the font to use for this layer.
Atlas	The different atlas to get the glyphdata from.

Definition at line 476 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetInactiveHighlightBackgroundColour ( const ColourValue & Colour)

virtual

Sets the colour of the highlight when the quad is not focused.

Note: Being focused is a property of Widgets, which the parent quad may not be. In general highlighting in a non-Widget is likely or recommended.

Parameters

Colour The highlight colour while

Definition at line 503 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetManualTextScale ( const Vector2 & Scale)

virtual

Sets the scaling to be applied to the text being rendered.

Remarks: Manual scaling is applied after any autoscaling settings are applied.

Parameters

Scale A Vector2 representing the scale on both dimensions to be applied. <1.0 means smaller, >1.0 means larger.

Definition at line 426 of file textlayer.cpp.

bool Mezzanine::UI::TextLayer::SetMarkupParser ( MarkupParser * Parser)

virtual

Sets the MarkupParser to be used by this TextLayer.

Note: Passing in NULL will be ignored.

Parameters

Parser A pointer to the MarkupParser to be used by this TextLayer.

Returns: Returns true if the new MarkupParser was successfully set, false otherwise.

Definition at line 312 of file textlayer.cpp.

bool Mezzanine::UI::TextLayer::SetMarkupParser ( const String & ParserName)

virtual

Sets the MarkupParser to be used by this TextLayer via it's registered name.

Parameters

ParserName The name of the registered parser to retrieve and set for this TextLayer.

Returns: Returns true if the new MarkupParser was successfully set, false otherwise.

Definition at line 322 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetScale ( const Vector2 & Scaling)

virtual

Sets the scaling to be applied to this render layer.

Parameters

Scaling A Vector2 representing the X and Y scaling to be applied to this render layer.

Reimplemented from Mezzanine::UI::RenderLayer.

Definition at line 336 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetText ( const String & Text)

virtual

Sets the text displayed within this layer.

Parameters

Text	The text to be displayed.

Todo:: Character generation and storage is a good candidate for pool allocation.

Definition at line 385 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetTextColour ( const ColourValue & Colour)

virtual

Sets the default colour of the text being rendered by this layer.

Parameters

Colour The colour to apply to the text of this layer.

Definition at line 413 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetTextlineVerticalAlignment ( const UI::LinearAlignment Align)

virtual

Sets the alignment used to determine the start position of the textlines in this layer.

Note: TextLines can easily run out of room in a given layer. If the combined vertical height of the TextLines in this layer exceed the size given for rendering then this setting is ignored, and text will render from the top.

Parameters

Align The alignment to use.

Definition at line 693 of file textlayer.cpp.

void Mezzanine::UI::TextLayer::SetTextOrder ( const UI::TextOrdering Order)

virtual

Sets the ordering for characters in this layer.

Remarks: The Text Line Order determines if characters are ordered left to right, or right to left.

Parameters

Order The direction of advancement for characters on the horizontal axis.

Definition at line 582 of file textlayer.cpp.

Member Data Documentation

ColourValue Mezzanine::UI::TextLayer::ActiveHLColour

protected

The colour of the highlight when this layer belongs to a focused widget.

Definition at line 111 of file textlayer.h.

Real Mezzanine::UI::TextLayer::AutoCharScaling

protected

The auto-scaling height the text is to be in relative units.

Definition at line 135 of file textlayer.h.

ScalingMode Mezzanine::UI::TextLayer::AutoCharScalingMode

protected

The auto-scaling mode that is to be used on text generated by this textlayer.

Definition at line 138 of file textlayer.h.

CharacterContainer Mezzanine::UI::TextLayer::Characters

protected

Container with all this layers Characters.

Definition at line 105 of file textlayer.h.

TextCursor* Mezzanine::UI::TextLayer::Cursor

protected

The cursor to be used for insert and manipulation operations.

Definition at line 123 of file textlayer.h.

CharacterTraits Mezzanine::UI::TextLayer::DefaultCharTraits

protected

Default set of traits all characters generated inside this layer are to have.

Definition at line 108 of file textlayer.h.

Integer Mezzanine::UI::TextLayer::HighlightEnd

protected

The index of the character at the end of the highlight sequence.

Definition at line 132 of file textlayer.h.

Integer Mezzanine::UI::TextLayer::HighlightStart

protected

The index of the character at the start of the highlight sequence.

Definition at line 129 of file textlayer.h.

UI::TextOrdering Mezzanine::UI::TextLayer::HorizontalOrder

protected

The order text will have in TextLines.

Definition at line 141 of file textlayer.h.

ColourValue Mezzanine::UI::TextLayer::InactiveHLColour

protected

The colour of the highlight when this layer belongs to a widget not being focused.

Definition at line 114 of file textlayer.h.

Vector2 Mezzanine::UI::TextLayer::ManualCharScaling

protected

The scaling to apply to all characters in this layer.

Definition at line 117 of file textlayer.h.

MarkupParser* Mezzanine::UI::TextLayer::MUParser

protected

The parser to use when converting raw strings to renderable characters.

Definition at line 120 of file textlayer.h.

Boolean Mezzanine::UI::TextLayer::ScalingChanged

protected

Flag indicating the scaling for the layer has been altered.

Definition at line 147 of file textlayer.h.

TextLineContainer Mezzanine::UI::TextLayer::TextLines

protected

Container with all this layers TextLines.

Definition at line 102 of file textlayer.h.

TokenString* Mezzanine::UI::TextLayer::TextTokens

protected

The actual text parsed into tokens used for generating characters.

Definition at line 126 of file textlayer.h.

UI::LinearAlignment Mezzanine::UI::TextLayer::VerticalAlign

protected

The alignment TextLines will have.

Definition at line 144 of file textlayer.h.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/textlayer.h
/home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/textlayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation