#include <tdme/engine/scene/Scene.h>

Inheritance diagram for Scene:

Collaboration diagram for Scene:

Public Member Functions
	Scene (const string &name, const string &description)
	Public constructor. More...

	~Scene ()
	Destructor. More...

const string &	getApplicationRootPathName ()

void	setApplicationRootPathName (const string &applicationRootPathName)
	Set application root path name. More...

const string &	getFileName ()

void	setFileName (const string &fileName)
	Set up scene file name including relative path. More...

RotationOrder *	getRotationOrder ()

void	setRotationOrder (RotationOrder *rotationOrder)
	Set rotation order. More...

int	getLightCount ()

SceneLight *	getLightAt (int i)
	Get light at given index. More...

SceneLight *	addLight ()
	Add light. More...

bool	removeLightAt (int i)
	Remove light at given index i. More...

SceneLibrary *	getLibrary ()

const Vector3 &	getDimension ()

BoundingBox *	getBoundingBox ()

const Vector3 &	getCenter ()

int	allocateEntityId ()

int	getEntityIdx ()

void	setEntityIdx (int entityIdx)
	Set entity idx. More...

void	clearEntities ()
	Clears all scene entities. More...

void	getEntitiesByPrototypeId (int prototypeId, vector< string > &entitiesByPrototypeId)
	Get entities with given prototype id. More...

void	removeEntitiesByPrototypeId (int prototypeId)
	Remove entities with given prototype id. More...

void	replacePrototypeByIds (int searchPrototypeId, int newPrototypeId)
	Replace prototype of given search prototype with new prototype. More...

set< string >	getEnvironmentMappingIds ()

void	addEntity (SceneEntity *entity)
	Adds an entity to scene. More...

bool	removeEntity (const string &id)
	Removes an entity from scene. More...

bool	renameEntity (const string &id, const string &newId)
	Rename an entity from scene. More...

SceneEntity *	getEntity (const string &id)
	Returns scene entity by id. More...

int	getEntityCount ()

SceneEntity *	getEntityAt (int idx)
	Returns entity at given index. More...

const string &	getSkyModelFileName ()

void	setSkyModelFileName (const string &skyModelFileName)
	Set sky model file name. More...

Model *	getSkyModel ()

void	setSkyModel (Model *model)
	Set sky model. More...

const Vector3 &	getSkyModelScale ()

void	setSkyModelScale (const Vector3 &skyModelScale)
	Set sky model scale. More...

void	update ()
	Update scene dimension, bounding box, center. More...

Public Member Functions inherited from BaseProperties
	BaseProperties (const string &name, const string &description)
	Public constructor. More...

virtual	~BaseProperties ()
	Destructor. More...

const string &	getName ()

void	setName (const string &name)
	Set up name. More...

const string &	getDescription ()

void	setDescription (const string &description)
	Set up description. More...

void	clearProperties ()
	Clears properties. More...

BaseProperty *	getProperty (const string &name)
	Retrieve property by name. More...

int	getPropertyCount ()

int	getPropertyIndex (const string &name)
	Get property index. More...

BaseProperty *	getPropertyByIndex (int idx)
	Get property by index. More...

bool	addProperty (const string &name, const string &value)
	Add a property. More...

bool	renameProperty (const string &oldName, const string &name)
	Rename a property. More...

bool	updateProperty (const string &oldName, const string &name, const string &value)
	Update a property. More...

bool	removeProperty (const string &name)
	Removes a property. More...

Private Member Functions
void	computeBoundingBox ()
	Computes scene bounding box. More...

void	computeCenter ()

Private Attributes
string	applicationRootPathName

string	fileName

RotationOrder *	rotationOrder { nullptr }

vector< SceneLight * >	lights

SceneLibrary *	library { nullptr }

map< string, SceneEntity * >	entitiesById

vector< SceneEntity * >	entities

set< string >	environmentMappingIds

int	entityIdx

BoundingBox	boundingBox

Vector3	dimension

Vector3	center

string	skyModelFileName

Model *	skyModel { nullptr }

Vector3	skyModelScale

Additional Inherited Members
Protected Attributes inherited from BaseProperties
string	name

string	description

Detailed Description

Scene definition.

Author: Andreas Drewke

Version: $Id$

Definition at line 39 of file Scene.h.

Constructor & Destructor Documentation

◆ Scene()

Scene	(	const string &	name,
		const string &	description
	)

Public constructor.

Parameters

name	name
description	description

Definition at line 47 of file Scene.cpp.

◆ ~Scene()

~Scene ( )

Destructor.

Definition at line 70 of file Scene.cpp.

Member Function Documentation

◆ addEntity()

