VRS::TEXT::AbstractText Class Reference

The abstract text interface, containing common methods for all texts alike. More...

#include <vrs/text/abstracttext.h>

Inheritance diagram for VRS::TEXT::AbstractText:

List of all members.

Public Types
enum	HorizontalAlignment { LEFT, RIGHT, CENTER }
enum	VerticalAlignment { TOP, BOTTOM, MIDDLE }
enum	Direction { HORIZONTAL, VERTICAL }
enum	HorizontalDirection { LEFTTORIGHT, RIGHTTOLEFT }
enum	VerticalDirection { TOPTOBOTTOM, BOTTOMTOTOP }
enum	TextPlane {   TP_XY_z, TP_XY_Z, TP_XZ_y, TP_XZ_Y,   TP_YZ_x, TP_YZ_X }
Public Member Functions
	VRS_SERIALIZABLE_CLASS_ENUM (HorizontalAlignment)
	VRS_SERIALIZABLE_CLASS_ENUM (VerticalAlignment)
	VRS_SERIALIZABLE_CLASS_ENUM (Direction)
	VRS_SERIALIZABLE_CLASS_ENUM (HorizontalDirection)
	VRS_SERIALIZABLE_CLASS_ENUM (VerticalDirection)
virtual	~AbstractText ()
	Destructor.
virtual const std::string &	getText () const =0
	Returns the text to be rendered.
virtual void	setText (const std::string &str)=0
	Sets the new text to be rendered.
virtual SO< FontDefinition >	getFontDefinition () const =0
	Returns the FontDefinition.
virtual void	setFontDefinition (SO< FontDefinition >)=0
	Sets the FontDefinition.
virtual HorizontalAlignment	getHorizontalAlignment () const =0
	Returns the Horizontal Alignment.
virtual void	setHorizontalAlignment (HorizontalAlignment tva)=0
	Sets the Horizontal Alignment.
virtual VerticalAlignment	getVerticalAlignment () const =0
	Returns the Vertical Alignment.
virtual void	setVerticalAlignment (VerticalAlignment tva)=0
	Sets the Vertical Alignment.
virtual HorizontalDirection	getHorizontalDirection () const =0
	Returns the Horizontal Direction.
virtual void	setHorizontalDirection (HorizontalDirection thd)=0
	Sets the Horizontal Direction.
virtual VerticalDirection	getVerticalDirection () const =0
	Returns the Vertical Direction.
virtual void	setVerticalDirection (VerticalDirection thd)=0
	Sets the Vertical Direction.
virtual AbstractText::Direction	getDirection () const =0
	Returns the visible Direction.
virtual void	setDirection (AbstractText::Direction td)=0
	Set the visible Direction.
virtual void	setAlignmentBounds (float rightBorder, float bottomBorder)=0
	Sets the bottom and right bounds of the Text.
virtual void	setRightAlignmentBound (float rightBorder)=0
	Sets the right alignement bound.
virtual void	setBottomAlignmentBound (float bottomBorder)=0
	Sets the bottom alignement bound.
virtual float	getRightAlignmentBound () const =0
	Returns the right alignement bound.
virtual float	getBottomAlignmentBound () const =0
	Returns the bottom alignement bound.
virtual float	getLineSpacing () const =0
	Returns the Scale of the inter line gap.
virtual void	setLineSpacing (float LineSpacing)=0
	Sets the Scale of the inter line gap.
virtual void	setColor (const Color &color, bool use=true)=0
	Sets the Color of this Text.
virtual Color	getColor () const =0
	Returns the Color of this Text.
virtual bool	useColor () const =0
	Should the Color be used.
virtual Matrix	getMatrix () const =0
	Returns the local matrix for the text.
virtual void	setMatrix (const Matrix &m)=0
	Sets the local matrix for the text.
virtual void	setMatrix (AbstractText::TextPlane tp, const Vector &offset=Vector(0, 0, 0), const Vector &scale=Vector(1, 1, 1))
	Sets the local Matrix.
virtual Bounds	boundingBox () const =0
	Bounds (with Matrix applied).
