deResourceLoaderTask Class Reference

Resource loader task. More...

#include <deResourceLoaderTask.h>

Inheritance diagram for deResourceLoaderTask:

Public Types
enum	eStates { esPending , esSucceeded , esFailed }
	States. More...
enum	eTypes { etRead , etWrite }
	Types. More...

Public Member Functions
Management
deVirtualFileSystem *	GetVFS () const
	Virtual file system. More...
const decString &	GetPath () const
	Path. More...
deResourceLoader::eResourceType	GetResourceType () const
	Resource type. More...
bool	Matches (deVirtualFileSystem *vfs, const char *path, deResourceLoader::eResourceType resourceType) const
	Task matches the given path/resourceType. More...
deFileResource *	GetResource () const
	Resource or NULL. More...
eStates	GetState () const
	State. More...
eTypes	GetType () const
	Type. More...
Public Member Functions inherited from deParallelTask
deBaseModule *	GetOwner () const
	Module owning the task or NULL if global. More...
bool	GetMarkFinishedAfterRun () const
	Mark task finished after Run() method leaves. More...
void	SetMarkFinishedAfterRun (bool markFinishedAfterRun)
	Set if task is marked finished after Run() method leaves. More...
bool	GetEmptyRun () const
	Task has empty run implementation. More...
void	SetEmptyRun (bool emptyRun)
	Set if task has empty run implementation. More...
bool	GetLowPriority () const
	Task has lower priority than other tasks. More...
void	SetLowPriority (bool lowPriority)
	Set if task has lower priority than other tasks. More...
bool	IsCancelled () const
	Task has been cancelled. More...
void	Cancel ()
	Cancel task. More...
bool	GetFinished () const
	Task is finished. More...
void	SetFinished ()
	Set task finished. More...
int	GetDependsOnCount () const
	Number of tasks this task depends on. More...
deParallelTask *	GetDependsOnAt (int index) const
	Depend on task at index. More...
bool	DoesDependOn (deParallelTask *task) const
	Task depends on another task. More...
void	AddDependsOn (deParallelTask *task)
	Add task this task depends on. More...
void	RemoveDependsOn (deParallelTask *task)
	Remove task this task depends on. More...
void	RemoveAllDependsOn ()
	Remove all tasks this task depends on. More...
decThreadSafeObjectOrderedSet &	GetDependedOnBy ()
	List of tasks depending on this task. More...
const decThreadSafeObjectOrderedSet &	GetDependedOnBy () const
void	RemoveFromAllDependedOnTasks ()
	Remove from all tasks depending on this task. More...
bool	CanRun () const
	Task can run. More...
void	Reset ()
	Reset task. More...
virtual void	Run ()=0
	Parallel task implementation. More...
virtual void	Finished ()=0
	Processing of task Run() finished. More...
virtual void	Cancelled ()
	Parallel task implementation has been cancelled. More...
	deParallelTask (deBaseModule *owner)
	Create task. More...
Public Member Functions inherited from deThreadSafeObject
int	GetRefCount ()
	Reference count. More...
void	AddReference ()
	Add reference increasing reference count by 1. More...
void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...
	deThreadSafeObject ()
	Create object with reference count of 1. More...

Protected Member Functions
Constructors and Destructors
	deResourceLoaderTask (deEngine &engine, deResourceLoader &resourceLoader, deVirtualFileSystem *vfs, const char *path, deResourceLoader::eResourceType resourceType)
	Create task. More...
virtual	~deResourceLoaderTask ()
	Clean up task. More...
Protected Member Functions inherited from deParallelTask
virtual	~deParallelTask ()
	Clean up task. More...
Protected Member Functions inherited from deThreadSafeObject
virtual	~deThreadSafeObject ()
	Clean up object. More...

Debugging
deEngine &	GetEngine ()
deResourceLoader &	GetResourceLoader ()
void	SetResource (deFileResource *resource)
void	SetState (eStates state)
void	SetType (eTypes type)
void	LogCreateEnter ()
void	LogCreateExit ()
void	LogRunEnter ()
void	LogRunExit ()
void	LogFinishedEnter ()
void	LogFinishedExit ()
void	LogFinished ()
virtual decString	GetDebugName () const
	Short task name for debugging. More...
