The IPackage resource interface. More...

#include "murl_resource_i_package.h"

Inheritance diagram for Murl::Resource::IPackage:

Classes

class  ClassInfo
 The class information object. More...
 
struct  Iff
 IFF file specific structs. More...
 

Public Types

enum  Flags { FLAG_HAS_CHECKSUM }
 Package flags. More...
 
- Public Types inherited from Murl::IFactoryObject< IPackage >
typedef Array< const ClassInfo *> ClassInfoArray
 Definition of an array of ClassInfo objects. More...
 

Public Member Functions

virtual IPackageGetPackageInterface ()=0
 Get the mutable IPackage interface. More...
 
virtual const IPackageGetPackageInterface () const =0
 Get the constant IPackage interface. More...
 
virtual IConditionGetConditionInterface ()=0
 Get the mutable ICondition interface. More...
 
virtual const IConditionGetConditionInterface () const =0
 Get the constant ICondition interface. More...
 
virtual const IPackageFactoryGetCreator () const =0
 Get the factory object used to create this package. More...
 
virtual Bool Init ()=0
 Initialize this package. More...
 
virtual Bool DeInit ()=0
 De-initialize this package. More...
 
virtual Bool CreateBinary (Data &data, Bool checkConfig, Bool makeDefault) const =0
 Create a binary representation from the package. More...
 
virtual const StringGetId () const =0
 Get the package ID. More...
 
virtual UInt32 GetRevision () const =0
 Get the user-defined package revision. More...
 
virtual IEnums::PackageType GetPackageType () const =0
 Get the package's actual type. More...
 
virtual IEnums::FileType GetFileType () const =0
 Get the type of file this resource package was constructed from. More...
 
virtual IEnums::FileCategory GetFileCategory () const =0
 Get the optional file category containing the file this package was constructed from. More...
 
virtual const StringGetFileName () const =0
 Get the optional file name this package was constructed from, relative to the file category returned via GetFileCategory(). More...
 
virtual UInt32 GetNumberOfGraphInstancesToCreate () const =0
 Get the number of graph instances defined to be created upon package loading. More...
 
virtual const IInstanceGetGraphInstanceToCreate (UInt32 index) const =0
 Get a specific graph instance to create upon package loading. More...
 
virtual UInt32 GetNumberOfScriptInstancesToCreate () const =0
 Get the number of script instances defined to be created upon package loading. More...
 
virtual const IInstanceGetScriptInstanceToCreate (UInt32 index) const =0
 Get a specific script instance to create upon package loading. More...
 
virtual UInt32 GetNumberOfObjects () const =0
 Get the total number of generic resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfBinaries () const =0
 Get the number of specialized IBinary resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfGraphs () const =0
 Get the number of specialized IGraph resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfImages () const =0
 Get the number of specialized IImage resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfMeshes () const =0
 Get the number of specialized IMesh resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfFonts () const =0
 Get the number of specialized IFont resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfShaders () const =0
 Get the number of specialized IShader resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfAudios () const =0
 Get the number of specialized IAudio resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfAnimations () const =0
 Get the number of specialized IAnimation resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfAtlases () const =0
 Get the number of specialized IAtlas resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfArchives () const =0
 Get the number of specialized IArchive resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfVideos () const =0
 Get the number of specialized IVideo resource objects contained in the package. More...
 
virtual UInt32 GetNumberOfScripts () const =0
 Get the number of script resources contained in the package. More...
 
virtual UInt32 GetNumberOfDictionaries () const =0
 Get the number of dictionary resources contained in the package. More...
 
virtual UInt32 GetNumberOfGrids () const =0
 Get the number of grid resources contained in the package. More...
 
virtual UInt32 GetNumberOfTexts () const =0
 Get the number of text resources contained in the package. More...
 
virtual UInt32 GetNumberOfSubPackages () const =0
 Get the number of sub-packages contained in the package. More...
 
virtual const IObjectGetObject (UInt32 index) const =0
 Get the generic resource object at a given index. More...
 
virtual const IBinaryGetBinary (UInt32 index) const =0
 Get the specialized IBinary resource object at a given index. More...
 
