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

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

#include <omSoundTrackResourceTranscoder.h>

Inheritance diagram for om::sound::resources::SoundTrackResourceTranscoder:
om::resources::ResourceSetTypeTranscoder< SoundTrack >

Public Member Functions

virtual Bool encode (const ResourceID &resourceID, const SoundTrack &track, const ResourceSet &resources, ResourceEncoder &encoder, ResourceManager *resourceManager=((void *) 0))
 Encode an object of this resource type into a binary format. More...
 
virtual SoundTrackdecode (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...
 
virtual void patchReferences (const ResourceReference *references, Size numReferences, const ResourceSet &resources, SoundTrack &track)
 Patch the specified array of references for a previously-decoded object from the given set of resources. More...
 
virtual void replaceInstances (SoundTrack &track, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder, ResourceSet &resources) const
 Duplicate an object from a prototype and return a pointer to the new object. More...
 
virtual Bool findInstances (const SoundTrack &track, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder) const
 Return whether or not any child objects were instanced by a prototype. More...
 
- Public Member Functions inherited from om::resources::ResourceSetTypeTranscoder< SoundTrack >
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 SoundTrack &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, SoundTrack &data)
 Patch the specified array of references for a previously-decoded object from the given set of resources. More...
 
virtual void finalize (SoundTrack &data)
 Finish loading an object and perform final initialization after all references have been patched. More...
 
virtual SoundTrack * instance (const SoundTrack &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 (SoundTrack &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 SoundTrack &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< SoundTrack >
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 tracks to/from the resource set format.

Member Function Documentation

virtual Bool om::sound::resources::SoundTrackResourceTranscoder::encode ( const ResourceID resourceID,
const SoundTrack track,
const ResourceSet resources,
ResourceEncoder encoder,
ResourceManager resourceManager = ((void *) 0) 
)
virtual

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

virtual SoundTrack* om::sound::resources::SoundTrackResourceTranscoder::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< SoundTrack >.

virtual void om::sound::resources::SoundTrackResourceTranscoder::patchReferences ( const ResourceReference references,
Size  numReferences,
const ResourceSet resources,
SoundTrack track 
)
virtual

Patch the specified array of references for a previously-decoded object from the given set of resources.

virtual void om::sound::resources::SoundTrackResourceTranscoder::replaceInstances ( SoundTrack track,
const Prototype prototype,
const Prototype instance,
const ResourceSetTranscoder transcoder,
ResourceSet resources 
) const
virtual

Duplicate an object from a prototype and return a pointer to the new object.

virtual Bool om::sound::resources::SoundTrackResourceTranscoder::findInstances ( const SoundTrack track,
const Prototype prototype,
const Prototype instance,
const ResourceSetTranscoder transcoder 
) const
virtual

Return whether or not any child objects were instanced by a prototype.


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