![]() |
Murl Engine API
Version 2018.3
|
The IPackage resource interface. More...
#include <murl_resource_i_package.h>
The IPackage resource interface.
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... | |
![]() | |
typedef Array< const ClassInfo *> | ClassInfoArray |
Definition of an array of ClassInfo objects. More... | |
Public Member Functions | |
virtual IPackage * | GetPackageInterface ()=0 |
Get the mutable IPackage interface. More... | |
virtual const IPackage * | GetPackageInterface () const =0 |
Get the constant IPackage interface. More... | |
virtual const IPackageFactory * | GetCreator () 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, Bool allowReferences) const =0 |
Create a binary representation from the package. More... | |
virtual const String & | GetId () 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 String & | GetFileName () 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 IInstance * | GetGraphInstanceToCreate (UInt32 index) const =0 |
Get a specific graph instance to create upon package loading. More... | |
virtual const ICondition * | GetGraphInstanceConditionToCreate (UInt32 index) const =0 |
Get the condition of 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 IInstance * | GetScriptInstanceToCreate (UInt32 index) const =0 |
Get a specific script instance to create upon package loading. More... | |
virtual const ICondition * | GetScriptInstanceConditionToCreate (UInt32 index) const =0 |
Get the condition of 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 IObject * | GetObject (UInt32 index) const =0 |
Get the generic resource object at a given index. More... | |
virtual const IBinary * | GetBinary (UInt32 index) const =0 |
Get the specialized IBinary resource object at a given index. More... | |
virtual const IGraph * | GetGraph (UInt32 index) const =0 |
Get the specialized IGraph resource object at a given index. More... | |
virtual const IImage * | GetImage (UInt32 index) const =0 |
Get the specialized IImage resource object at a given index. More... | |
virtual const IMesh * | GetMesh (UInt32 index) const =0 |
Get the specialized IMesh resource object at a given index. More... | |
virtual const IFont * | GetFont (UInt32 index) const =0 |
Get the specialized IFont resource object at a given index. More... | |
virtual const IShader * | GetShader (UInt32 index) const =0 |
Get the specialized IShader resource object at a given index. More... | |
virtual const IAudio * | GetAudio (UInt32 index) const =0 |
Get the specialized IAudio resource object at a given index. More... | |
virtual const IAnimation * | GetAnimation (UInt32 index) const =0 |
Get the specialized IAnimation resource object at a given index. More... | |
virtual const IAtlas * | GetAtlas (UInt32 index) const =0 |
Get the specialized IAtlas resource object at a given index. More... | |
virtual const IArchive * | GetArchive (UInt32 index) const =0 |
Get the specialized IArchive resource object at a given index. More... | |
virtual const IVideo * | GetVideo (UInt32 index) const =0 |
Get the specialized IVideo resource object at a given index. More... | |
virtual const IScript * | GetScript (UInt32 index) const =0 |
Get the script resource at a given index. More... | |
virtual const IDictionary * | GetDictionary (UInt32 index) const =0 |
Get the dictionary resource at a given index. More... | |
virtual const IGrid * | GetGrid (UInt32 index) const =0 |
Get the grid resource at a given index. More... | |
virtual const IText * | GetText (UInt32 index) const =0 |
Get the text resource at a given index. More... | |
virtual const IPackage * | GetSubPackage (UInt32 index) const =0 |
Get the sub-package at a given index. More... | |
virtual const ICondition * | GetObjectCondition (UInt32 index) const =0 |
Get the condition of a generic resource object at a given index. More... | |
virtual const ICondition * | GetBinaryCondition (UInt32 index) const =0 |
Get the condition of a specialized IBinary resource object at a given index. More... | |
virtual const ICondition * | GetGraphCondition (UInt32 index) const =0 |
Get the condition of a specialized IGraph resource object at a given index. More... | |
virtual const ICondition * | GetImageCondition (UInt32 index) const =0 |
Get the condition of a specialized IImage resource object at a given index. More... | |
virtual const ICondition * | GetMeshCondition (UInt32 index) const =0 |
Get the condition of a specialized IMesh resource object at a given index. More... | |
virtual const ICondition * | GetFontCondition (UInt32 index) const =0 |
Get the condition of a specialized IFont resource object at a given index. More... | |
virtual const ICondition * | GetShaderCondition (UInt32 index) const =0 |
Get the condition of a specialized IShader resource object at a given index. More... | |
virtual const ICondition * | GetAudioCondition (UInt32 index) const =0 |
Get the condition of a specialized IAudio resource object at a given index. More... | |
virtual const ICondition * | GetAnimationCondition (UInt32 index) const =0 |
Get the condition of a specialized IAnimation resource object at a given index. More... | |
virtual const ICondition * | GetAtlasCondition (UInt32 index) const =0 |
Get the condition of a specialized IAtlas resource object at a given index. More... | |
virtual const ICondition * | GetArchiveCondition (UInt32 index) const =0 |
Get the condition of a specialized IArchive resource object at a given index. More... | |
virtual const ICondition * | GetVideoCondition (UInt32 index) const =0 |
Get the condition of a specialized IVideo resource object at a given index. More... | |
virtual const ICondition * | GetScriptCondition (UInt32 index) const =0 |
Get the condition of a script resource at a given index. More... | |
virtual const ICondition * | GetDictionaryCondition (UInt32 index) const =0 |
Get the condition of a dictionary resource at a given index. More... | |
virtual const ICondition * | GetGridCondition (UInt32 index) const =0 |
Get the condition of a grid resource at a given index. More... | |
virtual const ICondition * | GetTextCondition (UInt32 index) const =0 |
Get the condition of a text resource at a given index. More... | |
virtual const ICondition * | GetSubPackageCondition (UInt32 index) const =0 |
Get the condition of a sub-package at a given index. More... | |
virtual const IObject * | GetObject (const String &id) const =0 |
Get the first generic resource object matching the current configuration. More... | |
virtual const IBinary * | GetBinary (const String &id) const =0 |
Get the first specialized IBinary resource object matching the current configuration. More... | |
virtual const IGraph * | GetGraph (const String &id) const =0 |
Get the first specialized IGraph resource object matching the current configuration. More... | |
virtual const IImage * | GetImage (const String &id) const =0 |
Get the first specialized IImage resource object matching the current configuration. More... | |
virtual const IMesh * | GetMesh (const String &id) const =0 |
Get the first specialized IMesh resource object matching the current configuration. More... | |
virtual const IFont * | GetFont (const String &id) const =0 |
Get the first specialized IFont resource object matching the current configuration. More... | |
virtual const IShader * | GetShader (const String &id) const =0 |
Get the first specialized IShader resource object matching the current configuration. More... | |
virtual const IAudio * | GetAudio (const String &id) const =0 |
Get the first specialized IAudio resource object matching the current configuration. More... | |
virtual const IAnimation * | GetAnimation (const String &id) const =0 |
Get the first specialized IAnimation resource object matching the current configuration. More... | |
virtual const IAtlas * | GetAtlas (const String &id) const =0 |
Get the first specialized IAtlas resource object matching the current configuration. More... | |
virtual const IArchive * | GetArchive (const String &id) const =0 |
Get the first specialized IArchive resource object matching the current configuration. More... | |
virtual const IVideo * | GetVideo (const String &id) const =0 |
Get the first specialized IVideo resource object matching the current configuration. More... | |
virtual const IScript * | GetScript (const String &id) const =0 |
Get the first script resource matching the current configuration. More... | |
virtual const IDictionary * | GetDictionary (const String &id) const =0 |
Get the first dictionary resource matching the current configuration. More... | |
virtual const IGrid * | GetGrid (const String &id) const =0 |
Get the first grid resource matching the current configuration. More... | |
virtual const IText * | GetText (const String &id) const =0 |
Get the first text resource matching the current configuration. More... | |
virtual const IPackage * | GetSubPackage (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 IPackage * | GetParentPackage () 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... | |
![]() | |
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 const PropertyInfo * | GetPropertyInfo () |
Get the class' property info struct. More... | |
static const AttributeInfo * | GetAttributeInfo () |
Get the class' attribute info struct. More... | |
static void | ResetProperties (IFactoryObject< IPackage > *object) |
Reset an object instance's properties to their default values. More... | |
Package flags.
Enumerator | |
---|---|
FLAG_HAS_CHECKSUM | If set, the mChecksum value in the header chunk holds the package checksum. |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Get the factory object used to create this package.
|
pure virtual |
Initialize this package.
|
pure virtual |
De-initialize this package.
|
pure virtual |
Create a binary representation from the package.
data | A reference to a Data object receiving the binary. |
checkConfig | If 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. |
makeDefault | Only 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. |
allowReferences | If true, resource objects with identical binary representations are included only once in the package and referenced multiple times. If false, all objects are packaged regardless of duplication. |
|
pure virtual |
Get the package ID.
|
pure virtual |
Get the user-defined package revision.
|
pure virtual |
Get the package's actual type.
|
pure virtual |
Get the type of file this resource package was constructed from.
|
pure virtual |
Get the optional file category containing the file this package was constructed from.
|
pure virtual |
Get the optional file name this package was constructed from, relative to the file category returned via GetFileCategory().
|
pure virtual |
Get the number of graph instances defined to be created upon package loading.
|
pure virtual |
Get a specific graph instance to create upon package loading.
index | The instance index, from 0 to GetNumberOfGraphInstancesToCreate()-1. |
|
pure virtual |
Get the condition of a specific graph instance to create upon package loading.
index | The instance index, from 0 to GetNumberOfGraphInstancesToCreate()-1. |
|
pure virtual |
Get the number of script instances defined to be created upon package loading.
|
pure virtual |
Get a specific script instance to create upon package loading.
index | The instance index, from 0 to GetNumberOfScriptInstancesToCreate()-1. |
|
pure virtual |
Get the condition of a specific script instance to create upon package loading.
index | The instance index, from 0 to GetNumberOfScriptInstancesToCreate()-1. |
|
pure virtual |
Get the total number of generic resource objects contained in the package.
|
pure virtual |
Get the number of specialized IBinary resource objects contained in the package.
|
pure virtual |
Get the number of specialized IGraph resource objects contained in the package.
|
pure virtual |
Get the number of specialized IImage resource objects contained in the package.
|
pure virtual |
Get the number of specialized IMesh resource objects contained in the package.
|
pure virtual |
Get the number of specialized IFont resource objects contained in the package.
|
pure virtual |
Get the number of specialized IShader resource objects contained in the package.
|
pure virtual |
Get the number of specialized IAudio resource objects contained in the package.
|
pure virtual |
Get the number of specialized IAnimation resource objects contained in the package.
|
pure virtual |
Get the number of specialized IAtlas resource objects contained in the package.
|
pure virtual |
Get the number of specialized IArchive resource objects contained in the package.
|
pure virtual |
Get the number of specialized IVideo resource objects contained in the package.
|
pure virtual |
Get the number of script resources contained in the package.
|
pure virtual |
Get the number of dictionary resources contained in the package.
|
pure virtual |
Get the number of grid resources contained in the package.
|
pure virtual |
Get the number of text resources contained in the package.
|
pure virtual |
Get the number of sub-packages contained in the package.
Get the generic resource object at a given index.
index | The object index, from 0 to GetNumberOfObjects()-1. |
Get the specialized IBinary resource object at a given index.
index | The object index, from 0 to GetNumberOfBinaries()-1. |
Get the specialized IGraph resource object at a given index.
index | The object index, from 0 to GetNumberOfGraphs()-1. |
Get the specialized IImage resource object at a given index.
index | The object index, from 0 to GetNumberOfImages()-1. |
Get the specialized IMesh resource object at a given index.
index | The object index, from 0 to GetNumberOfMeshes()-1. |
Get the specialized IFont resource object at a given index.
index | The object index, from 0 to GetNumberOfFonts()-1. |
Get the specialized IShader resource object at a given index.
index | The object index, from 0 to GetNumberOfShaders()-1. |
Get the specialized IAudio resource object at a given index.
index | The object index, from 0 to GetNumberOfAudios()-1. |
|
pure virtual |
Get the specialized IAnimation resource object at a given index.
index | The object index, from 0 to GetNumberOfAnimations()-1. |
Get the specialized IAtlas resource object at a given index.
index | The object index, from 0 to GetNumberOfAtlases()-1. |
Get the specialized IArchive resource object at a given index.
index | The object index, from 0 to GetNumberOfArchives()-1. |
Get the specialized IVideo resource object at a given index.
index | The object index, from 0 to GetNumberOfVideos()-1. |
Get the script resource at a given index.
index | The script index, from 0 to GetNumberOfScripts()-1. |
|
pure virtual |
Get the dictionary resource at a given index.
index | The dictionary index, from 0 to GetNumberOfDictionaries()-1. |
Get the grid resource at a given index.
index | The grid index, from 0 to GetNumberOfGrids()-1. |
Get the text resource at a given index.
index | The text index, from 0 to GetNumberOfTexts()-1. |
Get the sub-package at a given index.
index | The sub-package index, from 0 to GetNumberOfSubPackages()-1. |
|
pure virtual |
Get the condition of a generic resource object at a given index.
index | The object index, from 0 to GetNumberOfObjects()-1. |
|
pure virtual |
Get the condition of a specialized IBinary resource object at a given index.
index | The object index, from 0 to GetNumberOfBinaries()-1. |
|
pure virtual |
Get the condition of a specialized IGraph resource object at a given index.
index | The object index, from 0 to GetNumberOfGraphs()-1. |
|
pure virtual |
Get the condition of a specialized IImage resource object at a given index.
index | The object index, from 0 to GetNumberOfImages()-1. |
|
pure virtual |
Get the condition of a specialized IMesh resource object at a given index.
index | The object index, from 0 to GetNumberOfMeshes()-1. |
|
pure virtual |
Get the condition of a specialized IFont resource object at a given index.
index | The object index, from 0 to GetNumberOfFonts()-1. |
|
pure virtual |
Get the condition of a specialized IShader resource object at a given index.
index | The object index, from 0 to GetNumberOfShaders()-1. |
|
pure virtual |
Get the condition of a specialized IAudio resource object at a given index.
index | The object index, from 0 to GetNumberOfAudios()-1. |
|
pure virtual |
Get the condition of a specialized IAnimation resource object at a given index.
index | The object index, from 0 to GetNumberOfAnimations()-1. |
|
pure virtual |
Get the condition of a specialized IAtlas resource object at a given index.
index | The object index, from 0 to GetNumberOfAtlases()-1. |
|
pure virtual |
Get the condition of a specialized IArchive resource object at a given index.
index | The object index, from 0 to GetNumberOfArchives()-1. |
|
pure virtual |
Get the condition of a specialized IVideo resource object at a given index.
index | The object index, from 0 to GetNumberOfVideos()-1. |
|
pure virtual |
Get the condition of a script resource at a given index.
index | The script index, from 0 to GetNumberOfScripts()-1. |
|
pure virtual |
Get the condition of a dictionary resource at a given index.
index | The dictionary index, from 0 to GetNumberOfDictionaries()-1. |
|
pure virtual |
Get the condition of a grid resource at a given index.
index | The grid index, from 0 to GetNumberOfGrids()-1. |
|
pure virtual |
Get the condition of a text resource at a given index.
index | The text index, from 0 to GetNumberOfTexts()-1. |
|
pure virtual |
Get the condition of a sub-package at a given index.
index | The sub-package index, from 0 to GetNumberOfSubPackages()-1. |
Get the first generic resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IBinary resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IGraph resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IImage resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IMesh resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IFont resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IShader resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IAudio resource object matching the current configuration.
id | The resource object ID. |
|
pure virtual |
Get the first specialized IAnimation resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IAtlas resource object matching the current configuration.
id | The resource object ID. |
|
pure virtual |
Get the first specialized IArchive resource object matching the current configuration.
id | The resource object ID. |
Get the first specialized IVideo resource object matching the current configuration.
id | The resource object ID. |
Get the first script resource matching the current configuration.
id | The resource object ID. |
|
pure virtual |
Get the first dictionary resource matching the current configuration.
id | The resource object ID. |
Get the first grid resource matching the current configuration.
id | The resource object ID. |
Get the first text resource matching the current configuration.
id | The text ID. |
|
pure virtual |
Get the first sub-package matching the current configuration.
id | The sub-package ID. |
|
pure virtual |
Set the optional parent package this package belongs to.
parentPackage | The containing package, or null for removing. |
|
pure virtual |
Get the optional parent package this package belongs to.
|
pure virtual |
Query the total number of allocated resource bytes in this package.