deResourceManager Class Reference

Base resource manager class. More...

#include <deResourceManager.h>

Inheritance diagram for deResourceManager:

Public Types
enum	eResourceType {   ertAnimation , ertAnimator , ertAnimatorInstance , ertArchive ,   ertBillboard , ertCanvas , ertCamera , ertCaptureCanvas ,   ertCollider , ertComponent , ertConnection , ertDecal ,   ertDebugDrawer , ertDynamicSkin , ertEffect , ertEnvMapProbe ,   ertFont , ertForceField , ertGraphicContext , ertHeightTerrain ,   ertImage , ertLanguagePack , ertLight , ertLocomotion ,   ertLumimeter , ertMicrophone , ertModel , ertNavigationBlocker ,   ertNavigationSpace , ertNavigator , ertNetworkState , ertOccluder ,   ertOcclusionMesh , ertParticleEmitter , ertParticleEmitterInstance , ertPropField ,   ertRenderTarget , ertRenderWindow , ertRig , ertScene ,   ertServer , ertSkin , ertSky , ertSkyInstance ,   ertSmokeEmitter , ertSound , ertSoundLevelMeter , ertSpeaker ,   ertSynthesizer , ertSynthesizerInstance , ertTouchSensor , ertVideo ,   ertVideoPlayer , ertWorld }
	Possible type of a resource manager. More...

Public Member Functions
Constructors and Destructors
	deResourceManager (deEngine *engine, eResourceType type)
	Create resource manager. More...
virtual	~deResourceManager ()
	Clean up resource manager. More...
Management
deEngine *	GetEngine () const
	Game engine. More...
int	GetResourceType () const
	Resources type stored in this manager. More...
const decString &	GetLoggingName () const
	Name to use as the source for this module for logging. More...
void	SetLoggingName (const char *name)
	Set name to use as the source for this module for logging. More...
virtual void	ReleaseLeakingResources ()
	Release leaking resource and report them. More...
Quick System Access
Shortcuts for retrieving various systems from the linked game engine.
deModuleSystem *	GetModuleSystem () const
deGraphicSystem *	GetGraphicSystem () const
dePhysicsSystem *	GetPhysicsSystem () const
deAnimatorSystem *	GetAnimatorSystem () const
deSynthesizerSystem *	GetSynthesizerSystem () const
deAISystem *	GetAISystem () const
deAudioSystem *	GetAudioSystem () const
deNetworkSystem *	GetNetworkSystem () const
deScriptingSystem *	GetScriptingSystem () const
deImageManager *	GetImageManager () const
deVideoManager *	GetVideoManager () const
deSkinManager *	GetSkinManager () const
System Peer Support
virtual void	SystemGraphicLoad ()
	Graphic System Peers of all stored resources have to be created. More...
virtual void	SystemGraphicUnload ()
	Graphic System Peers of all stored resources have to be freed. More...
virtual void	SystemPhysicsLoad ()
	Physics System Peers of all stored resources have to be created. More...
virtual void	SystemPhysicsUnload ()
	Physics System Peers of all stored resources have to be freed. More...
virtual void	SystemScriptingLoad ()
	Scripting System Peers of all stored resources have to be created. More...
virtual void	SystemScriptingUnload ()
	Scripting System Peers of all stored resources have to be freed. More...
virtual void	SystemAnimatorLoad ()
	Animator System Peers of all stored resources have to be created. More...
virtual void	SystemAnimatorUnload ()
	Animator System Peers of all stored resources have to be freed. More...
virtual void	SystemAudioLoad ()
	Audio System Peers of all stored resources have to be created. More...
virtual void	SystemAudioUnload ()
	Audio System Peers of all stored resources have to be freed. More...
virtual void	SystemNetworkLoad ()
	Network System Peers of all stored resources have to be created. More...
virtual void	SystemNetworkUnload ()
	Network System Peers of all stored resources have to be freed. More...
virtual void	SystemAILoad ()
	AI System Peers of all stored resources have to be created. More...
virtual void	SystemAIUnload ()
	AI System Peers of all stored resources have to be freed. More...
