You.i Engine
CYIAssetTimelineSource Class Reference

Detailed Description

TimelineSource asset. Wrapper around a CYITimelineBackingStore.

#include <asset/YiAssetTimelineSource.h>

Inheritance diagram for CYIAssetTimelineSource:

Public Member Functions

 CYIAssetTimelineSource ()
 CYIAssetTimelineSource (const CYIString &path, PathType pathType=PathType::Relative)
virtual ~CYIAssetTimelineSource ()
const std::shared_ptr< CYITimelineBackingStore > & GetTimelineBackingStore ()
void SetTimelineBackingStore (std::shared_ptr< CYITimelineBackingStore > pTimelineBackingStore)
- Public Member Functions inherited from CYIAsset
virtual ~CYIAsset ()
const CYIStringGetPath () const
CYIAssetLoadParamsGetLoadParameters () const
virtual std::pair< size_t, size_tGetApproximateSize () 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 ()

Protected Member Functions

virtual void OnUnload () override
- Protected Member Functions inherited from CYIAsset
 CYIAsset ()
ssize_t GetID () const
void SetPath (const CYIString &path, PathType pathType)
void SetApproximateSize (size_t size)
void SetLoaded (bool assetLoaded)
void SetLoadParameters (std::unique_ptr< CYIAssetLoadParams > pParams)
virtual void OnLoad ()

Additional Inherited Members

- Public Types inherited from CYIAsset
enum  PathType {
  PathType::Absolute = 0,
- Static Protected Attributes inherited from CYIAsset
static ssize_t INVALID_ID

Constructor & Destructor Documentation

◆ CYIAssetTimelineSource() [1/2]

CYIAssetTimelineSource::CYIAssetTimelineSource ( )

◆ CYIAssetTimelineSource() [2/2]

CYIAssetTimelineSource::CYIAssetTimelineSource ( const CYIString path,
PathType  pathType = PathType::Relative 

◆ ~CYIAssetTimelineSource()

virtual CYIAssetTimelineSource::~CYIAssetTimelineSource ( )

Member Function Documentation

◆ GetTimelineBackingStore()

const std::shared_ptr<CYITimelineBackingStore>& CYIAssetTimelineSource::GetTimelineBackingStore ( )

Returns the timeline backing store. The backing store will be reloaded if necessary.

◆ OnUnload()

virtual void CYIAssetTimelineSource::OnUnload ( )

Reimplemented from CYIAsset.

◆ SetTimelineBackingStore()

void CYIAssetTimelineSource::SetTimelineBackingStore ( std::shared_ptr< CYITimelineBackingStore pTimelineBackingStore)

Sets the pTimelineBackingStore.

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