SO3::SScene Class Reference

#include <SO3Scene.h>

Inheritance diagram for SO3::SScene:

Public Member Functions
	SScene (SRoot *parent, std::string sceneName, int scolChannel)
	~SScene ()
void	clearOgreScene ()
Ogre::SceneManager *	GetOgreScenePointer ()
SNode *	GetRootNode ()
SNode *	GetNode (std::string nodeName)
const SNodeMap &	GetNodeList () const
SNode *	CreateNode (std::string newNodeName)
void	DeleteNode (SNode *existingNode)
SCamera *	CreateCamera (std::string newCameraName)
void	DeleteCamera (SCamera *existingCamera)
SEntity *	CreateEntity (std::string groupName, std::string newEntityName, std::string meshName)
SEntityFap *	CreateEntityFap (std::string newEntityFapName, std::string meshName, std::string pathStdFDP, std::string pathStdIndices)
SEntity *	CreateEntity (std::string newEntityName, SEntity::EntityPrefabType prefabType)
SEntity *	CreatePlane (std::string groupName, std::string newEntityName, SPointFloat sizev, SPointInt seg, SPointFloat uv)
void	DeleteEntity (SEntity *existingEntity)
void	ReloadEntities ()
SSkeleton *	CreateSkeleton (std::string newSkeletonName, SEntity *entity)
void	DeleteSkeleton (SSkeleton *existingSkeleton)
SBone *	CreateBone (std::string newBoneName, SSkeleton *skeleton, unsigned short id)
void	DeleteBone (SBone *existingBone)
SParticleSystem *	CreateParticleSystem (std::string newParticleSystemName, std::string particleSystemTemplate)
void	DeleteParticleSystem (SParticleSystem *existingParticleSystem)
SLight *	CreateLight (std::string newLightName)
void	DeleteLight (SLight *existingLight)
SDynamicCubeMap *	CreateDynamicCubeMap (std::string newDynamicCubeMapName)
void	DeleteDynamicCubeMap (SDynamicCubeMap *existingDynamicCubeMap)
SDynamicReflectionMap *	CreateDynamicReflectionMap (SViewPort *viewport, std::string newDynamicReflectionMapName)
void	DeleteDynamicReflectionMap (SDynamicReflectionMap *existingDynamicReflectionMap)
SMaterial *	CreateMaterial (std::string groupname, std::string matname)
void	DeleteMaterial (SMaterial *material)
SMaterial *	GetMaterial (std::string groupName, std::string materialName)
STexture *	CreateTexture (std::string groupname, std::string texname, std::string path, int w=0, int h=0)
void	DeleteTexture (STexture *texture)
STexture *	GetTexture (std::string groupName, std::string texName)
SRoot *	GetParent ()
SPhysicWorld *	GetPhysicsWorld ()
SSequenceAnimation *	CreateAnimationSequence (std::string animationName)
void	AddAnimation (SAnim *existingAnimation)
void	RemoveAnimation (SAnim *existingAnimation)
void	RemoveAnimation (std::string animationName)
void	DeleteAnimation (SAnim *existingAnimation)
unsigned short	GetNumAnimations ()
SAnim *	GetAnimation (std::string animationName)
SAnimMap	GetAnimations () const
SEnvironment *	GetEnvironment () const
Public Attributes
const int	channel
Ogre::SceneManager *	O3SceneManager
Ogre::MeshManager *	O3MeshManager
Ogre::MaterialManager *	O3MaterialManager
Ogre::SkeletonManager *	O3SkeletonManager
Ogre::TextureManager *	O3TextureManager
Ogre::GpuProgramManager *	O3GpuProgramManager
Ogre::HighLevelGpuProgramManager *	O3HighLevelGpuProgramManager
Ogre::ParticleSystemManager *	O3ParticleSystemManager
SO3ParticleFrameListener *	particleListener
SO3MainFrameListener *	mainListener
bool	hasSkyBox
bool	skyBoxDrawFirst
bool	hasSkyDome
bool	skyDomeDrawFirst
bool	hasSkyPlane
bool	skyPlaneDrawFirst
Ogre::MaterialPtr	skyBoxMat
Ogre::MaterialPtr	skyDomeMat
Ogre::MaterialPtr	skyPlaneMat
Ogre::MaterialPtr	materialCaster
Ogre::MaterialPtr	materialReceiver
Ogre::Plane	skyPlane
Ogre::String	curMessage
int	shadowCameraSetup
Ogre::ShadowCameraSetupPtr	mCurrentShadowCameraSetup
SGroupMaterialMap	listOfMaterial
SGroupTextureMap	listOfTexture
SEnvironment *	environment
Protected Member Functions
void	AddNode (SNode *existingNode)
void	RemoveNode (SNode *existingNode)
void	RemoveNode (std::string nodeName)