virtual void	SystemSynthesizerLoad ()
	Synthesizer system peers of all stored resources have to be created. More...
virtual void	SystemSynthesizerUnload ()
	Synthesizer system peers of all stored resources have to be freed. More...
Debugging
void	LogInfo (const char *message)
	Output information message on the console. More...
void	LogInfoFormat (const char *message,...)
	Output formated information message on the console. More...
void	LogInfoFormatUsing (const char *message, va_list args)
	Output formated information message on the console. More...
void	LogWarn (const char *message)
	Output warning message on the console. More...
void	LogWarnFormat (const char *message,...)
	Output formated warning message on the console. More...
void	LogWarnFormatUsing (const char *message, va_list args)
	Output formated warning message on the console. More...
void	LogError (const char *message)
	Output error message on the console. More...
void	LogErrorFormat (const char *message,...)
	Output formated error message on the console. More...
void	LogErrorFormatUsing (const char *message, va_list args)
	Output formated error message on the console. More...
void	LogException (const deException &exception)
	Output exception as error message on the console. More...
Resource only Functions
Warning For use by deResource only.
virtual void	RemoveResource (deResource *resource)=0
	Removes the given resource from the manager without freeing it. More...

Detailed Description

Base resource manager class.

Provides basic support for resource managers. The actual management of resource the subclass should implement using the resource list class provided (although you are free to do differently if you really know what you are doing). The RemoveResource function is protected and has to be used only by a deResource derived object to notify the resource manager that this object has to be freed from memory. Do not do any reference counting inside the subclass. If a resource is ready to be freed it will tell you by calling RemoveResource.

Member Enumeration Documentation

eResourceType

enum deResourceManager::eResourceType

Possible type of a resource manager.

Enumerator
ertAnimation	Animation resource.
ertAnimator	Animator resource.
ertAnimatorInstance	Animator instance resource.
ertArchive	Archive resource.
ertBillboard	Billboard resource.
ertCanvas	Canvas resource.
ertCamera	Scene Camera resource.
ertCaptureCanvas	Capture canvas resource.
ertCollider	World Collider resource.
ertComponent	Component resource.
ertConnection	Connection resource.
ertDecal	Decal resource.
ertDebugDrawer	Debug Drawer resource.
ertDynamicSkin	Dynamic Skin resource.
ertEffect	Effect resource.
ertEnvMapProbe	Environment map probe resource.
ertFont	Font resource.
ertForceField	Force Field resource.
ertGraphicContext	Graphic Context resource.
ertHeightTerrain	Height Terrain resource.
ertImage	Image resource.
ertLanguagePack	Language Pack resource.
ertLight	Scene Light resource.
ertLocomotion	Locomotion resource.
ertLumimeter	Lumimeter resource.
ertMicrophone	Microphone resource.
ertModel	Model resource.
ertNavigationBlocker	Navigation blocker.
ertNavigationSpace	Navigation space resource.
ertNavigator	Navigator resource.
ertNetworkState	Network state resource.
ertOccluder	Occluder resource.
ertOcclusionMesh	Occlusion mesh resource.
ertParticleEmitter	Particle Emitter resource.
ertParticleEmitterInstance	Particle emitter instance resource.
ertPropField	Prop Field resource.
ertRenderTarget	Render Target resource.
ertRenderWindow	Render Window resource.
ertRig	Rig resource.
ertScene	Scene resource.
ertServer	Server resource.
ertSkin	Skin resource.
ertSky	Sky resource.
ertSkyInstance	Sky instance resource.
ertSmokeEmitter	Smoke Emitter resource.
ertSound	Sound resource.
ertSoundLevelMeter	Sound level meter resource.
ertSpeaker	Speaker resource.
ertSynthesizer	Synthesizer resource.
ertSynthesizerInstance	Synthesizer instance resource.
ertTouchSensor	Touch Sensor resource.
ertVideo	Video resource.
ertVideoPlayer	Video player resource.
ertWorld	World resource.

Constructor & Destructor Documentation

deResourceManager()

deResourceManager::deResourceManager	(	deEngine *	engine,
		eResourceType	type
	)

