Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Attributes | List of all members
om::graphics::io::MeshworkTranscoder Class Reference

A class that reads and writes the Meshwork .mesh file format. More...

#include <omGraphicsMeshworkTranscoder.h>

Inheritance diagram for om::graphics::io::MeshworkTranscoder:
om::resources::ResourceTypeTranscoder< DataType > om::resources::ResourceTranscoder

Public Member Functions

 MeshworkTranscoder ()
 Create a new Meshwork transcoder. More...
 
virtual ~MeshworkTranscoder ()
 Destroy this Meshwork transcoder and release all associated resources. More...
 
virtual const ResourceFormatgetResourceFormat () const
 Return an object that represents the resource format that this transcoder can read and write. More...
 
virtual Bool canEncode (const GraphicsShape &shape) const
 Return whether or not this Meshwork transcoder is able to encode the specified resource. More...
 
virtual Bool encode (const ResourceID &identifier, const GraphicsShape &shape, const ResourceSet *resourceSet=((void *) 0), ResourceManager *manager=((void *) 0))
 Encode the specified generic shape to the file at the specified path. More...
 
virtual Bool canDecode (const ResourceID &identifier) const
 Return whether or not the specified identifier refers to a valid Meshwork file for this transcoder. More...
 
virtual GraphicsShapedecode (ResourceID &identifier, ResourceSet *resourceSet=((void *) 0), ResourceManager *manager=((void *) 0))
 Decode the Meshwork file at the specified path and return a pointer to the decoded shape. More...
 
- Public Member Functions inherited from om::resources::ResourceTypeTranscoder< DataType >
virtual const ResourceTypegetResourceType () const
 Return an object that represents the resource type that this transcoder can read and write. More...
 
virtual Bool canEncode (const DataType &resource) const =0
 Return whether or not this transcoder is able to encode the specified resource. More...
 
virtual Bool encode (const ResourceID &identifier, const DataType &resource, const ResourceSet *resourceSet=((void *) 0), ResourceManager *manager=((void *) 0))=0
 Save the specified resource object at the specified ID location. More...
 
- Public Member Functions inherited from om::resources::ResourceTranscoder
virtual ~ResourceTranscoder ()
 Destroy a resource transcoder and release all of its resources. More...
 

Static Public Attributes

static const ResourceFormat FORMAT
 The resource format for Meshwork shapes. More...
 

Detailed Description

A class that reads and writes the Meshwork .mesh file format.

Constructor & Destructor Documentation

om::graphics::io::MeshworkTranscoder::MeshworkTranscoder ( )

Create a new Meshwork transcoder.

virtual om::graphics::io::MeshworkTranscoder::~MeshworkTranscoder ( )
virtual

Destroy this Meshwork transcoder and release all associated resources.

Member Function Documentation

virtual const ResourceFormat& om::graphics::io::MeshworkTranscoder::getResourceFormat ( ) const
virtual

Return an object that represents the resource format that this transcoder can read and write.

Implements om::resources::ResourceTranscoder.

virtual Bool om::graphics::io::MeshworkTranscoder::canEncode ( const GraphicsShape shape) const
virtual

Return whether or not this Meshwork transcoder is able to encode the specified resource.

virtual Bool om::graphics::io::MeshworkTranscoder::encode ( const ResourceID identifier,
const GraphicsShape shape,
const ResourceSet resourceSet = ((void *) 0),
ResourceManager manager = ((void *) 0) 
)
virtual

Encode the specified generic shape to the file at the specified path.

If the method fails, FALSE is returned.

virtual Bool om::graphics::io::MeshworkTranscoder::canDecode ( const ResourceID identifier) const
virtual

Return whether or not the specified identifier refers to a valid Meshwork file for this transcoder.

Implements om::resources::ResourceTranscoder.

virtual GraphicsShape* om::graphics::io::MeshworkTranscoder::decode ( ResourceID identifier,
ResourceSet resourceSet = ((void *) 0),
ResourceManager manager = ((void *) 0) 
)
virtual

Decode the Meshwork file at the specified path and return a pointer to the decoded shape.

If the method fails, a NULL pointer is returned.

Implements om::resources::ResourceTypeTranscoder< DataType >.

Member Data Documentation

const ResourceFormat om::graphics::io::MeshworkTranscoder::FORMAT
static

The resource format for Meshwork shapes.


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