virtual Bounds	getLocalBounds () const =0
	Bounds (without Matrix applied).
	VRS_TYPEINFO (AbstractText, Shape)
Static Public Member Functions
static Matrix	buildMatrix (TextPlane tp, const Vector &offset=Vector(0, 0, 0), const Vector &scale=Vector(1, 1, 1))
	Creates the local Matrix.

---

Detailed Description

The abstract text interface, containing common methods for all texts alike.

---

Member Enumeration Documentation

enum VRS::TEXT::AbstractText::HorizontalAlignment

Enumerator:

LEFT
RIGHT
CENTER

enum VRS::TEXT::AbstractText::VerticalAlignment

Enumerator:

TOP
BOTTOM
MIDDLE

enum VRS::TEXT::AbstractText::Direction

Enumerator:

HORIZONTAL
VERTICAL

enum VRS::TEXT::AbstractText::HorizontalDirection

Enumerator:

LEFTTORIGHT
RIGHTTOLEFT

enum VRS::TEXT::AbstractText::VerticalDirection

Enumerator:

TOPTOBOTTOM
BOTTOMTOTOP

enum VRS::TEXT::AbstractText::TextPlane

Enumerator:

TP_XY_z
TP_XY_Z
TP_XZ_y
TP_XZ_Y
TP_YZ_x
TP_YZ_X

---

Constructor & Destructor Documentation

virtual VRS::TEXT::AbstractText::~AbstractText

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

VRS::TEXT::AbstractText::VRS_SERIALIZABLE_CLASS_ENUM

(

HorizontalAlignment

)

VRS::TEXT::AbstractText::VRS_SERIALIZABLE_CLASS_ENUM

(

VerticalAlignment

)

VRS::TEXT::AbstractText::VRS_SERIALIZABLE_CLASS_ENUM

(

Direction

)

VRS::TEXT::AbstractText::VRS_SERIALIZABLE_CLASS_ENUM

(

HorizontalDirection

)

VRS::TEXT::AbstractText::VRS_SERIALIZABLE_CLASS_ENUM

(

VerticalDirection

)

virtual const std::string& VRS::TEXT::AbstractText::getText

(

)

const [pure virtual]

Returns the text to be rendered.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setText

(

const std::string &

str

)

[pure virtual]

Sets the new text to be rendered.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual SO<FontDefinition> VRS::TEXT::AbstractText::getFontDefinition

(

)

const [pure virtual]

Returns the FontDefinition.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setFontDefinition

(

SO< FontDefinition >

)

[pure virtual]

Sets the FontDefinition.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual HorizontalAlignment VRS::TEXT::AbstractText::getHorizontalAlignment

(

)

const [pure virtual]

Returns the Horizontal Alignment.

See also:

AbstractText::HorizontalAlignment

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setHorizontalAlignment

(

HorizontalAlignment

tva

)

[pure virtual]

Sets the Horizontal Alignment.

See also:

AbstractText::HorizontalAlignment

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual VerticalAlignment VRS::TEXT::AbstractText::getVerticalAlignment

(

)

const [pure virtual]

Returns the Vertical Alignment.

See also:

AbstractText::VerticalAlignment

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setVerticalAlignment

(

VerticalAlignment

tva

)

[pure virtual]

Sets the Vertical Alignment.

See also:

AbstractText::VerticalAlignment

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual HorizontalDirection VRS::TEXT::AbstractText::getHorizontalDirection

(

)

const [pure virtual]

Returns the Horizontal Direction.

See also:

AbstractText::HorizontalDirection

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setHorizontalDirection

(

HorizontalDirection

thd

)

[pure virtual]

Sets the Horizontal Direction.

See also:

AbstractText::HorizontalDirection

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual VerticalDirection VRS::TEXT::AbstractText::getVerticalDirection

(

)

const [pure virtual]

Returns the Vertical Direction.

See also:

AbstractText::VerticalDirection

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setVerticalDirection

(

VerticalDirection

thd

)

[pure virtual]

Sets the Vertical Direction.

See also:

AbstractText::VerticalDirection

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual AbstractText::Direction VRS::TEXT::AbstractText::getDirection

(

)

const [pure virtual]

Returns the visible Direction.

See also:

AbstractText::Direction

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setDirection

(

AbstractText::Direction

td

)

[pure virtual]

Set the visible Direction.

See also:

AbstractText::Direction

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setAlignmentBounds	(	float	rightBorder,
		float	bottomBorder
	)			[pure virtual]

Sets the bottom and right bounds of the Text.

Used for alignment and justification. If no alignment bounds are specified, the bounds that will be used is the position of the texts origin. This means that with AbstractText::RIGHT, the text will bei on the right side of the origin, or with AbstractText::CENTER and AbstractText::MIDDLE the cneter of the text will be on the origin.

If specified, the text will be aligned between the origin and the given borders.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setRightAlignmentBound

(

float

rightBorder

)

[pure virtual]

Sets the right alignement bound.

See also:

setAlignmentBounds

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setBottomAlignmentBound

(

float

bottomBorder

)

[pure virtual]

Sets the bottom alignement bound.

See also:

setAlignmentBounds

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual float VRS::TEXT::AbstractText::getRightAlignmentBound

(

)

const [pure virtual]

Returns the right alignement bound.

See also:

setAlignmentBounds

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual float VRS::TEXT::AbstractText::getBottomAlignmentBound

(

)

const [pure virtual]

Returns the bottom alignement bound.

See also:

setAlignmentBounds

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual float VRS::TEXT::AbstractText::getLineSpacing

(

)

const [pure virtual]

Returns the Scale of the inter line gap.

1.0 means 100%

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setLineSpacing

(

float

LineSpacing

)

[pure virtual]

Sets the Scale of the inter line gap.

1.0 means 100%

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setColor	(	const Color &	color,
		bool	use = true
	)			[pure virtual]

Sets the Color of this Text.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual Color VRS::TEXT::AbstractText::getColor

(

)

const [pure virtual]

Returns the Color of this Text.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual bool VRS::TEXT::AbstractText::useColor

(

)

const [pure virtual]

Should the Color be used.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual Matrix VRS::TEXT::AbstractText::getMatrix

(

)

const [pure virtual]

Returns the local matrix for the text.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

virtual void VRS::TEXT::AbstractText::setMatrix

(

const Matrix &

m

)

[pure virtual]

Sets the local matrix for the text.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, VRS::TEXT::FontLodText, and VRS::TEXT::TextureText.

virtual void VRS::TEXT::AbstractText::setMatrix	(	AbstractText::TextPlane	tp,
		const Vector &	offset = Vector(0,0,0),
		const Vector &	scale = Vector(1,1,1)
	)			[inline, virtual]

Sets the local Matrix.

Parameters:

	tp	Turns the text onto the given plane
	offset	The offset
	offset	The scaling

Reimplemented in VRS::TEXT::BaseText, and VRS::TEXT::TextureText.

static Matrix VRS::TEXT::AbstractText::buildMatrix	(	TextPlane	tp,
		const Vector &	offset = Vector(0,0,0),
		const Vector &	scale = Vector(1,1,1)
	)			[inline, static]

Creates the local Matrix.

Parameters:

	tp	Turns the text onto the given plane
	offset	The offset
	offset	The scaling

virtual Bounds VRS::TEXT::AbstractText::boundingBox

(

)

const [pure virtual]

Bounds (with Matrix applied).

Implements VRS::Shape.

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, VRS::TEXT::DisplacedTextureText, VRS::TEXT::FontLodText, and VRS::TEXT::TextureText.

virtual Bounds VRS::TEXT::AbstractText::getLocalBounds

(

)

const [pure virtual]

Bounds (without Matrix applied).

Implemented in VRS::TEXT::BaseText, VRS::TEXT::CombinedText, and VRS::TEXT::FontLodText.

VRS::TEXT::AbstractText::VRS_TYPEINFO	(	AbstractText	,
		Shape
	)

---

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

• abstracttext.h