Create resource manager.

~deResourceManager()

virtual deResourceManager::~deResourceManager ( )

virtual

Clean up resource manager.

Member Function Documentation

GetAISystem()

deAISystem* deResourceManager::GetAISystem

(

)

const

GetAnimatorSystem()

deAnimatorSystem* deResourceManager::GetAnimatorSystem

(

)

const

GetAudioSystem()

deAudioSystem* deResourceManager::GetAudioSystem

(

)

const

GetEngine()

deEngine* deResourceManager::GetEngine ( ) const

inline

Game engine.

GetGraphicSystem()

deGraphicSystem* deResourceManager::GetGraphicSystem

(

)

const

GetImageManager()

deImageManager* deResourceManager::GetImageManager

(

)

const

GetLoggingName()

const decString& deResourceManager::GetLoggingName ( ) const

inline

Name to use as the source for this module for logging.

GetModuleSystem()

deModuleSystem* deResourceManager::GetModuleSystem

(

)

const

GetNetworkSystem()

deNetworkSystem* deResourceManager::GetNetworkSystem

(

)

const

GetPhysicsSystem()

dePhysicsSystem* deResourceManager::GetPhysicsSystem

(

)

const

GetResourceType()

int deResourceManager::GetResourceType ( ) const

inline

Resources type stored in this manager.

GetScriptingSystem()

deScriptingSystem* deResourceManager::GetScriptingSystem

(

)

const

GetSkinManager()

deSkinManager* deResourceManager::GetSkinManager

(

)

const

GetSynthesizerSystem()

deSynthesizerSystem* deResourceManager::GetSynthesizerSystem

(

)

const

GetVideoManager()

deVideoManager* deResourceManager::GetVideoManager

(

)

const

LogError()

void deResourceManager::LogError

(

const char *

message

)

Output error message on the console.

LogErrorFormat()

void deResourceManager::LogErrorFormat	(	const char *	message,
			...
	)

Output formated error message on the console.

LogErrorFormatUsing()

void deResourceManager::LogErrorFormatUsing	(	const char *	message,
		va_list	args
	)

Output formated error message on the console.

LogException()

void deResourceManager::LogException

(

const deException &

exception

)

Output exception as error message on the console.

LogInfo()

void deResourceManager::LogInfo

(

const char *

message

)

Output information message on the console.

LogInfoFormat()

void deResourceManager::LogInfoFormat	(	const char *	message,
			...
	)

Output formated information message on the console.

LogInfoFormatUsing()

void deResourceManager::LogInfoFormatUsing	(	const char *	message,
		va_list	args
	)

Output formated information message on the console.

LogWarn()

void deResourceManager::LogWarn

(

const char *

message

)

Output warning message on the console.

LogWarnFormat()

void deResourceManager::LogWarnFormat	(	const char *	message,
			...
	)

Output formated warning message on the console.

LogWarnFormatUsing()

void deResourceManager::LogWarnFormatUsing	(	const char *	message,
		va_list	args
	)

Output formated warning message on the console.

ReleaseLeakingResources()

virtual void deResourceManager::ReleaseLeakingResources ( )

virtual

Release leaking resource and report them.

Reimplemented in deWorldManager, deVideoPlayerManager, deVideoManager, deHeightTerrainManager, deSynthesizerManager, deSynthesizerInstanceManager, deSpeakerManager, deSoundManager, deMicrophoneManager, deSmokeEmitterManager, deSkyManager, deSkyInstanceManager, deDynamicSkinManager, deSkinManager, deTouchSensorManager, deSoundLevelMeterManager, deLumimeterManager, deRigManager, deRenderWindowManager, dePropFieldManager, deEnvMapProbeManager, deParticleEmitterManager, deParticleEmitterInstanceManager, deOcclusionMeshManager, deServerManager, deNetworkStateManager, deConnectionManager, deNavigationSpaceManager, deNavigatorManager, deNavigationBlockerManager, deModelManager, deLanguagePackManager, deLightManager, deImageManager, deForceFieldManager, deFontManager, deEffectManager, deDecalManager, deDebugDrawerManager, deComponentManager, deColliderManager, deCanvasManager, deCaptureCanvasManager, deCameraManager, deBillboardManager, deArchiveManager, deAnimatorManager, deAnimatorInstanceManager, and deAnimationManager.