Detailed Description

Definition at line 163 of file SO3Scene.h.

Constructor & Destructor Documentation

SO3::SScene::SScene	(	SRoot *	parent,
		std::string	sceneName,
		int	scolChannel
	)

Constructor.

Definition at line 222 of file SO3Scene.cpp.

SO3::SScene::~SScene ( )

Destructor.

Definition at line 417 of file SO3Scene.cpp.

Member Function Documentation

void SO3::SScene::AddAnimation ( SAnim * existingAnimation )

Add a SAnim object to the list of handled animations.

Definition at line 829 of file SO3Scene.cpp.

void SO3::SScene::AddNode ( SNode * existingNode ) [protected]

Add a SNode object to the list of handled nodes.

Definition at line 450 of file SO3Scene.cpp.

void SO3::SScene::clearOgreScene ( )

Definition at line 269 of file SO3Scene.cpp.

SSequenceAnimation * SO3::SScene::CreateAnimationSequence ( std::string animationName )

Definition at line 792 of file SO3Scene.cpp.

SBone * SO3::SScene::CreateBone	(	std::string	newBoneName,
		SSkeleton *	skeleton,
		unsigned short	id
	)

Create a new SBone Object

Definition at line 598 of file SO3Scene.cpp.

SCamera * SO3::SScene::CreateCamera ( std::string newCameraName )

Create a new SCamera Object

Definition at line 524 of file SO3Scene.cpp.

SDynamicCubeMap * SO3::SScene::CreateDynamicCubeMap ( std::string newDynamicCubeMapName )

Create a new SDynamicCubeMap Object

Definition at line 634 of file SO3Scene.cpp.

SDynamicReflectionMap * SO3::SScene::CreateDynamicReflectionMap	(	SViewPort *	viewport,
		std::string	newDynamicReflectionMapName
	)

Create a new SDynamicReflectionMap Object

Definition at line 646 of file SO3Scene.cpp.

SEntity * SO3::SScene::CreateEntity	(	std::string	newEntityName,
		SEntity::EntityPrefabType	prefabType
	)

Create a new SEntity Object, using a prefab type

Definition at line 551 of file SO3Scene.cpp.

SEntity * SO3::SScene::CreateEntity	(	std::string	groupName,
		std::string	newEntityName,
		std::string	meshName
	)

Create a new SEntity Object

Definition at line 536 of file SO3Scene.cpp.

SEntityFap * SO3::SScene::CreateEntityFap	(	std::string	newEntityFapName,
		std::string	meshName,
		std::string	pathStdFDP,
		std::string	pathStdIndices
	)

Create a new SEntityFap Object

Definition at line 543 of file SO3Scene.cpp.

SLight * SO3::SScene::CreateLight ( std::string newLightName )

Create a new SLight Object

Definition at line 622 of file SO3Scene.cpp.

SMaterial * SO3::SScene::CreateMaterial	(	std::string	groupname,
		std::string	matname
	)

Create a new scene material

Definition at line 658 of file SO3Scene.cpp.

SNode * SO3::SScene::CreateNode ( std::string newNodeName )

Create a new SNode Object

Definition at line 508 of file SO3Scene.cpp.

SParticleSystem * SO3::SScene::CreateParticleSystem	(	std::string	newParticleSystemName,
		std::string	particleSystemTemplate
	)

Create a new SParticleSystem Object

Definition at line 610 of file SO3Scene.cpp.

SEntity * SO3::SScene::CreatePlane	(	std::string	groupName,
		std::string	newEntityName,
		SPointFloat	sizev,
		SPointInt	seg,
		SPointFloat	uv
	)

Create a plane object

Definition at line 558 of file SO3Scene.cpp.

SSkeleton * SO3::SScene::CreateSkeleton	(	std::string	newSkeletonName,
		SEntity *	entity
	)

Create a new SSkeleton Object

