ASR::Building Class Reference

Class representing a Building belonging to a team. More...

#include <Building.h>

List of all members.

Public Member Functions
	Building (SceneNode *parentNode, String meshName, Vector3 position)
	Constructor.
	~Building (void)
void	scale (Real x, Real y, Real z)
	Scales the physical size of the building.
void	translate (const Vector3 &vec)
	Moves the building, in relation to it's parents axis.
Vector3	getPosition ()
	Retrieves the position, in world coordinates?, of this building.
void	setPosition (const Vector3 &pos)
	Sets the position of this building in relation to its parent.
void	setDirection (const Vector3 &dir)
	Sets the direction this building is facing.
void	setDirection (float x, float y, float z)
	Sets the direction this building is facing.
Private Attributes
String	mName
	The unique ID name.
Entity *	mEntity
	The physical appearance of this Building.
SceneNode *	mNode
	The parent of this Building used for placement.
Static Private Attributes
static int	mNumBuildings = 0

---

Detailed Description

Class representing a Building belonging to a team.

Remarks:

A Building can be used for many purposes such as the creation of units or for upgrading of weapons and defense.

Definition at line 30 of file Building.h.

---

Constructor & Destructor Documentation

ASR::Building::Building	(	SceneNode *	parentNode,
		String	meshName,
		Vector3	position
	)

Constructor.

Parameters:

	parentNode	The node used for placing this Building.
	meshName	The name of the mesh used for the physical appearance
	position	The initial starting location of this Building

Definition at line 21 of file Building.cpp.

References ASR::Game::getSceneManager(), ASR::Level::getSingleton(), ASR::Game::getSingletonPtr(), mEntity, mName, mNode, mNumBuildings, and ASR::Level::occupyRegion().

        {
                mNumBuildings++;
                mName = "building_" + StringConverter::toString ( mNumBuildings );

                SceneManager* sceneMgr = Game::getSingletonPtr ()->getSceneManager ();

                mNode = parentNode->createChildSceneNode( mName + "_node" );
                mEntity = sceneMgr->createEntity ( mName, meshName );
                mNode->attachObject( mEntity );

                mNode->translate ( position );

                mNode->_updateBounds ();
                AxisAlignedBox boundingBox = mNode->_getWorldAABB ();
                Level::getSingleton ().occupyRegion ( boundingBox );
        }

ASR::Building::~Building

(

void

)

Definition at line 41 of file Building.cpp.

        {
        }

---

Member Function Documentation

Vector3 ASR::Building::getPosition

(

)

Retrieves the position, in world coordinates?, of this building.

Definition at line 78 of file Building.cpp.

References mNode.

        {
                return mNode->getPosition ();
        }

void ASR::Building::scale	(	Real	x,
		Real	y,
		Real	z
	)

Scales the physical size of the building.

Parameters:

x,y,z

The size of the scales on the various axis.

Definition at line 47 of file Building.cpp.

References mNode.

        {
                mNode->scale ( x, y, z );
        }

void ASR::Building::setDirection	(	float	x,
		float	y,
		float	z
	)

Sets the direction this building is facing.

Parameters:

	x
	y
	z	The components that make up the "forward" vector.

Definition at line 99 of file Building.cpp.

References mNode.

        {
                mNode->setDirection( x, y, z );
        }

void ASR::Building::setDirection

(

const Vector3 &

dir

)

Sets the direction this building is facing.

Parameters:

dir

The "forward" vector this building should face along.

Definition at line 92 of file Building.cpp.

References mNode.

        {
                mNode->setDirection ( dir );
        }

void ASR::Building::setPosition

(

const Vector3 &

pos

)

Sets the position of this building in relation to its parent.

Parameters:

pos

The absolute position of this building in relation to its parent.

Definition at line 85 of file Building.cpp.

References mNode.

        {
                mNode->setPosition ( pos );
        }

void ASR::Building::translate

(

const Vector3 &

vec

)

Moves the building, in relation to it's parents axis.

Parameters:

vec

A vector representing the amount of translation.

Definition at line 54 of file Building.cpp.

References ASR::BuildingPadding, ASR::Level::getSingleton(), mNode, ASR::Level::occupyRegion(), and ASR::Level::unoccupyRegion().

        {
                Vector3 pad = Vector3(BuildingPadding, BuildingPadding, BuildingPadding );

                // Unmark the nodes that this building was covering
                mNode->_updateBounds ();
                AxisAlignedBox boundingBox = mNode->_getWorldAABB ();
                boundingBox.merge ( boundingBox.getMaximum () + pad );
                boundingBox.merge ( boundingBox.getMinimum () - pad );

                Level::getSingleton ().unoccupyRegion ( boundingBox );

                mNode->translate ( vec );

                // Mark the new nodes that this building covers
                mNode->_updateBounds ();
                boundingBox = mNode->_getWorldAABB ();
                boundingBox.merge ( boundingBox.getMaximum () + pad );
                boundingBox.merge ( boundingBox.getMinimum () - pad );
                Level::getSingleton ().occupyRegion ( boundingBox );
        }

---

Member Data Documentation

Entity* ASR::Building::mEntity [private]

The physical appearance of this Building.

Definition at line 41 of file Building.h.

Referenced by Building().

String ASR::Building::mName [private]

The unique ID name.

Definition at line 38 of file Building.h.

Referenced by Building().

SceneNode* ASR::Building::mNode [private]

The parent of this Building used for placement.

Definition at line 44 of file Building.h.

Referenced by Building(), getPosition(), scale(), setDirection(), setPosition(), and translate().

int ASR::Building::mNumBuildings = 0 [static, private]

Definition at line 35 of file Building.h.

Referenced by Building().

---

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

• D:/simple_rts/include/Building.h
• D:/simple_rts/src/Building.cpp

---