void addEntity ( SceneEntity * entity )

Adds an entity to scene.

Parameters

object object

Definition at line 211 of file Scene.cpp.

◆ addLight()

SceneLight * addLight ( )

inline

Add light.

Returns: light

Definition at line 149 of file Scene.h.

◆ allocateEntityId()

int allocateEntityId ( )

inline

Returns: new entity id

Definition at line 196 of file Scene.h.

◆ clearEntities()

void clearEntities ( )

Clears all scene entities.

Definition at line 173 of file Scene.cpp.

◆ computeBoundingBox()

void computeBoundingBox ( )

private

Computes scene bounding box.

Returns: dimension

Definition at line 80 of file Scene.cpp.

◆ computeCenter()

void computeCenter ( )

private

Returns: scene center

Definition at line 168 of file Scene.cpp.

◆ getApplicationRootPathName()

const string & getApplicationRootPathName ( )

inline

Returns: application root path name

Definition at line 86 of file Scene.h.

◆ getBoundingBox()

BoundingBox * getBoundingBox ( )

inline

Returns: scene bounding box

Definition at line 182 of file Scene.h.

◆ getCenter()

const Vector3 & getCenter ( )

inline

Returns: scene center

Definition at line 189 of file Scene.h.

◆ getDimension()

const Vector3 & getDimension ( )

inline

Returns: dimension

Definition at line 175 of file Scene.h.

◆ getEntitiesByPrototypeId()

void getEntitiesByPrototypeId	(	int	prototypeId,
		vector< string > &	entitiesByPrototypeId
	)

Get entities with given prototype id.

Parameters

prototypeId	prototype id
entitiesByPrototypeId	entities by prototype id

Definition at line 181 of file Scene.cpp.

◆ getEntity()

SceneEntity * getEntity ( const string & id )

Returns scene entity by id.

Parameters

id id

Returns: scene entity

Definition at line 259 of file Scene.cpp.

◆ getEntityAt()

SceneEntity * getEntityAt ( int idx )

inline

Returns entity at given index.

Parameters

idx index

Returns: scene entity

Definition at line 287 of file Scene.h.

◆ getEntityCount()

int getEntityCount ( )

inline

Returns: number of entities

Definition at line 278 of file Scene.h.

◆ getEntityIdx()

int getEntityIdx ( )

inline

Returns: entity idx

Definition at line 203 of file Scene.h.

◆ getEnvironmentMappingIds()

set< string > getEnvironmentMappingIds ( )

inline

Returns: environment mapping object ids

Definition at line 243 of file Scene.h.

◆ getFileName()

const string & getFileName ( )

inline

Returns: scene file name including relative path

Definition at line 101 of file Scene.h.

◆ getLibrary()

SceneLibrary * getLibrary ( )

inline

Returns: scene prototype library

Definition at line 168 of file Scene.h.

◆ getLightAt()

SceneLight * getLightAt ( int i )

inline

Get light at given index.

Parameters

i index

Returns: light

Definition at line 140 of file Scene.h.

◆ getLightCount()

int getLightCount ( )

inline

Returns: number of lights

Definition at line 131 of file Scene.h.

◆ getRotationOrder()

RotationOrder * getRotationOrder ( )

inline

Returns: rotation order

Definition at line 116 of file Scene.h.

◆ getSkyModel()

Model * getSkyModel ( )

inline

Returns: sky model

Definition at line 309 of file Scene.h.

◆ getSkyModelFileName()

const string & getSkyModelFileName ( )

inline

Returns: sky model file name

Definition at line 294 of file Scene.h.

◆ getSkyModelScale()

const Vector3 & getSkyModelScale ( )

inline

Returns: sky model scale

Definition at line 321 of file Scene.h.

◆ removeEntitiesByPrototypeId()

void removeEntitiesByPrototypeId ( int prototypeId )

Remove entities with given prototype id.

Parameters

prototypeId prototype id

Definition at line 189 of file Scene.cpp.

◆ removeEntity()

bool removeEntity ( const string & id )

Removes an entity from scene.

Parameters

id id

Returns: success

Definition at line 227 of file Scene.cpp.

◆ removeLightAt()

bool removeLightAt ( int i )

inline

Remove light at given index i.

Parameters

i index

Returns: success

Definition at line 159 of file Scene.h.

◆ renameEntity()

bool renameEntity	(	const string &	id,
		const string &	newId
	)

Rename an entity from scene.

Parameters

id	id
newId	new id

Returns: success

Definition at line 242 of file Scene.cpp.

◆ replacePrototypeByIds()

void replacePrototypeByIds	(	int	searchPrototypeId,
		int	newPrototypeId
	)