RemoveResource()

virtual void deResourceManager::RemoveResource ( deResource *  resource )

pure virtual

Removes the given resource from the manager without freeing it.

Implemented in deWorldManager, deVideoPlayerManager, deVideoManager, deHeightTerrainManager, deSynthesizerManager, deSynthesizerInstanceManager, deSpeakerManager, deSoundManager, deMicrophoneManager, deSmokeEmitterManager, deSkyManager, deSkyInstanceManager, deDynamicSkinManager, deSkinManager, deTouchSensorManager, deSoundLevelMeterManager, deLumimeterManager, deRigManager, deRenderWindowManager, dePropFieldManager, deEnvMapProbeManager, deParticleEmitterManager, deParticleEmitterInstanceManager, deOcclusionMeshManager, deServerManager, deNetworkStateManager, deConnectionManager, deNavigationSpaceManager, deNavigatorManager, deNavigationBlockerManager, deModelManager, deLanguagePackManager, deLightManager, deImageManager, deForceFieldManager, deFontManager, deEffectManager, deDecalManager, deDebugDrawerManager, deComponentManager, deColliderManager, deCanvasManager, deCaptureCanvasManager, deCameraManager, deBillboardManager, deArchiveManager, deAnimatorManager, deAnimatorInstanceManager, and deAnimationManager.

SetLoggingName()

void deResourceManager::SetLoggingName

(

const char *

name

)

Set name to use as the source for this module for logging.

SystemAILoad()

virtual void deResourceManager::SystemAILoad ( )

virtual

AI System Peers of all stored resources have to be created.

Reimplemented in deWorldManager, deHeightTerrainManager, deNavigationSpaceManager, deNavigatorManager, and deNavigationBlockerManager.

SystemAIUnload()

virtual void deResourceManager::SystemAIUnload ( )

virtual

AI System Peers of all stored resources have to be freed.

Reimplemented in deWorldManager, deHeightTerrainManager, deNavigationSpaceManager, deNavigatorManager, and deNavigationBlockerManager.

SystemAnimatorLoad()

virtual void deResourceManager::SystemAnimatorLoad ( )

virtual

Animator System Peers of all stored resources have to be created.

Reimplemented in deComponentManager, deAnimatorManager, deAnimatorInstanceManager, and deAnimationManager.

SystemAnimatorUnload()

virtual void deResourceManager::SystemAnimatorUnload ( )

virtual

Animator System Peers of all stored resources have to be freed.

Reimplemented in deComponentManager, deAnimatorManager, deAnimatorInstanceManager, and deAnimationManager.

SystemAudioLoad()

virtual void deResourceManager::SystemAudioLoad ( )

virtual

Audio System Peers of all stored resources have to be created.

Reimplemented in deWorldManager, deVideoPlayerManager, deHeightTerrainManager, deSynthesizerInstanceManager, deSpeakerManager, deSoundManager, deMicrophoneManager, deSkinManager, deSoundLevelMeterManager, deModelManager, deDecalManager, and deComponentManager.

SystemAudioUnload()

virtual void deResourceManager::SystemAudioUnload ( )

virtual

Audio System Peers of all stored resources have to be freed.

Reimplemented in deWorldManager, deVideoPlayerManager, deHeightTerrainManager, deSynthesizerInstanceManager, deSpeakerManager, deSoundManager, deMicrophoneManager, deSkinManager, deSoundLevelMeterManager, deModelManager, deDecalManager, and deComponentManager.

SystemGraphicLoad()

virtual void deResourceManager::SystemGraphicLoad ( )

virtual

Graphic System Peers of all stored resources have to be created.

