om::resources::ResourceReference Class Reference

A class that stores a file-local reference to a resource. More...

#include <omResourceReference.h>

Public Member Functions
	ResourceReference ()
	Create a new default resource reference that doesn't refer to any resource. More...
	ResourceReference (ResourceLocalID newLocalTypeID, ResourceLocalID newLocalID, Index newUserType=0, Index newUserID=0, void *newUserData=((void *) 0))
	Create a new resource reference for the specified name, local ID, and user ID. More...

Public Attributes
ResourceLocalID	localTypeID
	The local ID of the resource's corresponding to this reference, e.g. the index of its type within the resource set. More...
ResourceLocalID	localID
	The local ID of the resource corresponding to this reference, e.g. its index within the resource type. More...
Index	userType
	A user-defined type ID that is used by an ResourceTypeTranscoder subclass to recall the type of a reference. More...
Index	userID
	A user-defined ID that is used by an ResourceTypeTranscoder subclass to recall the ID or usage of a reference. More...
void *	userData
	An opaque pointer to user information for this resource reference. More...

Detailed Description

A class that stores a file-local reference to a resource.

An resource reference is used in reference patching after a resource file has been loaded. An resource reference contains a user ID that can be used by an ResourceTypeTranscoder subclass to recall the type or usage of a reference so that it can be patched.

Constructor & Destructor Documentation

om::resources::ResourceReference::ResourceReference ( )

inline

Create a new default resource reference that doesn't refer to any resource.

om::resources::ResourceReference::ResourceReference ( ResourceLocalID  newLocalTypeID, ResourceLocalID  newLocalID, Index  newUserType = 0, Index  newUserID = 0, void *  newUserData = ((void *)0)  )

inline

Create a new resource reference for the specified name, local ID, and user ID.

Member Data Documentation

ResourceLocalID om::resources::ResourceReference::localTypeID

The local ID of the resource's corresponding to this reference, e.g. the index of its type within the resource set.

ResourceLocalID om::resources::ResourceReference::localID

The local ID of the resource corresponding to this reference, e.g. its index within the resource type.

Index om::resources::ResourceReference::userType

A user-defined type ID that is used by an ResourceTypeTranscoder subclass to recall the type of a reference.

This enables the transcoder to know what reference should be patched with the resource corresponding to this ID.

Index om::resources::ResourceReference::userID

A user-defined ID that is used by an ResourceTypeTranscoder subclass to recall the ID or usage of a reference.

This enables the transcoder to know what reference should be patched with the resource corresponding to this ID.

void* om::resources::ResourceReference::userData

An opaque pointer to user information for this resource reference.

This enables the transcoder to know what reference should be patched with the resource corresponding to this ID.

---

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

• omResourceReference.h