Definition at line 583 of file SO3Scene.cpp.

STexture * SO3::SScene::CreateTexture	(	std::string	groupname,
		std::string	texname,
		std::string	path,
		int	w = `0`,
		int	h = `0`
	)

Create a new scene texture

Definition at line 717 of file SO3Scene.cpp.

void SO3::SScene::DeleteAnimation ( SAnim * existingAnimation )

Delete manually an sequence animation.

Definition at line 799 of file SO3Scene.cpp.

void SO3::SScene::DeleteBone ( SBone * existingBone )

Delete an existing SBone Object

Definition at line 605 of file SO3Scene.cpp.

void SO3::SScene::DeleteCamera ( SCamera * existingCamera )

Delete an existing SCamera Object

Definition at line 531 of file SO3Scene.cpp.

void SO3::SScene::DeleteDynamicCubeMap ( SDynamicCubeMap * existingDynamicCubeMap )

Delete an existing SDynamicCubeMap Object

Definition at line 641 of file SO3Scene.cpp.

void SO3::SScene::DeleteDynamicReflectionMap ( SDynamicReflectionMap * existingDynamicReflectionMap )

Delete an existing SDynamicReflectionMap Object

Definition at line 653 of file SO3Scene.cpp.

void SO3::SScene::DeleteEntity ( SEntity * existingEntity )

Delete an existing SEntity Object

Definition at line 565 of file SO3Scene.cpp.

void SO3::SScene::DeleteLight ( SLight * existingLight )

Delete an existing SLight Object

Definition at line 629 of file SO3Scene.cpp.

void SO3::SScene::DeleteMaterial ( SMaterial * material )

Delete a scene material

Definition at line 681 of file SO3Scene.cpp.

void SO3::SScene::DeleteNode ( SNode * existingNode )

Delete an existing SNode Object

Definition at line 515 of file SO3Scene.cpp.

void SO3::SScene::DeleteParticleSystem ( SParticleSystem * existingParticleSystem )

Delete an existing SParticleSystem Object

Definition at line 617 of file SO3Scene.cpp.

void SO3::SScene::DeleteSkeleton ( SSkeleton * existingSkeleton )

Delete an existing SSkeleton Object

Definition at line 593 of file SO3Scene.cpp.

void SO3::SScene::DeleteTexture ( STexture * texture )

Delete a scene texture

Definition at line 741 of file SO3Scene.cpp.

SAnim * SO3::SScene::GetAnimation ( std::string animationName )

Definition at line 815 of file SO3Scene.cpp.

SAnimMap SO3::SScene::GetAnimations ( ) const

Definition at line 824 of file SO3Scene.cpp.

SEnvironment * SO3::SScene::GetEnvironment ( ) const

Definition at line 864 of file SO3Scene.cpp.

SMaterial * SO3::SScene::GetMaterial	(	std::string	groupName,
		std::string	materialName
	)

Return the SMaterial pointer corresponding to the name of an existing material handled by this class.

Definition at line 701 of file SO3Scene.cpp.

SNode * SO3::SScene::GetNode ( std::string nodeName )

Return the SNode pointer corresponding to the name of an existing node handled by this class.

Definition at line 494 of file SO3Scene.cpp.

const SNodeMap & SO3::SScene::GetNodeList ( ) const

Get a list of the handled nodes.

Definition at line 503 of file SO3Scene.cpp.

unsigned short SO3::SScene::GetNumAnimations ( )

Definition at line 810 of file SO3Scene.cpp.

Ogre::SceneManager * SO3::SScene::GetOgreScenePointer ( )

Definition at line 484 of file SO3Scene.cpp.

SRoot * SO3::SScene::GetParent ( )

Definition at line 782 of file SO3Scene.cpp.

SPhysicWorld * SO3::SScene::GetPhysicsWorld ( )

Definition at line 787 of file SO3Scene.cpp.

SNode * SO3::SScene::GetRootNode ( )

Return the scene root SNode.

Definition at line 489 of file SO3Scene.cpp.

STexture * SO3::SScene::GetTexture	(	std::string	groupName,
		std::string	texName
	)

Return the STexture pointer corresponding to the name of an existing texture handled by this class.

Definition at line 766 of file SO3Scene.cpp.

void SO3::SScene::ReloadEntities ( )

Reload all scene entities

