om::engine::resources::SceneResourceTranscoder Class Reference

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

#include <omEngineSceneResourceTranscoder.h>

Inheritance diagram for om::engine::resources::SceneResourceTranscoder:

Public Member Functions
virtual Bool	encode (const ResourceID &resourceID, const Scene &scene, const ResourceSet &resources, ResourceEncoder &encoder, ResourceManager *resourceManager=((void *) 0))
	Encode an object of this resource type into a binary format. More...
virtual Scene *	decode (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, Scene &scene)
	Patch the specified array of references for a previously-decoded object from the given set of resources. More...
virtual Scene *	instance (const Scene &scene, const ResourceSetTranscoder &transcoder, ResourceSet &resources) const
	Duplicate an object from a prototype and return a pointer to the new object. More...
virtual void	replaceInstances (Scene &scene, const Prototype &prototype, const Prototype &instance, const ResourceSetTranscoder &transcoder, ResourceSet &resources) const
	Replace child object instances on a new prototype resource. More...
virtual Bool	findInstances (const Scene &scene, 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< Scene >
virtual	~ResourceSetTypeTranscoder ()
	Destroy the resource type transcoder, releasing internal resources. More...
const ResourceType &	getResourceType () const
	Return the resource type for the data type that this resource type handles. More...
virtual Bool	encode (const ResourceID &resourceID, const Scene &data, const ResourceSet &resources, ResourceEncoder &encoder, ResourceManager *resourceManager=((void *) 0))=0
	Encode an object of this resource type into a binary format. More...
virtual Scene *	decode (ResourceID &resourceID, ResourceDecoder &decoder, ResourceReferencePatcher &references, ResourceManager *resourceManager=((void *) 0))=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, Scene &data)
	Patch the specified array of references for a previously-decoded object from the given set of resources. More...
virtual void	finalize (Scene &data)
	Finish loading an object and perform final initialization after all references have been patched. More...
virtual Scene *	instance (const Scene &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 (Scene &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 Scene &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< Scene >
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 scenes to/from the resource set format.

Member Function Documentation

virtual Bool om::engine::resources::SceneResourceTranscoder::encode ( const ResourceID &  resourceID, const Scene &  scene, const ResourceSet &  resources, ResourceEncoder &  encoder, ResourceManager *  resourceManager = ((void *) 0)  )

virtual

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

virtual Scene* om::engine::resources::SceneResourceTranscoder::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.

virtual void om::engine::resources::SceneResourceTranscoder::patchReferences ( const ResourceReference *  references, Size  numReferences, const ResourceSet &  resources, Scene &  scene  )

virtual

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

virtual Scene* om::engine::resources::SceneResourceTranscoder::instance ( const Scene &  scene, const ResourceSetTranscoder &  transcoder, ResourceSet &  resources  ) const

virtual

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

virtual void om::engine::resources::SceneResourceTranscoder::replaceInstances ( Scene &  scene, const Prototype &  prototype, const Prototype &  instance, const ResourceSetTranscoder &  transcoder, ResourceSet &  resources  ) const

virtual

Replace child object instances on a new prototype resource.

virtual Bool om::engine::resources::SceneResourceTranscoder::findInstances ( const Scene &  scene, 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:

• omEngineSceneResourceTranscoder.h