SkyBoxComponent Class Reference

Component wrapper of Irrlicht's SceneManager function addSkyBoxSceneNode(...). More...

Inheritance diagram for SkyBoxComponent:

[legend]

Collaboration diagram for SkyBoxComponent:

[legend]

List of all members.

Public Member Functions
	SkyBoxComponent (Entity *parent)
	Constructor (default).
	SkyBoxComponent (Entity *parent, ITexture *top, ITexture *bottom, ITexture *left, ITexture *right, ITexture *front, ITexture *back)
	Constructor.
	SkyBoxComponent (Entity *parent, const std::string &top, const std::string &bottom, const std::string &left, const std::string &right, const std::string &front, const std::string &back)
	Constructor.
	~SkyBoxComponent ()
	Deconstructor.
void	setTextures (const std::string &top, const std::string &bottom, const std::string &left, const std::string &right, const std::string &front, const std::string &back, bool ignoreNull=true)
	Loads and sets the textures of the sky box.
void	setTextures (ITexture *top, ITexture *bottom, ITexture *left, ITexture *right, ITexture *front, ITexture *back, bool ignoreNull=true)
	Sets the textures of the sky box.
void	onTextureSkyBox (void *p)
	Responds to changes of a skybox texture attached to this component.
Static Public Member Functions
static bool	parseXML (IXMLReader *file, Entity *entity)
	Parses for a SkyBoxComponent.

---

Detailed Description

Component wrapper of Irrlicht's SceneManager function addSkyBoxSceneNode(...).

XML:

 <SkyBoxComponent>
    <!-- Properties -->
 </SkyBoxComponent>

Definition at line 33 of file SkyBoxComponent.h.

---

Constructor & Destructor Documentation

SkyBoxComponent::SkyBoxComponent

(

Entity *

parent

)

Constructor (default).

Parameters:

parent

The parent entity to which the component should be added.

Definition at line 24 of file SkyBoxComponent.cpp.

SkyBoxComponent::SkyBoxComponent	(	Entity *	parent,
		ITexture *	top,
		ITexture *	bottom,
		ITexture *	left,
		ITexture *	right,
		ITexture *	front,
		ITexture *	back
	)

Constructor.

Parameters:

	parent	The parent entity to which the component should be added.
	top	Texture for the top plane of the box.
	bottom	Texture for the bottom plane of the box.
	left	Texture for the left plane of the box.
	right	Texture for the right plane of the box.
	front	Texture for the front plane of the box.
	back	Texture for the back plane of the box.

Note:

Not available in AngelScript.

Definition at line 31 of file SkyBoxComponent.cpp.

SkyBoxComponent::SkyBoxComponent	(	Entity *	parent,
		const std::string &	top,
		const std::string &	bottom,
		const std::string &	left,
		const std::string &	right,
		const std::string &	front,
		const std::string &	back
	)

Constructor.

Parameters:

	parent	The parent entity to which the component should be added.
	top	File with the texture for the top plane of the box.
	bottom	File with the texture for the bottom plane of the box.
	left	File with the texture for the left plane of the box.
	right	File with the texture for the right plane of the box.
	front	File with the texture for the front plane of the box.
	back	File with the texture for the back plane of the box.

Definition at line 40 of file SkyBoxComponent.cpp.

SkyBoxComponent::~SkyBoxComponent

(

)

Deconstructor.

Definition at line 50 of file SkyBoxComponent.cpp.

---

Member Function Documentation

void SkyBoxComponent::onTextureSkyBox

(

void *

p

)

Responds to changes of a skybox texture attached to this component.

Note:

For internal use only!

Definition at line 169 of file SkyBoxComponent.cpp.

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

Parses for a SkyBoxComponent.

Note:

For internal use only!

Reimplemented from SceneComponent.

Definition at line 197 of file SkyBoxComponent.cpp.

void SkyBoxComponent::setTextures	(	ITexture *	top,
		ITexture *	bottom,
		ITexture *	left,
		ITexture *	right,
		ITexture *	front,
		ITexture *	back,
		bool	ignoreNull = true
	)

Sets the textures of the sky box.

Parameters:

	top	Texture for the top plane of the box.
	bottom	Texture for the bottom plane of the box.
	left	Texture for the left plane of the box.
	right	Texture for the right plane of the box.
	front	Texture for the front plane of the box.
	back	Texture for the back plane of the box.
	ignoreNull	Should a null value be used as a texture?

Definition at line 92 of file SkyBoxComponent.cpp.

void SkyBoxComponent::setTextures	(	const std::string &	top,
		const std::string &	bottom,
		const std::string &	left,
		const std::string &	right,
		const std::string &	front,
		const std::string &	back,
		bool	ignoreNull = true
	)

Loads and sets the textures of the sky box.

XML:

     <textures top="" bottom="" left="" right="" front="" back="" />

Parameters:

	top	File with the texture for the top plane of the box.
	bottom	File with the texture for the bottom plane of the box.
	left	File with the texture for the left plane of the box.
	right	File with the texture for the right plane of the box.
	front	File with the texture for the front plane of the box.
	back	File with the texture for the back plane of the box.
	ignoreNull	Should a null value be used as a texture?

Definition at line 67 of file SkyBoxComponent.cpp.

---

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

• components/scene/SkyBoxComponent.h
• components/scene/SkyBoxComponent.cpp