DigitalSpaces::DIOGREResource Struct Reference
[Ogre]

#include <OGREInterfaces.h>


Public Member Functions
void	load ()
	Loads the resource, if it is not already.
void	reload ()
	Reloads the resource, if it is already loaded.
bool	isReloadable ()
	Returns true if the Resource is reloadable, false otherwise.
bool	isManuallyLoaded ()
	Is this resource manually loaded?
void	unload ()
	Unloads the resource; this is not permanent, the resource can be reloaded later if required.
unsigned int	getSize ()
	Retrieves info about the size of the resource.
void	touch ()
	'Touches' the resource to indicate it has been used.
const char *	getName ()
	Gets resource name.
unsigned long	getHandle ()
bool	isLoaded ()
	Returns true if the Resource has been loaded, false otherwise.
const char *	getGroup ()
	Gets the group which this resource is a member of.
DIOGREResourceManager *	getCreator ()
	Gets the manager which created this resource.
const char *	getOrigin ()
	Get the origin of this resource, e.g.
void	Release ()
	Invalidates the wrapping object.

Member Function Documentation

void DigitalSpaces::DIOGREResource::load ( )

Loads the resource, if it is not already.

Remarks:: If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own

void DigitalSpaces::DIOGREResource::reload ( )

Reloads the resource, if it is already loaded.

Remarks:: Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

bool DigitalSpaces::DIOGREResource::isReloadable ( )

Returns true if the Resource is reloadable, false otherwise.

bool DigitalSpaces::DIOGREResource::isManuallyLoaded ( )

Is this resource manually loaded?

void DigitalSpaces::DIOGREResource::unload ( )

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

unsigned int DigitalSpaces::DIOGREResource::getSize ( )

Retrieves info about the size of the resource.

void DigitalSpaces::DIOGREResource::touch ( )

'Touches' the resource to indicate it has been used.

const char* DigitalSpaces::DIOGREResource::getName ( )

Gets resource name.

unsigned long DigitalSpaces::DIOGREResource::getHandle ( )

bool DigitalSpaces::DIOGREResource::isLoaded ( )

Returns true if the Resource has been loaded, false otherwise.

const char* DigitalSpaces::DIOGREResource::getGroup ( )

Gets the group which this resource is a member of.

DIOGREResourceManager* DigitalSpaces::DIOGREResource::getCreator ( )

Gets the manager which created this resource.

const char* DigitalSpaces::DIOGREResource::getOrigin ( )

Get the origin of this resource, e.g.

a script file name.

Remarks:: This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

void DigitalSpaces::DIOGREResource::Release ( )

Invalidates the wrapping object.

Remarks:: This releases the internal reference to the resource, deletes the wrapping object and frees its memory. Using this pointer after calling this function will cause a crash. You do not need to call this function, but it helps clean up memory

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