BillboardComponent Class Reference

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

Inheritance diagram for BillboardComponent:

[legend]

Collaboration diagram for BillboardComponent:

[legend]

List of all members.

Public Member Functions
	BillboardComponent (Entity *parent, 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 (default).
	~BillboardComponent ()
	Deconstructor.
IBillboardSceneNode *	getBillboardSceneNode ()
	Returns a direct pointer to the IBillboardSceneNode.
void	getColor (SColor &topColor, SColor &bottomColor) const
	Gets the color of the top and bottom vertices of the billboard.
const dimension2df &	getSize () const
	Returns the size of the billboard.
void	setColor (const SColor &overallColor)
	Sets the color of all vertices of the billboard.
void	setColor (const SColor &topColor, const SColor &bottomColor)
	Sets the color of the top and bottom vertices of the billboard.
void	setSize (const dimension2df &size)
	Sets the size of the billboard.
Static Public Member Functions
static bool	parseXML (IXMLReader *file, Entity *entity)
	Parses for a BillboardComponent.
static bool	parseBaseXML (IXMLReader *file, BillboardComponent *component)
	Parses for the base elements of a BillboardComponent.
Protected Member Functions
	BillboardComponent (Entity *parent, bool isDerived)
	Constructor for derived classes.
Protected Attributes
IBillboardSceneNode *	mBillboardSN

---

Detailed Description

Component wrapper of Irrlicht's IBillboardSceneNode.

XML:

 <BillboardComponent>
    <!-- Properties -->
 </BillboardComponent>

Definition at line 33 of file BillboardComponent.h.

---

Constructor & Destructor Documentation

BillboardComponent::BillboardComponent	(	Entity *	parent,
		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 (default).

Parameters:

	parent	The parent entity to which the component should be added.
	size	2 dimensional size of the billboard.
	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 23 of file BillboardComponent.cpp.

BillboardComponent::~BillboardComponent

(

)

Deconstructor.

Definition at line 47 of file BillboardComponent.cpp.

BillboardComponent::BillboardComponent	(	Entity *	parent,
		bool	isDerived
	)			[protected]

Constructor for derived classes.

Definition at line 41 of file BillboardComponent.cpp.

---

Member Function Documentation

IBillboardSceneNode * BillboardComponent::getBillboardSceneNode

(

)

Returns a direct pointer to the IBillboardSceneNode.

Note:

Not available in AngelScript.

Definition at line 57 of file BillboardComponent.cpp.

void BillboardComponent::getColor	(	SColor &	topColor,
		SColor &	bottomColor
	)			const

Gets the color of the top and bottom vertices of the billboard.

Parameters:

	topColor	SColor object in which the top color will be stored.
	bottomColor	SColor object in which the bottom color will be stored.

Definition at line 63 of file BillboardComponent.cpp.

const dimension2df & BillboardComponent::getSize

(

)

const

Returns the size of the billboard.

Definition at line 69 of file BillboardComponent.cpp.

bool BillboardComponent::parseBaseXML	(	IXMLReader *	file,
		BillboardComponent *	component
	)			[static]

Parses for the base elements of a BillboardComponent.

Note:

For internal use only!

Definition at line 144 of file BillboardComponent.cpp.

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

Parses for a BillboardComponent.

Note:

For internal use only!

Reimplemented from SceneComponent.

Reimplemented in TextBillboardComponent.

Definition at line 93 of file BillboardComponent.cpp.

void BillboardComponent::setColor	(	const SColor &	topColor,
		const SColor &	bottomColor
	)

Sets the color of the top and bottom vertices of the billboard.

XML:

     <color topA="" topR="" topG="" topB="" bottomA="" bottomR="" bottomG="" bottomB=""/>

Parameters:

	topColor	The color to set the top vertices.
	bottomColor	The color to set the bottom vertices.

Definition at line 81 of file BillboardComponent.cpp.

void BillboardComponent::setColor

(

const SColor &

overallColor

)

Sets the color of all vertices of the billboard.

XML:

     <color overallA="" overallR="" overallG="" overallB="" />

Parameters:

overallColor

The color to set.

Definition at line 75 of file BillboardComponent.cpp.

void BillboardComponent::setSize

(

const dimension2df &

size

)

Sets the size of the billboard.

XML:

     <size width="" height=""/>

Parameters:

size

Size of the billboard.

Definition at line 87 of file BillboardComponent.cpp.

---

Member Data Documentation

IBillboardSceneNode* BillboardComponent::mBillboardSN [protected]

Definition at line 106 of file BillboardComponent.h.

---

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

• components/scene/BillboardComponent.h
• components/scene/BillboardComponent.cpp