TextBillboardComponent Class Reference

Component wrapper of Irrlicht's IBillboardTextSceneNode. More...

Inheritance diagram for TextBillboardComponent:

[legend]

Collaboration diagram for TextBillboardComponent:

[legend]

List of all members.

Public Member Functions
	TextBillboardComponent (Entity *parent)
	Constructor (default).
	TextBillboardComponent (Entity *parent, const std::string &fontFileName, const wchar_t *text, const dimension2df &size=dimension2df(10.0f, 10.0f), const SColor &colorTop=SColor(255, 255, 255, 255), const SColor &colorBottom=SColor(255, 255, 255, 255))
	Constructor.
	TextBillboardComponent (Entity *parent, const std::string &fontFileName, const std::string &text, const dimension2df &size=dimension2df(10.0f, 10.0f), const SColor &colorTop=SColor(255, 255, 255, 255), const SColor &colorBottom=SColor(255, 255, 255, 255))
	Constructor.
	~TextBillboardComponent ()
	Deconstructor.
IBillboardTextSceneNode *	getBillboardTextSceneNode ()
	Returns a direct pointer to the IBillboardTextSceneNode.
void	setText (const std::string &text)
	Sets the text string.
void	setText (const wchar_t *text)
	Sets the text string.
void	setTextColor (const SColor &color)
	Sets the color of the text.
Static Public Member Functions
static bool	parseXML (IXMLReader *file, Entity *entity)
	Parses for a TextBillboardComponent.

---

Detailed Description

Component wrapper of Irrlicht's IBillboardTextSceneNode.

XML:

 <TextBillboardComponent>
    <!-- Properties -->
 </TextBillboardComponent>

Definition at line 33 of file TextBillboardComponent.h.

---

Constructor & Destructor Documentation

TextBillboardComponent::TextBillboardComponent

(

Entity *

parent

)

Constructor (default).

Definition at line 23 of file TextBillboardComponent.cpp.

TextBillboardComponent::TextBillboardComponent	(	Entity *	parent,
		const std::string &	fontFileName,
		const wchar_t *	text,
		const dimension2df &	size = dimension2df(10.0f, 10.0f),
		const SColor &	colorTop = SColor(255, 255, 255, 255),
		const SColor &	colorBottom = SColor(255, 255, 255, 255)
	)

Constructor.

Parameters:

	parent	The parent entity to which the component should be added.
	fontFileName	Filename of the font to load.
	text	The text to display on the billboard.
	size	The billboard's width and height.
	colorTop	The color of the vertices at the top of the billboard.
	colorBottom	The color of the vertices at the bottom of the billboard.

Note:

Not available in AngelScript.

Definition at line 31 of file TextBillboardComponent.cpp.

TextBillboardComponent::TextBillboardComponent	(	Entity *	parent,
		const std::string &	fontFileName,
		const std::string &	text,
		const dimension2df &	size = dimension2df(10.0f, 10.0f),
		const SColor &	colorTop = SColor(255, 255, 255, 255),
		const SColor &	colorBottom = SColor(255, 255, 255, 255)
	)

Constructor.

Parameters:

	parent	The parent entity to which the component should be added.
	fontFileName	Filename of the font to load.
	text	The text to display on the billboard.
	size	The billboard's width and height.
	colorTop	The color of the vertices at the top of the billboard.
	colorBottom	The color of the vertices at the bottom of the billboard.

Definition at line 41 of file TextBillboardComponent.cpp.

TextBillboardComponent::~TextBillboardComponent

(

)

Deconstructor.

Definition at line 52 of file TextBillboardComponent.cpp.

---

Member Function Documentation

IBillboardTextSceneNode * TextBillboardComponent::getBillboardTextSceneNode

(

)

Returns a direct pointer to the IBillboardTextSceneNode.

Note:

Not available in AngelScript.

Definition at line 80 of file TextBillboardComponent.cpp.

bool TextBillboardComponent::parseXML	(	IXMLReader *	file,
		Entity *	entity
	)			[static]

Parses for a TextBillboardComponent.

Note:

For internal use only!

Reimplemented from BillboardComponent.

Definition at line 105 of file TextBillboardComponent.cpp.

void TextBillboardComponent::setText

(

const wchar_t *

text

)

Sets the text string.

Parameters:

text

Text to set.

Note:

Not available in AngelScript.

Definition at line 93 of file TextBillboardComponent.cpp.

void TextBillboardComponent::setText

(

const std::string &

text

)

Sets the text string.

XML:

     <text value="" />

Parameters:

text

Text to set.

Definition at line 86 of file TextBillboardComponent.cpp.

void TextBillboardComponent::setTextColor

(

const SColor &

color

)

Sets the color of the text.

XML:

     <textColor a="" r="" g="" b="" />

Parameters:

color

New color of the text.

Definition at line 99 of file TextBillboardComponent.cpp.

---

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

• components/scene/TextBillboardComponent.h
• components/scene/TextBillboardComponent.cpp