Mezzanine::UI::CharacterTraits Class Reference

This class stores common data for determining the look of a Character. More...

#include <charactertraits.h>

Collaboration diagram for Mezzanine::UI::CharacterTraits:

Public Member Functions
	CharacterTraits ()
	Blank Constructor.
	CharacterTraits (FontData *Font, const ColourValue &Character)
	Descriptive Constructor. More...
virtual	~CharacterTraits ()
	Class Destructor.
Boole	operator!= (const CharacterTraits &Other) const
	Inequality comparison operator. More...
CharacterTraits &	operator= (const CharacterTraits &Other)
	Assignment operator. More...
Boole	operator== (const CharacterTraits &Other) const
	Equality comparison operator. More...
void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...
void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...

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

Public Attributes
ColourValue	CharColour
	The colour to render this Character as.
FontData *	CharFont
	The font this Character belongs to.

Detailed Description

This class stores common data for determining the look of a Character.

Definition at line 64 of file charactertraits.h.

Constructor & Destructor Documentation

Mezzanine::UI::CharacterTraits::CharacterTraits	(	FontData *	Font,
		const ColourValue &	Character
	)

Descriptive Constructor.

Parameters

Font	A pointer to the font to be used.
Character	The colour to be given to the characters altered by this class.

Definition at line 59 of file charactertraits.cpp.

Member Function Documentation

String Mezzanine::UI::CharacterTraits::GetSerializableName ( )

static

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

Returns

A string containing the name of this class.

Definition at line 142 of file charactertraits.cpp.

Boole Mezzanine::UI::CharacterTraits::operator!=

(

const CharacterTraits &

Other

)

const

Inequality comparison operator.

Parameters

Other

The other CharacterTraits to compare with.

Returns

Returns true if the two CharacterTraits are not equal, false otherwise.

Definition at line 83 of file charactertraits.cpp.

CharacterTraits & Mezzanine::UI::CharacterTraits::operator=

(

const CharacterTraits &

Other

)

Assignment operator.

Parameters

Other

The other CharacterTraits to copy from.

Returns

Returns a reference to this.

Definition at line 70 of file charactertraits.cpp.

Boole Mezzanine::UI::CharacterTraits::operator==

(

const CharacterTraits &

Other

)

const

Equality comparison operator.

Parameters

Other

The other CharacterTraits to compare with.

Returns

Returns true if the two CharacterTraits are equal, false otherwise.

Definition at line 77 of file charactertraits.cpp.

void Mezzanine::UI::CharacterTraits::ProtoDeSerialize

(

const XML::Node &

SelfRoot

)

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.

Definition at line 108 of file charactertraits.cpp.

void Mezzanine::UI::CharacterTraits::ProtoSerialize

(

XML::Node &

ParentNode

)

const

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

Parameters

ParentNode

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

Definition at line 92 of file charactertraits.cpp.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/charactertraits.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/charactertraits.cpp