virtual const IGraphGetGraph (UInt32 index) const =0
 Get the specialized IGraph resource object at a given index. More...
 
virtual const IImageGetImage (UInt32 index) const =0
 Get the specialized IImage resource object at a given index. More...
 
virtual const IMeshGetMesh (UInt32 index) const =0
 Get the specialized IMesh resource object at a given index. More...
 
virtual const IFontGetFont (UInt32 index) const =0
 Get the specialized IFont resource object at a given index. More...
 
virtual const IShaderGetShader (UInt32 index) const =0
 Get the specialized IShader resource object at a given index. More...
 
virtual const IAudioGetAudio (UInt32 index) const =0
 Get the specialized IAudio resource object at a given index. More...
 
virtual const IAnimationGetAnimation (UInt32 index) const =0
 Get the specialized IAnimation resource object at a given index. More...
 
virtual const IAtlasGetAtlas (UInt32 index) const =0
 Get the specialized IAtlas resource object at a given index. More...
 
virtual const IArchiveGetArchive (UInt32 index) const =0
 Get the specialized IArchive resource object at a given index. More...
 
virtual const IVideoGetVideo (UInt32 index) const =0
 Get the specialized IVideo resource object at a given index. More...
 
virtual const IScriptGetScript (UInt32 index) const =0
 Get the script resource at a given index. More...
 
virtual const IDictionaryGetDictionary (UInt32 index) const =0
 Get the dictionary resource at a given index. More...
 
virtual const IGridGetGrid (UInt32 index) const =0
 Get the grid resource at a given index. More...
 
virtual const ITextGetText (UInt32 index) const =0
 Get the text resource at a given index. More...
 
virtual const IPackageGetSubPackage (UInt32 index) const =0
 Get the sub-package at a given index. More...
 
virtual const IObjectGetObject (const String &id) const =0
 Get the first generic resource object matching the current configuration. More...
 
virtual const IBinaryGetBinary (const String &id) const =0
 Get the first specialized IBinary resource object matching the current configuration. More...
 
virtual const IGraphGetGraph (const String &id) const =0
 Get the first specialized IGraph resource object matching the current configuration. More...
 
virtual const IImageGetImage (const String &id) const =0
 Get the first specialized IImage resource object matching the current configuration. More...
 
virtual const IMeshGetMesh (const String &id) const =0
 Get the first specialized IMesh resource object matching the current configuration. More...
 
virtual const IFontGetFont (const String &id) const =0
 Get the first specialized IFont resource object matching the current configuration. More...
 
virtual const IShaderGetShader (const String &id) const =0
 Get the first specialized IShader resource object matching the current configuration. More...
 
virtual const IAudioGetAudio (const String &id) const =0
 Get the first specialized IAudio resource object matching the current configuration. More...
 
virtual const IAnimationGetAnimation (const String &id) const =0
 Get the first specialized IAnimation resource object matching the current configuration. More...
 
virtual const IAtlasGetAtlas (const String &id) const =0
 Get the first specialized IAtlas resource object matching the current configuration. More...
 
virtual const IArchiveGetArchive (const String &id) const =0
 Get the first specialized IArchive resource object matching the current configuration. More...
 
virtual const IVideoGetVideo (const String &id) const =0
 Get the first specialized IVideo resource object matching the current configuration. More...
 
virtual const IScriptGetScript (const String &id) const =0
 Get the first script resource matching the current configuration. More...
 
virtual const IDictionaryGetDictionary (const String &id) const =0
 Get the first dictionary resource matching the current configuration. More...
 
virtual const IGridGetGrid (const String &id) const =0
 Get the first grid resource matching the current configuration. More...
 
virtual const ITextGetText (const String &id) const =0
 Get the first text resource matching the current configuration. More...
 
virtual const IPackageGetSubPackage (const String &id) const =0
 Get the first sub-package matching the current configuration. More...
 
virtual Bool SetParentPackage (const IPackage *parentPackage)=0
 Set the optional parent package this package belongs to. More...
 
virtual const IPackageGetParentPackage () const =0
 Get the optional parent package this package belongs to. More...
 
