AssetProcessor Class Reference

The AssetProcessor class is responsible for processing all assets in a sub-directory of an AssetGroup. Behaviour for specific assets is implemented by deriving from the AssetProcessor class. More...

Inheritance diagram for AssetProcessor:

[legend]

Collaboration diagram for AssetProcessor:

[legend]

List of all members.

Public Member Functions
	AssetProcessor (AssetGroup *parent, const std::string &baseName)
	Constructor.
	~AssetProcessor ()
	Deconstructor.
const std::string &	getBaseName () const
	Returns the base name.
AssetGroup *	getParent () const
	Gets the parent of this processor.
virtual bool	reloadAsset (const std::string &fileName)
	Reloads the asset with the given filename.
virtual void	reloadAssets ()
	Reloads all assets.
virtual bool	removeAsset (const std::string &fileName)
	Removes the asset with the given filename.
virtual void	removeAssets ()
	Removes all assets.
Protected Member Functions
virtual bool	loadAsset (const std::string &fileName)
	Loads the asset with the given filename.
virtual void	loadAssets ()
	Loads all assets.
Protected Attributes
AssetGroup *	pParent
	Parent of this processor.
std::string	mBaseName
	The base name is the name (i.e. meshes) of the directory that this processor will process.
Friends
class	AssetGroup

---

Detailed Description

The AssetProcessor class is responsible for processing all assets in a sub-directory of an AssetGroup. Behaviour for specific assets is implemented by deriving from the AssetProcessor class.

Definition at line 32 of file AssetProcessor.h.

---

Constructor & Destructor Documentation

AssetProcessor::AssetProcessor	(	AssetGroup *	parent,
		const std::string &	baseName
	)

Constructor.

Definition at line 25 of file AssetProcessor.cpp.

AssetProcessor::~AssetProcessor

(

)

Deconstructor.

Definition at line 33 of file AssetProcessor.cpp.

---

Member Function Documentation

const std::string & AssetProcessor::getBaseName

(

)

const

Returns the base name.

Definition at line 40 of file AssetProcessor.cpp.

AssetGroup * AssetProcessor::getParent

(

)

const

Gets the parent of this processor.

Definition at line 46 of file AssetProcessor.cpp.

bool AssetProcessor::loadAsset

(

const std::string &

fileName

)

[protected, virtual]

Loads the asset with the given filename.

Parameters:

fileName

Filename of the asset.

Returns:

True on succesful loading, false otherwise.

Reimplemented in EntityProcessor, HeightmapProcessor, MeshProcessor, ScriptProcessor, SoundProcessor, and TextureProcessor.

Definition at line 54 of file AssetProcessor.cpp.

void AssetProcessor::loadAssets

(

)

[protected, virtual]

Loads all assets.

Reimplemented in EntityProcessor, HeightmapProcessor, MeshProcessor, ScriptProcessor, SoundProcessor, and TextureProcessor.

Definition at line 60 of file AssetProcessor.cpp.

bool AssetProcessor::reloadAsset

(

const std::string &

fileName

)

[virtual]

Reloads the asset with the given filename.

Parameters:

fileName

Filename of the asset.

Returns:

True on succesful reload, false otherwise.

Reimplemented in EntityProcessor, HeightmapProcessor, MeshProcessor, ScriptProcessor, SoundProcessor, and TextureProcessor.

Definition at line 65 of file AssetProcessor.cpp.

void AssetProcessor::reloadAssets

(

)

[virtual]

Reloads all assets.

Reimplemented in EntityProcessor, HeightmapProcessor, MeshProcessor, ScriptProcessor, SoundProcessor, and TextureProcessor.

Definition at line 71 of file AssetProcessor.cpp.

bool AssetProcessor::removeAsset

(

const std::string &

fileName

)

[virtual]

Removes the asset with the given filename.

Parameters:

fileName

Filename of the asset.

Returns:

True on succesful removal, false otherwise.

Reimplemented in EntityProcessor, HeightmapProcessor, MeshProcessor, ScriptProcessor, SoundProcessor, and TextureProcessor.

Definition at line 76 of file AssetProcessor.cpp.

void AssetProcessor::removeAssets

(

)

[virtual]

Removes all assets.

Reimplemented in EntityProcessor, HeightmapProcessor, MeshProcessor, ScriptProcessor, SoundProcessor, and TextureProcessor.

Definition at line 82 of file AssetProcessor.cpp.

---

Friends And Related Function Documentation

friend class AssetGroup [friend]

Definition at line 34 of file AssetProcessor.h.

---

Member Data Documentation

std::string AssetProcessor::mBaseName [protected]

The base name is the name (i.e. meshes) of the directory that this processor will process.

Definition at line 78 of file AssetProcessor.h.

AssetGroup* AssetProcessor::pParent [protected]

Parent of this processor.

Definition at line 76 of file AssetProcessor.h.

---

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

• core/AssetProcessor.h
• core/AssetProcessor.cpp