You.i Engine
Public Member Functions | List of all members
CYIAssetDecoderTemplate Class Reference
Assets

Detailed Description

Asset decoder for view templates from After Effects; these typically have a ".layout" file extension.

Note
When a template is decoded from memory, its associated timeline is not decoded. The associated timeline must be decoded separately and be assigned to the view template using the CYIViewTemplate::SetTimelineSource function.
Template files exported prior to You.i Engine 4.5.0 (AE filter version 2.10) lack magic numbers and cannot be decoded from memory when using the CYIAssetLoader class. They can, however, be decoded from memory when using this decoder directly.
See also
CYIAssetDecoderTimelineSource
CYIAssetLoader

#include <asset/YiAssetDecoderTemplate.h>

Inheritance diagram for CYIAssetDecoderTemplate:
Inheritance graph
[legend]

Public Member Functions

 CYIAssetDecoderTemplate ()
 
virtual ~CYIAssetDecoderTemplate ()
 
virtual bool SupportsParams (const CYIAssetLoadParams *pDecodeParams) override
 
virtual std::shared_ptr< CYIAsset > DecodeAsset (const CYIString &path, const CYIAssetLoadParams *pDecodeParams) override
 
virtual std::shared_ptr< CYIAsset > DecodeAsset (const uint8_t *pData, uint32_t nDataSize, const CYIAssetLoadParams *pDecodeParams) override
 
virtual bool DecodeAsset (const std::shared_ptr< CYIAsset > &pAsset) override
 
virtual bool IsFormatSupported (const uint8_t *pData, uint32_t nDataSize) override
 
virtual bool DecodeAsset (const std::shared_ptr< CYIAsset > &pAsset, const uint8_t *pData, uint32_t uDataSize) override
 
- Public Member Functions inherited from CYIAssetDecoder
 CYIAssetDecoder (const CYIRuntimeTypeInfo &assetType)
 
virtual ~CYIAssetDecoder ()
 
virtual bool IsExtensionSupported (const CYIString &extension)
 
virtual bool SupportsType (const CYIRuntimeTypeInfo &assetType)
 
CYIString GetExtension () const
 
const std::vector< CYIString > & GetExtensions () const
 

Additional Inherited Members

- Protected Attributes inherited from CYIAssetDecoder
std::vector< CYIString > m_SupportedExtensions
 
const CYIRuntimeTypeInfo & m_AssetType
 

Constructor & Destructor Documentation

CYIAssetDecoderTemplate::CYIAssetDecoderTemplate ( )
virtual CYIAssetDecoderTemplate::~CYIAssetDecoderTemplate ( )
virtual

Member Function Documentation

virtual std::shared_ptr<CYIAsset> CYIAssetDecoderTemplate::DecodeAsset ( const CYIString &  path,
const CYIAssetLoadParams *  pDecodeParams 
)
overridevirtual

Decode an asset at the specified path using the optional decoding parameters pDecodeParams. The pDecodeParams can be nullptr.

Implements CYIAssetDecoder.

virtual std::shared_ptr<CYIAsset> CYIAssetDecoderTemplate::DecodeAsset ( const uint8_t *  pData,
uint32_t  nDataSize,
const CYIAssetLoadParams *  pDecodeParams 
)
overridevirtual

Decode an asset using pre-loaded file data pData, nDataSize, and the optional decoding parameters pDecodeParams. The pDecodeParams can be nullptr.

Implements CYIAssetDecoder.

virtual bool CYIAssetDecoderTemplate::DecodeAsset ( const std::shared_ptr< CYIAsset > &  pAsset)
overridevirtual

Decode an asset using an existing asset instance. The path must be set through CYIAsset::SetPath, and the optional decoding parameters may be set through CYIAsset::SetLoadParameters. Returns true if the decoding was successful, false otherwise.

See also
CYIAsset::SetPath(const CYIString &path)
CYIAsset::SetLoadParameters(CYIAssetLoadParams *pParams)

Implements CYIAssetDecoder.

virtual bool CYIAssetDecoderTemplate::DecodeAsset ( const std::shared_ptr< CYIAsset > &  pAsset,
const uint8_t *  pData,
uint32_t  uDataSize 
)
overridevirtual

Decode an asset using an existing asset instance, and pre-loaded file data pData and uDataSize. The optional decoding parameters may be set through CYIAsset::SetLoadParameters. Returns true if the decoding was successful, false otherwise.

See also
CYIAsset::SetLoadParameters(CYIAssetLoadParams *pParams)

Implements CYIAssetDecoder.

virtual bool CYIAssetDecoderTemplate::IsFormatSupported ( const uint8_t *  pData,
uint32_t  nDataSize 
)
overridevirtual

Returns true if the file format is supported. The file contents are supplied through pData and the size of the buffer must be given through nDataSize.

Implements CYIAssetDecoder.

virtual bool CYIAssetDecoderTemplate::SupportsParams ( const CYIAssetLoadParams *  pDecodeParams)
overridevirtual

Returns true if the decoder supports a specialized parameter type.

Reimplemented from CYIAssetDecoder.

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