You.i Engine
CYIAssetBif Class Reference

Detailed Description

Asset representing BIF files.

The asset class that wraps a BIF parsing class. Like most assets, this asset type can be unloaded by calling CYIAsset::Unload.

#include <asset/YiAssetBif.h>

Inheritance diagram for CYIAssetBif:

Public Member Functions

 CYIAssetBif ()
 
virtual ~CYIAssetBif ()
 
bool GetImageDataAtIndex (uint32_t uIndex, std::vector< uint8_t > *pImageData)
 
uint32_t GetImageIndexAtTime (uint32_t uTime)
 
const std::shared_ptr< CYIBif > & GetBif ()
 
void SetBif (const std::shared_ptr< CYIBif > &pBifParser)
 
- Public Member Functions inherited from CYIAsset
virtual ~CYIAsset ()
 
const CYIStringGetPath () const
 
CYIAssetLoadParamsGetLoadParameters () const
 
virtual std::pair< uint32_t, uint32_t > GetApproximateSize () const
 
bool SetName (const CYIString &name)
 
const CYIStringGetName () const
 
bool Load ()
 
void Unload ()
 
bool IsLoaded () const
 
bool Equals (const std::shared_ptr< CYIAsset > &pAsset)
 
virtual bool Prepare ()
 
- Public Member Functions inherited from CYIScriptableRTTIObject
 CYIScriptableRTTIObject ()
 
virtual ~CYIScriptableRTTIObject ()
 
virtual const CYIRuntimeTypeInfoGetRuntimeTypeInfoForScriptObject () const override
 
- Public Member Functions inherited from CYIScriptableObject
 CYIScriptableObject ()
 
 CYIScriptableObject (const CYIScriptableObject &other)
 
CYIScriptableObjectoperator= (const CYIScriptableObject &other)
 
virtual ~CYIScriptableObject ()
 
CYIBindingImplementationGetBindingImplementation () const
 
void SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
 

Protected Member Functions

virtual void OnUnload () override
 
- Protected Member Functions inherited from CYIAsset
 CYIAsset ()
 
ssize_t GetID () const
 
void SetPath (const CYIString &path, PATH_TYPE ePathType)
 
void SetApproximateSize (uint32_t nSize)
 
void SetLoaded (bool bAssetLoaded)
 
void SetLoadParameters (std::unique_ptr< CYIAssetLoadParams > pParams)
 
virtual void OnLoad ()
 
- Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo *, const void * > GetRuntimeTypeInfoWithObject () const =0
 

Additional Inherited Members

- Public Types inherited from CYIAsset
enum  PATH_TYPE {
  PATH_ABSOLUTE = 0,
  PATH_RELATIVE
}
 
- Static Protected Attributes inherited from CYIAsset
static ssize_t INVALID_ID
 

Constructor & Destructor Documentation

CYIAssetBif::CYIAssetBif ( )
virtual CYIAssetBif::~CYIAssetBif ( )
virtual

Member Function Documentation

const std::shared_ptr<CYIBif>& CYIAssetBif::GetBif ( )

Returns the BIF object held by the asset. The BIF parser will reload automatically reload if the asset has been unloaded.

bool CYIAssetBif::GetImageDataAtIndex ( uint32_t  uIndex,
std::vector< uint8_t > *  pImageData 
)

Returns the the image data into pImageData at the specified uIndex. It will return false if the image data failed to load. The BIF parser will reload automatically if the asset has been unloaded.

uint32_t CYIAssetBif::GetImageIndexAtTime ( uint32_t  uTime)

Returns the image index at the specified uTime. The BIF parser will reload automatically reload if the asset has been unloaded.

virtual void CYIAssetBif::OnUnload ( )
overrideprotectedvirtual

Reimplemented from CYIAsset.

void CYIAssetBif::SetBif ( const std::shared_ptr< CYIBif > &  pBifParser)

Sets the current BIF parser.


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