iLoaderContext Struct Reference
[Loading & Saving support]

This interface gives the context for the loader. More...

#include <imap/ldrctxt.h>

Inheritance diagram for iLoaderContext:

[legend]

List of all members.

Public Member Functions
virtual void	AddToCollection (iObject *obj)=0
	Adds the object to the stored collection.
virtual bool	CheckDupes () const =0
	Return true if we check for dupes (to avoid objects with same name being loaded again.
virtual bool	CurrentCollectionOnly () const =0
	Return true if we only want to look for objects in the region given by GetRegion().
virtual iLight *	FindLight (const char *name)=0
	Find a light.
virtual iLightFactory *	FindLightFactory (const char *name, bool notify=true)=0
	Find a light factory.
virtual iMaterialWrapper *	FindMaterial (const char *filename, bool doLoad=true)=0
	Find a material.
virtual iMeshFactoryWrapper *	FindMeshFactory (const char *name, bool notify=true)=0
	Find a mesh factory.
virtual iMeshWrapper *	FindMeshObject (const char *name)=0
	Find a mesh object.
virtual iMaterialWrapper *	FindNamedMaterial (const char *name, const char *filename)=0
	Same as FindMaterial but there is no assumption that the name and the filename are the same.
virtual iTextureWrapper *	FindNamedTexture (const char *name, const char *filename)=0
	Find a texture with the given name.
virtual iSector *	FindSector (const char *name)=0
	Find a sector.
virtual iShader *	FindShader (const char *name)=0
	Find a shader.
virtual iTextureWrapper *	FindTexture (const char *filename, bool doLoad=true)=0
	Find a texture.
virtual iCollection *	GetCollection () const =0
	Return a collection if we only want to load in that collection.
virtual uint	GetKeepFlags () const =0
	Returns the flags to tell us what we want to keep.
virtual bool	GetVerbose ()=0
	Get the message verbosity.
virtual bool	LoadComment (iObject *obj, iDocumentNode *commentNode, bool replace=false)=0
	Handle a comment node for a given object.

---

Detailed Description

This interface gives the context for the loader.

It basically gives loading plugins a way to find materials, meshes, and sectors. In all these cases region-qualified names can be used (i.e. 'regionname/objectname') or normal object names.

WARNING! When a context is created it should not be modified afterwards. Some loader plugins will keep a reference to the context when they support delayed loading. In that case they still need the original contents in the context. So a loader that creates a context should create a new one every time.

Definition at line 56 of file ldrctxt.h.

---

Member Function Documentation

virtual void iLoaderContext::AddToCollection

(

iObject *

obj

)

[pure virtual]

Adds the object to the stored collection.

virtual bool iLoaderContext::CheckDupes

(

)

const [pure virtual]

Return true if we check for dupes (to avoid objects with same name being loaded again.

virtual bool iLoaderContext::CurrentCollectionOnly

(

)

const [pure virtual]

Return true if we only want to look for objects in the region given by GetRegion().

virtual iLight* iLoaderContext::FindLight

(

const char *

name

)

[pure virtual]

Find a light.

virtual iLightFactory* iLoaderContext::FindLightFactory	(	const char *	name,
		bool	notify = true
	)			[pure virtual]

Find a light factory.

virtual iMaterialWrapper* iLoaderContext::FindMaterial	(	const char *	filename,
		bool	doLoad = true
	)			[pure virtual]

Find a material.

If not found, try to use the filename supplied to find a matching texture. If that isn't found, try to load the texture using the filename. If loaded then it is also Prepared.

virtual iMeshFactoryWrapper* iLoaderContext::FindMeshFactory	(	const char *	name,
		bool	notify = true
	)			[pure virtual]

Find a mesh factory.

virtual iMeshWrapper* iLoaderContext::FindMeshObject

(

const char *

name

)

[pure virtual]

Find a mesh object.

virtual iMaterialWrapper* iLoaderContext::FindNamedMaterial	(	const char *	name,
		const char *	filename
	)			[pure virtual]

Same as FindMaterial but there is no assumption that the name and the filename are the same.

This is useful if the filename has /'s in it (a pathname), since region searching will mean that names with /'s will never be found correctly.

virtual iTextureWrapper* iLoaderContext::FindNamedTexture	(	const char *	name,
		const char *	filename
	)			[pure virtual]

Find a texture with the given name.

If not found, attempt to load the supplied filename and prepare the texture using the supplied name.

virtual iSector* iLoaderContext::FindSector

(

const char *

name

)

[pure virtual]

Find a sector.

virtual iShader* iLoaderContext::FindShader

(

const char *

name

)

[pure virtual]

Find a shader.

Remarks:

Implementations should treat shader names starting with a '*' in a special way: These are "built-in" shaders and should be searched globally even if only the current collection is supposed to be looked up.

virtual iTextureWrapper* iLoaderContext::FindTexture	(	const char *	filename,
		bool	doLoad = true
	)			[pure virtual]

Find a texture.

If not found, attempt to load and prepare the texture using the supplied filename as the name.

virtual iCollection* iLoaderContext::GetCollection

(

)

const [pure virtual]

Return a collection if we only want to load in that collection.

0 otherwise. If not 0 then all objects will be created in the collection.

virtual uint iLoaderContext::GetKeepFlags

(

)

const [pure virtual]

Returns the flags to tell us what we want to keep.

virtual bool iLoaderContext::GetVerbose

(

)

[pure virtual]

Get the message verbosity.

virtual bool iLoaderContext::LoadComment	(	iObject *	obj,
		iDocumentNode *	commentNode,
		bool	replace = false
	)			[pure virtual]

Handle a comment node for a given object.

If the engine saveable flag is on then an iObjectComment is created and add to the object. Otherwise nothing happens. This function returns true if a comment was added. False otherwise. If 'replace' is true then previously existing comments (if any) will be overwritten by the new comment.

---

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

• imap/ldrctxt.h