om::graphics::io::OBJTranscoder Class Reference

A class that reads and writes the Wavefront OBJ format. More...

#include <omGraphicsOBJTranscoder.h>

Inheritance diagram for om::graphics::io::OBJTranscoder:

Public Member Functions
	OBJTranscoder ()
	Create a new OBJ transcoder. More...
virtual	~OBJTranscoder ()
	Destroy this OBJ transcoder and release all associated resources. More...
virtual const ResourceFormat &	getResourceFormat () 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 OBJ 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 OBJ file for this transcoder. More...
virtual GraphicsShape *	decode (ResourceID &identifier, ResourceSet *resourceSet=((void *) 0), ResourceManager *manager=((void *) 0))
	Decode the OBJ 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 ResourceType &	getResourceType () 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 OBJ shapes. More...

Detailed Description

A class that reads and writes the Wavefront OBJ format.

Constructor & Destructor Documentation

om::graphics::io::OBJTranscoder::OBJTranscoder

(

)

Create a new OBJ transcoder.

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

virtual

Destroy this OBJ transcoder and release all associated resources.

Member Function Documentation

virtual const ResourceFormat& om::graphics::io::OBJTranscoder::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::OBJTranscoder::canEncode ( const GraphicsShape &  shape ) const

virtual

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

virtual Bool om::graphics::io::OBJTranscoder::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::OBJTranscoder::canDecode ( const ResourceID &  identifier ) const

virtual

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

Implements om::resources::ResourceTranscoder.

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

virtual

Decode the OBJ 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::OBJTranscoder::FORMAT

static

The resource format for OBJ shapes.

---

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

• omGraphicsOBJTranscoder.h