Reimplemented in deWorldManager, deVideoPlayerManager, deVideoManager, deHeightTerrainManager, deSmokeEmitterManager, deSkyManager, deSkyInstanceManager, deDynamicSkinManager, deSkinManager, deLumimeterManager, deRenderWindowManager, dePropFieldManager, deEnvMapProbeManager, deParticleEmitterManager, deParticleEmitterInstanceManager, deOcclusionMeshManager, deModelManager, deLightManager, deImageManager, deFontManager, deEffectManager, deDecalManager, deDebugDrawerManager, deComponentManager, deCanvasManager, deCaptureCanvasManager, deCameraManager, deBillboardManager, and deAnimationManager.

SystemGraphicUnload()

virtual void deResourceManager::SystemGraphicUnload ( )

virtual

Graphic System Peers of all stored resources have to be freed.

Reimplemented in deWorldManager, deVideoPlayerManager, deVideoManager, deHeightTerrainManager, deSmokeEmitterManager, deSkyManager, deSkyInstanceManager, deDynamicSkinManager, deSkinManager, deLumimeterManager, deRenderWindowManager, dePropFieldManager, deEnvMapProbeManager, deParticleEmitterManager, deParticleEmitterInstanceManager, deOcclusionMeshManager, deModelManager, deLightManager, deImageManager, deFontManager, deEffectManager, deDecalManager, deDebugDrawerManager, deComponentManager, deCanvasManager, deCaptureCanvasManager, deCameraManager, deBillboardManager, and deAnimationManager.

SystemNetworkLoad()

virtual void deResourceManager::SystemNetworkLoad ( )

virtual

Network System Peers of all stored resources have to be created.

Reimplemented in deWorldManager, deServerManager, deNetworkStateManager, and deConnectionManager.

SystemNetworkUnload()

virtual void deResourceManager::SystemNetworkUnload ( )

virtual

Network System Peers of all stored resources have to be freed.

Reimplemented in deWorldManager, deServerManager, deNetworkStateManager, and deConnectionManager.

SystemPhysicsLoad()

virtual void deResourceManager::SystemPhysicsLoad ( )

virtual

Physics System Peers of all stored resources have to be created.

Reimplemented in deWorldManager, deHeightTerrainManager, deSmokeEmitterManager, deSkinManager, deTouchSensorManager, deRigManager, dePropFieldManager, deParticleEmitterManager, deParticleEmitterInstanceManager, deModelManager, deForceFieldManager, deDecalManager, deComponentManager, and deColliderManager.

SystemPhysicsUnload()

virtual void deResourceManager::SystemPhysicsUnload ( )

virtual

Physics System Peers of all stored resources have to be freed.

Reimplemented in deWorldManager, deHeightTerrainManager, deSmokeEmitterManager, deSkinManager, deTouchSensorManager, deRigManager, dePropFieldManager, deParticleEmitterManager, deParticleEmitterInstanceManager, deModelManager, deForceFieldManager, deDecalManager, deComponentManager, and deColliderManager.

SystemScriptingLoad()

virtual void deResourceManager::SystemScriptingLoad ( )

virtual

Scripting System Peers of all stored resources have to be created.

Reimplemented in deSpeakerManager, deTouchSensorManager, deSoundLevelMeterManager, dePropFieldManager, deParticleEmitterInstanceManager, deServerManager, deNetworkStateManager, deConnectionManager, and deColliderManager.

SystemScriptingUnload()

virtual void deResourceManager::SystemScriptingUnload ( )

virtual

Scripting System Peers of all stored resources have to be freed.

Reimplemented in deSpeakerManager, deTouchSensorManager, deSoundLevelMeterManager, dePropFieldManager, deParticleEmitterInstanceManager, deServerManager, deNetworkStateManager, deConnectionManager, and deColliderManager.

SystemSynthesizerLoad()

virtual void deResourceManager::SystemSynthesizerLoad ( )

virtual

Synthesizer system peers of all stored resources have to be created.

Reimplemented in deSynthesizerManager, deSynthesizerInstanceManager, and deSoundManager.

SystemSynthesizerUnload()

virtual void deResourceManager::SystemSynthesizerUnload ( )

virtual

Synthesizer system peers of all stored resources have to be freed.

Reimplemented in deSynthesizerManager, deSynthesizerInstanceManager, and deSoundManager.

---

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

• deResourceManager.h