prtx::Extension Class Reference

#include <Extension.h>

Inheritance diagram for prtx::Extension:

Public Types
enum	ExtensionType {   ET_UNDEFINED,   ET_STREAM_ADAPTOR,   ET_RESOLVEMAP_PROVIDER,   ET_ENCODER,   ET_DECODER,   ET_COUNT }

Public Member Functions
	Extension (const Extension &)=delete
virtual prt::ContentType	getContentType () const =0
virtual ExtensionType	getExtensionType () const =0
Extension &	operator= (const Extension &)=delete

Static Public Member Functions
static prt::ContentType	toContentType (const std::wstring &ctStr)
static ExtensionType	toExtensionType (const std::wstring &etStr)
static const std::wstring &	toString (const ExtensionType &et)
static const std::wstring &	toString (const prt::ContentType &ct)

Detailed Description

Base class for all PRTX extension types: Encoders, Decoders, StreamAdaptors, and ResolveMapProviders. Extensions are not copyable.

Member Enumeration Documentation

ExtensionType

enum prtx::Extension::ExtensionType

Possible extension types.

Enumerator
ET_UNDEFINED	Extension sub-class is undefined.
ET_STREAM_ADAPTOR	Extension sub-class is a stream adaptor.
ET_RESOLVEMAP_PROVIDER	Extension sub-class is a resolve map provider.
ET_ENCODER	Extension sub-class is an encoder.
ET_DECODER	Extension sub-class is a decoder.
ET_COUNT	Number of extension types.

Member Function Documentation

getContentType()

virtual prt::ContentType prtx::Extension::getContentType ( ) const

pure virtual

Specifies the supported content type. Implemented by each subclass.

Returns

The supported content type of a subclass instance.

Implemented in prtx::TextureEncoder, prtx::TableDecoder, prtx::MaterialEncoder, prtx::StringDecoder, prtx::CGBDecoder, prtx::GeometryEncoder, prtx::TextureDecoder, prtx::MaterialDecoder, prtx::GeometryDecoder, prtx::StreamAdaptor, and prtx::ResolveMapProvider.

getExtensionType()

virtual ExtensionType prtx::Extension::getExtensionType ( ) const

pure virtual

Specifies the extensions type. Implemented by each subclass.

Returns

The extension type of a subclass instance.

Implemented in prtx::Encoder, prtx::StreamAdaptor, prtx::ResolveMapProvider, and prtx::Decoder.

toContentType()

static prt::ContentType prtx::Extension::toContentType ( const std::wstring &  ctStr )

static

Utility member function to get the content type enum item from a string.

Parameters

ctStr

The contentType type as string.

Returns

The corresponding enum item or CT_COUNT if ctStr is not found.

toExtensionType()

static ExtensionType prtx::Extension::toExtensionType ( const std::wstring &  etStr )

static

Utility member function to get the extension enum item from a string.

Parameters

etStr

The extension type as string.

Returns

The corresponding enum item or ET_COUNT if ctStr is not found.

toString() [1/2]

static const std::wstring& prtx::Extension::toString ( const ExtensionType &  et )

static

Returns the string representation of enum item et.

Parameters

et	Extension type enum item.

Returns

Extension type as string.

toString() [2/2]

static const std::wstring& prtx::Extension::toString ( const prt::ContentType &  ct )

static

Returns the string representation of enum item ct.

Parameters

ct	Content type enum item.

Returns

Content type as string.

---

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

• Extension.h