virtual decString	GetDebugDetails () const
	Task details for debugging. More...

Detailed Description

Resource loader task.

Member Enumeration Documentation

eStates

enum deResourceLoaderTask::eStates

States.

Enumerator
esPending	Pending.
esSucceeded	Succeeded.
esFailed	Failed.

eTypes

enum deResourceLoaderTask::eTypes

Types.

Enumerator
etRead	Read.
etWrite	Write.

Constructor & Destructor Documentation

deResourceLoaderTask()

deResourceLoaderTask::deResourceLoaderTask ( deEngine &  engine, deResourceLoader &  resourceLoader, deVirtualFileSystem *  vfs, const char *  path, deResourceLoader::eResourceType  resourceType  )

protected

Create task.

~deResourceLoaderTask()

virtual deResourceLoaderTask::~deResourceLoaderTask ( )

protectedvirtual

Clean up task.

Member Function Documentation

GetDebugDetails()

virtual decString deResourceLoaderTask::GetDebugDetails ( ) const

virtual

Task details for debugging.

Reimplemented from deParallelTask.

GetDebugName()

virtual decString deResourceLoaderTask::GetDebugName ( ) const

virtual

Short task name for debugging.

Reimplemented from deParallelTask.

Reimplemented in deRLTaskWriteRig, deRLTaskWriteOcclusionMesh, deRLTaskWriteModel, deRLTaskWriteImage, deRLTaskWriteAnimation, deRLTaskReadVideo, deRLTaskReadSound, deRLTaskReadSkinInternal, deRLTaskReadSkin, deRLTaskReadRig, deRLTaskReadOcclusionMesh, deRLTaskReadModel, deRLTaskReadLanguagePack, deRLTaskReadImage, deRLTaskReadFontInternal2, deRLTaskReadFontInternal, deRLTaskReadFont, and deRLTaskReadAnimation.

GetEngine()

deEngine& deResourceLoaderTask::GetEngine ( )

inlineprotected

GetPath()

const decString& deResourceLoaderTask::GetPath ( ) const

inline

Path.

GetResource()

deFileResource* deResourceLoaderTask::GetResource ( ) const

inline

Resource or NULL.

GetResourceLoader()

deResourceLoader& deResourceLoaderTask::GetResourceLoader ( )

inlineprotected

GetResourceType()

deResourceLoader::eResourceType deResourceLoaderTask::GetResourceType ( ) const

inline

Resource type.

GetState()

eStates deResourceLoaderTask::GetState ( ) const

inline

State.

GetType()

eTypes deResourceLoaderTask::GetType ( ) const

inline

Type.

GetVFS()

deVirtualFileSystem* deResourceLoaderTask::GetVFS ( ) const

inline

Virtual file system.

LogCreateEnter()

void deResourceLoaderTask::LogCreateEnter ( )

protected

LogCreateExit()

void deResourceLoaderTask::LogCreateExit ( )

protected

LogFinished()

void deResourceLoaderTask::LogFinished ( )

protected

LogFinishedEnter()

void deResourceLoaderTask::LogFinishedEnter ( )

protected

LogFinishedExit()

void deResourceLoaderTask::LogFinishedExit ( )

protected

LogRunEnter()

void deResourceLoaderTask::LogRunEnter ( )

protected

LogRunExit()

void deResourceLoaderTask::LogRunExit ( )

protected

Matches()

bool deResourceLoaderTask::Matches	(	deVirtualFileSystem *	vfs,
		const char *	path,
		deResourceLoader::eResourceType	resourceType
	)		const

Task matches the given path/resourceType.

SetResource()

void deResourceLoaderTask::SetResource ( deFileResource *  resource )

protected

SetState()

void deResourceLoaderTask::SetState ( eStates  state )

protected

SetType()

void deResourceLoaderTask::SetType ( eTypes  type )

protected

---

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

• deResourceLoaderTask.h