virtual UInt32 GetNumberOfAllocatedResourceBytes () const =0
 Query the total number of allocated resource bytes in this package. More...
 
- Public Member Functions inherited from Murl::IFactoryObject< IPackage >
virtual ~IFactoryObject ()
 The destructor. More...
 
virtual const ClassInfo * GetObjectClassInfo () const=0
 Get the object instance's class info, if present. More...
 
virtual void ResetObjectProperties ()=0
 Reset the object instance's properties to their default values.
 

Additional Inherited Members

- Static Public Member Functions inherited from Murl::IFactoryObject< IPackage >
static const PropertyInfoGetPropertyInfo ()
 Get the class' property info struct. More...
 
static const AttributeInfoGetAttributeInfo ()
 Get the class' attribute info struct. More...
 
static void ResetProperties (IFactoryObject< IPackage > *object)
 Reset an object instance's properties to their default values. More...
 

Detailed Description

The IPackage resource interface.

Member Enumeration Documentation

◆ Flags

Package flags.

Enumerator
FLAG_HAS_CHECKSUM 

If set, the mChecksum value in the header chunk holds the package checksum.

Member Function Documentation

◆ GetPackageInterface() [1/2]

virtual IPackage* Murl::Resource::IPackage::GetPackageInterface ( )
pure virtual

Get the mutable IPackage interface.

Returns
The IPackage interface.

◆ GetPackageInterface() [2/2]

virtual const IPackage* Murl::Resource::IPackage::GetPackageInterface ( ) const
pure virtual

Get the constant IPackage interface.

Returns
The IPackage interface.

◆ GetConditionInterface() [1/2]

virtual ICondition* Murl::Resource::IPackage::GetConditionInterface ( )
pure virtual

Get the mutable ICondition interface.

Returns
The ICondition interface.

◆ GetConditionInterface() [2/2]

virtual const ICondition* Murl::Resource::IPackage::GetConditionInterface ( ) const
pure virtual

Get the constant ICondition interface.

Returns
The ICondition interface.

◆ GetCreator()

virtual const IPackageFactory* Murl::Resource::IPackage::GetCreator ( ) const
pure virtual

Get the factory object used to create this package.

Returns
The creator factory.

◆ Init()

virtual Bool Murl::Resource::IPackage::Init ( )
pure virtual

Initialize this package.

Returns
true if successful.

◆ DeInit()

virtual Bool Murl::Resource::IPackage::DeInit ( )
pure virtual

De-initialize this package.

Returns
true if successful.

◆ CreateBinary()

virtual Bool Murl::Resource::IPackage::CreateBinary ( Data data,
Bool  checkConfig,
Bool  makeDefault 
) const
pure virtual

Create a binary representation from the package.

Parameters
dataA reference to a Data object receiving the binary.
checkConfigIf true, the current IAppConfiguration object (and its contained IEngineConfiguration and IPlatformConfiguration objects) are checked for valid configuration options to include in the actual binary. If false, all present objects are included, for all configuration specified in the package.
makeDefaultOnly considered if checkConfig is true. If makeDefault is also true, only the first object of a set of conditional resources (i.e. resource objects with the same ID) matching a valid configuration is packed into the output binary, and all other ones in this set are left out. If false, all objects with matching configuration tags are included.
Returns
true if successful.

◆ GetId()

virtual const String& Murl::Resource::IPackage::GetId ( ) const
pure virtual

Get the package ID.

Returns
The package ID.

◆ GetRevision()

virtual UInt32 Murl::Resource::IPackage::GetRevision ( ) const
pure virtual

Get the user-defined package revision.

Returns
The package revision.

◆ GetPackageType()

virtual IEnums::PackageType Murl::Resource::IPackage::GetPackageType ( ) const
pure virtual

Get the package's actual type.

Returns
The package type.

◆ GetFileType()

virtual IEnums::FileType Murl::Resource::IPackage::GetFileType ( ) const
pure virtual

Get the type of file this resource package was constructed from.

Returns
The file type.

◆ GetFileCategory()