Replace prototype of given search prototype with new prototype.

Parameters

searchPrototypeId	search prototype id
newPrototypeId	new prototype id

Definition at line 198 of file Scene.cpp.

◆ setApplicationRootPathName()

void setApplicationRootPathName ( const string & applicationRootPathName )

inline

Set application root path name.

Parameters

applicationRootPathName application root path name

Definition at line 94 of file Scene.h.

◆ setEntityIdx()

void setEntityIdx ( int entityIdx )

inline

Set entity idx.

Parameters

entityIdx objectIdx

Definition at line 211 of file Scene.h.

◆ setFileName()

void setFileName ( const string & fileName )

inline

Set up scene file name including relative path.

Parameters

fileName scene file name including relative path

Definition at line 109 of file Scene.h.

◆ setRotationOrder()

void setRotationOrder ( RotationOrder * rotationOrder )

inline

Set rotation order.

Parameters

rotationOrder rotation order

Definition at line 124 of file Scene.h.

◆ setSkyModel()

void setSkyModel ( Model * model )

Set sky model.

Definition at line 268 of file Scene.cpp.

◆ setSkyModelFileName()

void setSkyModelFileName ( const string & skyModelFileName )

inline

Set sky model file name.

Parameters

skyModelFileName sky model file name

Definition at line 302 of file Scene.h.

◆ setSkyModelScale()

void setSkyModelScale ( const Vector3 & skyModelScale )

inline

Set sky model scale.

Definition at line 328 of file Scene.h.

◆ update()

void update ( )

Update scene dimension, bounding box, center.

Definition at line 274 of file Scene.cpp.

Member Data Documentation

◆ applicationRootPathName

string applicationRootPathName

private

Definition at line 43 of file Scene.h.

◆ boundingBox

BoundingBox boundingBox

private

Definition at line 52 of file Scene.h.

◆ center

Vector3 center

private

Definition at line 54 of file Scene.h.

◆ dimension

Vector3 dimension

private

Definition at line 53 of file Scene.h.

◆ entities

vector<SceneEntity*> entities

private

Definition at line 49 of file Scene.h.

◆ entitiesById

map<string, SceneEntity*> entitiesById

private

Definition at line 48 of file Scene.h.

◆ entityIdx

int entityIdx

private

Definition at line 51 of file Scene.h.

◆ environmentMappingIds

set<string> environmentMappingIds

private

Definition at line 50 of file Scene.h.

◆ fileName

string fileName

private

Definition at line 44 of file Scene.h.

◆ library

SceneLibrary* library { nullptr }

private

Definition at line 47 of file Scene.h.

◆ lights

vector<SceneLight*> lights

private

Definition at line 46 of file Scene.h.

◆ rotationOrder

RotationOrder* rotationOrder { nullptr }

private

Definition at line 45 of file Scene.h.

◆ skyModel

Model* skyModel { nullptr }

private

Definition at line 56 of file Scene.h.

◆ skyModelFileName

string skyModelFileName

private

Definition at line 55 of file Scene.h.

◆ skyModelScale

Vector3 skyModelScale

private

Definition at line 57 of file Scene.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/scene/Scene.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/scene/Scene.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Scene()

◆ ~Scene()

Member Function Documentation

◆ addEntity()

◆ addLight()

◆ allocateEntityId()

◆ clearEntities()

◆ computeBoundingBox()

◆ computeCenter()

◆ getApplicationRootPathName()

◆ getBoundingBox()

◆ getCenter()

◆ getDimension()

◆ getEntitiesByPrototypeId()

◆ getEntity()

◆ getEntityAt()

◆ getEntityCount()

◆ getEntityIdx()

◆ getEnvironmentMappingIds()

◆ getFileName()

◆ getLibrary()

◆ getLightAt()

◆ getLightCount()

◆ getRotationOrder()

◆ getSkyModel()

◆ getSkyModelFileName()

◆ getSkyModelScale()

◆ removeEntitiesByPrototypeId()

◆ removeEntity()

◆ removeLightAt()

◆ renameEntity()

◆ replacePrototypeByIds()

◆ setApplicationRootPathName()

◆ setEntityIdx()

◆ setFileName()

◆ setRotationOrder()

◆ setSkyModel()

◆ setSkyModelFileName()

◆ setSkyModelScale()

◆ update()

Member Data Documentation

◆ applicationRootPathName

◆ boundingBox

◆ center

◆ dimension

◆ entities

◆ entitiesById

◆ entityIdx

◆ environmentMappingIds

◆ fileName

◆ library

◆ lights

◆ rotationOrder

◆ skyModel

◆ skyModelFileName

◆ skyModelScale