Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::sound::resources::SoundPluginResourceTranscoder Class Reference

A class that encodes and decodes sound plugins to/from the resource set format. More...

#include <omSoundPluginResourceTranscoder.h>

Inheritance diagram for om::sound::resources::SoundPluginResourceTranscoder:
om::resources::ResourceSetTypeTranscoder< SoundPlugin >

Public Member Functions

 SoundPluginResourceTranscoder ()
 Create a new default sound plugin transcoder with no plugin manager. More...
 
virtual Bool encode (const ResourceID &resourceID, const SoundPlugin &plugin, const ResourceSet &resources, ResourceEncoder &encoder, ResourceManager *resourceManager=((void *) 0))
 Encode an object of this resource type into a binary format. More...
 
virtual SoundPlugindecode (ResourceID &resourceID, ResourceDecoder &decoder, ResourceReferencePatcher &references, ResourceManager *resourceManager=((void *) 0))
 Decode an object of the resource type, constructing and returning a pointer to the final object. More...
 
PluginManagergetPluginManager () const
 Return a pointer to the plugin manager that is managing the plugin types for this transcoder. More...
 
void setPluginManager (PluginManager *newPluginManager)
 Set a pointer to the plugin manager that is managing the plugin types for this transcoder. More...
 
- Public Member Functions inherited from om::resources::ResourceSetTypeTranscoder< SoundPlugin >
virtual ~ResourceSetTypeTranscoder ()
 Destroy the resource type transcoder, releasing internal resources. More...
 
const ResourceTypegetResourceType () const
 Return the resource type for the data type that this resource type handles. More...
 
virtual Bool encode (const ResourceID &resourceID, const SoundPlugin &data, const ResourceSet &resources, ResourceEncoder &encoder, ResourceManager *resourceManager=((void *) 0))=0
 Encode an object of this resource type into a binary format. More...
 
virtual void patchReferences (const ResourceReference *references, Size numReferences, const ResourceSet &resources, SoundPlugin &data)
 Patch the specified array of references for a previously-decoded object from the given set of resources. More...
 
virtual void finalize (SoundPlugin &data)
 Finish loading an object and perform final initialization after all references have been patched. More...
 
virtual SoundPlugin * instance (const SoundPlugin &data, const ResourceSetTranscoder &transcoder, ResourceSet &resources) const
 Duplicate an object from a prototype and return a pointer to the new object. More...
 
virtual void replaceInstances (SoundPlugin &data, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder, ResourceSet &resources) const
 Replace child object instances on a new prototype component. More...
 
virtual Bool findInstances (const SoundPlugin &data, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder) const
 Return whether or not any child objects were instanced by a prototype. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from om::resources::ResourceSetTypeTranscoder< SoundPlugin >
static InstanceType * replaceInstance (InstanceType *data, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder, ResourceSet &resources)
 
static OpaqueResource replaceInstance (const OpaqueResource &data, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder, ResourceSet &resources)
 
static void * replaceInstance (void *data, const ResourceType &dataType, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder, ResourceSet &resources)
 
static Bool findInstance (InstanceType *data, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder)
 
static Bool findInstance (const OpaqueResource &data, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder)
 
static Bool findInstance (void *data, const ResourceType &dataType, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder)
 

Detailed Description

A class that encodes and decodes sound plugins to/from the resource set format.

Constructor & Destructor Documentation

om::sound::resources::SoundPluginResourceTranscoder::SoundPluginResourceTranscoder ( )
inline

Create a new default sound plugin transcoder with no plugin manager.

Member Function Documentation

virtual Bool om::sound::resources::SoundPluginResourceTranscoder::encode ( const ResourceID resourceID,
const SoundPlugin plugin,
const ResourceSet resources,
ResourceEncoder encoder,
ResourceManager resourceManager = ((void *) 0) 
)
virtual

Encode an object of this resource type into a binary format.

virtual SoundPlugin* om::sound::resources::SoundPluginResourceTranscoder::decode ( ResourceID resourceID,
ResourceDecoder decoder,
ResourceReferencePatcher references,
ResourceManager resourceManager = ((void *) 0) 
)
virtual

Decode an object of the resource type, constructing and returning a pointer to the final object.

Implements om::resources::ResourceSetTypeTranscoder< SoundPlugin >.

PluginManager* om::sound::resources::SoundPluginResourceTranscoder::getPluginManager ( ) const
inline

Return a pointer to the plugin manager that is managing the plugin types for this transcoder.

void om::sound::resources::SoundPluginResourceTranscoder::setPluginManager ( PluginManager newPluginManager)
inline

Set a pointer to the plugin manager that is managing the plugin types for this transcoder.


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