virtual IEnums::FileCategory Murl::Resource::IPackage::GetFileCategory ( ) const
pure virtual

Get the optional file category containing the file this package was constructed from.

Returns
The file category, or IEnums::FILE_CATEGORY_DEFAULT if the package was constructed directly from memory.

◆ GetFileName()

virtual const String& Murl::Resource::IPackage::GetFileName ( ) const
pure virtual

Get the optional file name this package was constructed from, relative to the file category returned via GetFileCategory().

Returns
The file name, or an empty string if the package was constructed directly from memory.

◆ GetNumberOfGraphInstancesToCreate()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfGraphInstancesToCreate ( ) const
pure virtual

Get the number of graph instances defined to be created upon package loading.

Returns
The number of instances to create.

◆ GetGraphInstanceToCreate()

virtual const IInstance* Murl::Resource::IPackage::GetGraphInstanceToCreate ( UInt32  index) const
pure virtual

Get a specific graph instance to create upon package loading.

Parameters
indexThe instance index, from 0 to GetNumberOfGraphInstancesToCreate()-1.
Returns
The instance object, or null if the index is out of range.

◆ GetNumberOfScriptInstancesToCreate()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfScriptInstancesToCreate ( ) const
pure virtual

Get the number of script instances defined to be created upon package loading.

Returns
The number of instances to create.

◆ GetScriptInstanceToCreate()

virtual const IInstance* Murl::Resource::IPackage::GetScriptInstanceToCreate ( UInt32  index) const
pure virtual

Get a specific script instance to create upon package loading.

Parameters
indexThe instance index, from 0 to GetNumberOfScriptInstancesToCreate()-1.
Returns
The instance object, or null if the index is out of range.

◆ GetNumberOfObjects()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfObjects ( ) const
pure virtual

Get the total number of generic resource objects contained in the package.

Returns
The total number of generic objects.

◆ GetNumberOfBinaries()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfBinaries ( ) const
pure virtual

Get the number of specialized IBinary resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfGraphs()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfGraphs ( ) const
pure virtual

Get the number of specialized IGraph resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfImages()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfImages ( ) const
pure virtual

Get the number of specialized IImage resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfMeshes()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfMeshes ( ) const
pure virtual

Get the number of specialized IMesh resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfFonts()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfFonts ( ) const
pure virtual

Get the number of specialized IFont resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfShaders()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfShaders ( ) const
pure virtual

Get the number of specialized IShader resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfAudios()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfAudios ( ) const
pure virtual

Get the number of specialized IAudio resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfAnimations()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfAnimations ( ) const
pure virtual

Get the number of specialized IAnimation resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfAtlases()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfAtlases ( ) const
pure virtual

Get the number of specialized IAtlas resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfArchives()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfArchives ( ) const
pure virtual

Get the number of specialized IArchive resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfVideos()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfVideos ( ) const
pure virtual

Get the number of specialized IVideo resource objects contained in the package.

Returns
The number of objects.

◆ GetNumberOfScripts()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfScripts ( ) const
pure virtual

Get the number of script resources contained in the package.

Returns
The number of script resources.

◆ GetNumberOfDictionaries()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfDictionaries ( ) const
pure virtual

Get the number of dictionary resources contained in the package.

Returns
The number of dictionary resources.

◆ GetNumberOfGrids()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfGrids ( ) const
pure virtual

Get the number of grid resources contained in the package.

Returns
The number of grid resources.

◆ GetNumberOfTexts()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfTexts ( ) const
pure virtual

Get the number of text resources contained in the package.

Returns
The number of text resources.

◆ GetNumberOfSubPackages()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfSubPackages ( ) const
pure virtual

Get the number of sub-packages contained in the package.

Returns
The number of sub-packages.

◆ GetObject() [1/2]

virtual const IObject* Murl::Resource::IPackage::GetObject ( UInt32  index) const
pure virtual

Get the generic resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfObjects()-1.
Returns
The object, or null if the index is out of range.

◆ GetBinary() [1/2]

virtual const IBinary* Murl::Resource::IPackage::GetBinary ( UInt32  index) const
pure virtual

Get the specialized IBinary resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfBinaries()-1.
Returns
The object, or null if the index is out of range.

◆ GetGraph() [1/2]

virtual const IGraph* Murl::Resource::IPackage::GetGraph ( UInt32  index) const
pure virtual

Get the specialized IGraph resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfGraphs()-1.
Returns
The object, or null if the index is out of range.

◆ GetImage() [1/2]

virtual const IImage* Murl::Resource::IPackage::GetImage ( UInt32  index) const
pure virtual

Get the specialized IImage resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfImages()-1.
Returns
The object, or null if the index is out of range.

◆ GetMesh() [1/2]

virtual const IMesh* Murl::Resource::IPackage::GetMesh ( UInt32  index) const
pure virtual

Get the specialized IMesh resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfMeshes()-1.
Returns
The object, or null if the index is out of range.

◆ GetFont() [1/2]

virtual const IFont* Murl::Resource::IPackage::GetFont ( UInt32  index) const
pure virtual

Get the specialized IFont resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfFonts()-1.
Returns
The object, or null if the index is out of range.

◆ GetShader() [1/2]

virtual const IShader* Murl::Resource::IPackage::GetShader ( UInt32  index) const
pure virtual

Get the specialized IShader resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfShaders()-1.
Returns
The object, or null if the index is out of range.

◆ GetAudio() [1/2]

virtual const IAudio* Murl::Resource::IPackage::GetAudio ( UInt32  index) const
pure virtual

Get the specialized IAudio resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfAudios()-1.
Returns
The object, or null if the index is out of range.

◆ GetAnimation() [1/2]

virtual const IAnimation* Murl::Resource::IPackage::GetAnimation ( UInt32  index) const
pure virtual

Get the specialized IAnimation resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfAnimations()-1.
Returns
The object, or null if the index is out of range.

◆ GetAtlas() [1/2]

virtual const IAtlas* Murl::Resource::IPackage::GetAtlas ( UInt32  index) const
pure virtual

Get the specialized IAtlas resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfAtlases()-1.
Returns
The object, or null if the index is out of range.

◆ GetArchive() [1/2]

virtual const IArchive* Murl::Resource::IPackage::GetArchive ( UInt32  index) const
pure virtual

Get the specialized IArchive resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfArchives()-1.
Returns
The object, or null if the index is out of range.

◆ GetVideo() [1/2]

virtual const IVideo* Murl::Resource::IPackage::GetVideo ( UInt32  index) const
pure virtual

Get the specialized IVideo resource object at a given index.

Parameters
indexThe object index, from 0 to GetNumberOfVideos()-1.
Returns
The object, or null if the index is out of range.

◆ GetScript() [1/2]

virtual const IScript* Murl::Resource::IPackage::GetScript ( UInt32  index) const
pure virtual

Get the script resource at a given index.

Parameters
indexThe script index, from 0 to GetNumberOfScripts()-1.
Returns
The object, or null if the index is out of range.

◆ GetDictionary() [1/2]

virtual const IDictionary* Murl::Resource::IPackage::GetDictionary ( UInt32  index) const
pure virtual

Get the dictionary resource at a given index.

Parameters
indexThe dictionary index, from 0 to GetNumberOfDictionaries()-1.
Returns
The object, or null if the index is out of range.

◆ GetGrid() [1/2]

virtual const IGrid* Murl::Resource::IPackage::GetGrid ( UInt32  index) const
pure virtual

Get the grid resource at a given index.

Parameters
indexThe grid index, from 0 to GetNumberOfGrids()-1.
Returns
The object, or null if the index is out of range.

◆ GetText() [1/2]

virtual const IText* Murl::Resource::IPackage::GetText ( UInt32  index) const
pure virtual

Get the text resource at a given index.

Parameters
indexThe text index, from 0 to GetNumberOfTexts()-1.
Returns
The text object, or null if the index is out of range.

◆ GetSubPackage() [1/2]

virtual const IPackage* Murl::Resource::IPackage::GetSubPackage ( UInt32  index) const
pure virtual

Get the sub-package at a given index.

Parameters
indexThe sub-package index, from 0 to GetNumberOfSubPackages()-1.
Returns
The sub-package, or null if the index is out of range.

◆ GetObject() [2/2]

virtual const IObject* Murl::Resource::IPackage::GetObject ( const String id) const
pure virtual

Get the first generic resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetBinary() [2/2]

virtual const IBinary* Murl::Resource::IPackage::GetBinary ( const String id) const
pure virtual

Get the first specialized IBinary resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetGraph() [2/2]

virtual const IGraph* Murl::Resource::IPackage::GetGraph ( const String id) const
pure virtual

Get the first specialized IGraph resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetImage() [2/2]

virtual const IImage* Murl::Resource::IPackage::GetImage ( const String id) const
pure virtual

Get the first specialized IImage resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetMesh() [2/2]

virtual const IMesh* Murl::Resource::IPackage::GetMesh ( const String id) const
pure virtual

Get the first specialized IMesh resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetFont() [2/2]

virtual const IFont* Murl::Resource::IPackage::GetFont ( const String id) const
pure virtual

Get the first specialized IFont resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetShader() [2/2]

virtual const IShader* Murl::Resource::IPackage::GetShader ( const String id) const
pure virtual

Get the first specialized IShader resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetAudio() [2/2]

virtual const IAudio* Murl::Resource::IPackage::GetAudio ( const String id) const
pure virtual

Get the first specialized IAudio resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetAnimation() [2/2]

virtual const IAnimation* Murl::Resource::IPackage::GetAnimation ( const String id) const
pure virtual

Get the first specialized IAnimation resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetAtlas() [2/2]

virtual const IAtlas* Murl::Resource::IPackage::GetAtlas ( const String id) const
pure virtual

Get the first specialized IAtlas resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetArchive() [2/2]

virtual const IArchive* Murl::Resource::IPackage::GetArchive ( const String id) const
pure virtual

Get the first specialized IArchive resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetVideo() [2/2]

virtual const IVideo* Murl::Resource::IPackage::GetVideo ( const String id) const
pure virtual

Get the first specialized IVideo resource object matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetScript() [2/2]

virtual const IScript* Murl::Resource::IPackage::GetScript ( const String id) const
pure virtual

Get the first script resource matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetDictionary() [2/2]

virtual const IDictionary* Murl::Resource::IPackage::GetDictionary ( const String id) const
pure virtual

Get the first dictionary resource matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetGrid() [2/2]

virtual const IGrid* Murl::Resource::IPackage::GetGrid ( const String id) const
pure virtual

Get the first grid resource matching the current configuration.

Parameters
idThe resource object ID.
Returns
The object, or null if not found.

◆ GetText() [2/2]

virtual const IText* Murl::Resource::IPackage::GetText ( const String id) const
pure virtual

Get the first text resource matching the current configuration.

Parameters
idThe text ID.
Returns
The text object, or null if not found.

◆ GetSubPackage() [2/2]

virtual const IPackage* Murl::Resource::IPackage::GetSubPackage ( const String id) const
pure virtual

Get the first sub-package matching the current configuration.

Parameters
idThe sub-package ID.
Returns
The sub-package, or null if not found.

◆ SetParentPackage()

virtual Bool Murl::Resource::IPackage::SetParentPackage ( const IPackage parentPackage)
pure virtual

Set the optional parent package this package belongs to.

Parameters
parentPackageThe containing package, or null for removing.
Returns
true if successful.

◆ GetParentPackage()

virtual const IPackage* Murl::Resource::IPackage::GetParentPackage ( ) const
pure virtual

Get the optional parent package this package belongs to.

Returns
The containing package, or null if the package is not contained in another package.

◆ GetNumberOfAllocatedResourceBytes()

virtual UInt32 Murl::Resource::IPackage::GetNumberOfAllocatedResourceBytes ( ) const
pure virtual

Query the total number of allocated resource bytes in this package.

Returns
The number of allocated bytes.

The documentation for this interface was generated from the following file:
  • murl_resource_i_package.h


Copyright © 2011-2018 Spraylight GmbH.