Definition at line 570 of file SO3Scene.cpp.

void SO3::SScene::RemoveAnimation ( std::string animationName )

Remove a SAnim object from the list of handled animations.

Definition at line 849 of file SO3Scene.cpp.

void SO3::SScene::RemoveAnimation ( SAnim * existingAnimation )

Remove a SAnim object from the list of handled animations.

Definition at line 844 of file SO3Scene.cpp.

void SO3::SScene::RemoveNode ( std::string nodeName ) [protected]

Remove a SScene object from the list of handled nodes.

Definition at line 470 of file SO3Scene.cpp.

void SO3::SScene::RemoveNode ( SNode * existingNode ) [protected]

Remove a SNode object from the list of handled nodes.

Definition at line 465 of file SO3Scene.cpp.

Member Data Documentation

const int SO3::SScene::channel

Definition at line 167 of file SO3Scene.h.

Ogre::String SO3::SScene::curMessage

Definition at line 190 of file SO3Scene.h.

SEnvironment* SO3::SScene::environment

Definition at line 195 of file SO3Scene.h.

bool SO3::SScene::hasSkyBox

Definition at line 178 of file SO3Scene.h.

bool SO3::SScene::hasSkyDome

Definition at line 180 of file SO3Scene.h.

bool SO3::SScene::hasSkyPlane

Definition at line 182 of file SO3Scene.h.

SGroupMaterialMap SO3::SScene::listOfMaterial

Definition at line 193 of file SO3Scene.h.

SGroupTextureMap SO3::SScene::listOfTexture

Definition at line 194 of file SO3Scene.h.

SO3MainFrameListener* SO3::SScene::mainListener

Definition at line 177 of file SO3Scene.h.

Ogre::MaterialPtr SO3::SScene::materialCaster

Definition at line 187 of file SO3Scene.h.

Ogre::MaterialPtr SO3::SScene::materialReceiver

Definition at line 188 of file SO3Scene.h.

Ogre::ShadowCameraSetupPtr SO3::SScene::mCurrentShadowCameraSetup

Definition at line 192 of file SO3Scene.h.

Ogre::GpuProgramManager* SO3::SScene::O3GpuProgramManager

Definition at line 173 of file SO3Scene.h.

Ogre::HighLevelGpuProgramManager* SO3::SScene::O3HighLevelGpuProgramManager

Definition at line 174 of file SO3Scene.h.

Ogre::MaterialManager* SO3::SScene::O3MaterialManager

Definition at line 170 of file SO3Scene.h.

Ogre::MeshManager* SO3::SScene::O3MeshManager

Definition at line 169 of file SO3Scene.h.

Ogre::ParticleSystemManager* SO3::SScene::O3ParticleSystemManager

Definition at line 175 of file SO3Scene.h.

Ogre::SceneManager* SO3::SScene::O3SceneManager

Definition at line 168 of file SO3Scene.h.

Ogre::SkeletonManager* SO3::SScene::O3SkeletonManager

Definition at line 171 of file SO3Scene.h.

Ogre::TextureManager* SO3::SScene::O3TextureManager

Definition at line 172 of file SO3Scene.h.

SO3ParticleFrameListener* SO3::SScene::particleListener

Definition at line 176 of file SO3Scene.h.

int SO3::SScene::shadowCameraSetup

Definition at line 191 of file SO3Scene.h.

bool SO3::SScene::skyBoxDrawFirst

Definition at line 179 of file SO3Scene.h.

Ogre::MaterialPtr SO3::SScene::skyBoxMat

Definition at line 184 of file SO3Scene.h.

bool SO3::SScene::skyDomeDrawFirst

Definition at line 181 of file SO3Scene.h.

Ogre::MaterialPtr SO3::SScene::skyDomeMat

Definition at line 185 of file SO3Scene.h.

Ogre::Plane SO3::SScene::skyPlane

Definition at line 189 of file SO3Scene.h.

bool SO3::SScene::skyPlaneDrawFirst

Definition at line 183 of file SO3Scene.h.

Ogre::MaterialPtr SO3::SScene::skyPlaneMat

Definition at line 186 of file SO3Scene.h.

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

SO3Engine/SO3SceneGraph/SO3Scene.h
SO3Engine/SO3SceneGraph/SO3Scene.cpp

SO3::SScene Class Reference

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation