You.i Engine
Public Types | Public Member Functions | Static Public Member Functions | List of all members
CYIMarkerData Class Reference
Animation

Detailed Description

Contains information on an exported marker from After Effects.

How to retrieve marker data using view template timeline backingstore:

#include <animation/YiTimeline.h>
#include <asset/YiAssetTimelineSource.h>
#include <asset/YiAssetViewTemplate.h>
#include <import/YiViewTemplate.h>
std::shared_ptr<CYIAssetViewTemplate> pAssetViewTemplate = CYIViewTemplate::GetViewTemplate("EmptySample_MainComp");
std::shared_ptr<CYIAssetTimelineSource> pTimelineSource = pAssetViewTemplate->GetTemplate()->GetTimelineSource();
std::shared_ptr<CYITimelineBackingStore> pTimelineBackingStore = pTimelineSource->GetTimelineBackingStore();
CYIMarkerData *pMarkerData = pTimelineBackingStore->GetMarkerData("OnPress");

#include <animation/YiMarkerData.h>

Public Types

enum  ID {
  ID::InvalidID = 0,
  ID::UpOver,
  ID::OverUp,
  ID::DownUp,
  ID::DownChecked,
  ID::UpFocus,
  ID::FocusUp,
  ID::OverDown,
  ID::UpOverChecked,
  ID::OverUpChecked,
  ID::UpFocusChecked,
  ID::FocusUpChecked,
  ID::OverDownChecked,
  ID::DownUpChecked,
  ID::DownOffChecked,
  ID::DownOff,
  ID::DisableChecked,
  ID::Disable,
  ID::Press,
  ID::Release,
  ID::ToggleOn,
  ID::FocusIn,
  ID::FocusOut,
  ID::PressChecked,
  ID::ReleaseChecked,
  ID::FocusChecked,
  ID::ToggleOff,
  ID::ProgressStart,
  ID::ScrollStart,
  ID::ScrollShow,
  ID::ScrollHide,
  ID::ThumbSize,
  ID::DownOver,
  ID::FocusInChecked,
  ID::FocusOutChecked,
  ID::FocusInToggleTransition,
  ID::FocusInCheckedToggleTransition
}
 

Public Member Functions

 CYIMarkerData (CYIString name)
 
const CYIString & GetName () const
 
void SetID (CYIMarkerData::ID id)
 
CYIMarkerData::ID GetID () const
 
void SetStartTime (uint64_t startTime)
 
uint64_t GetStartTime () const
 
void SetDuration (uint64_t duration)
 
uint64_t GetDuration () const
 
void SetTrackSelections (std::vector< CYITimelineTrack::TrackIdentifier > trackSelections)
 
const std::vector< CYITimelineTrack::TrackIdentifier > & GetTrackSelections () const
 
void SetProperties (std::map< CYIString, CYIString > markerProperties)
 
const std::map< CYIString, CYIString > & GetProperties () const
 
size_t GetApproximateSize () const
 

Static Public Member Functions

static CYIStringView GetStringFromID (CYIMarkerData::ID markerID)
 
static bool GetStringFromID (CYIMarkerData::ID markerID, CYIString *pString)
 
static bool GetIDFromString (CYIStringView markerString, CYIMarkerData::ID *pMarkerID)
 

Member Enumeration Documentation

◆ ID

enum CYIMarkerData::ID
strong
Enumerator
InvalidID 

Invalid marker. It is used as the default value in most cases.

UpOver 

The animation to play when entering an item area in the unchecked state.

OverUp 

The animation to play when leaving an item area in the unchecked state.

DownUp 

The animation to play when leaving an item area while being pressed.

DownChecked 

The animation to play when leaving an item area in the checked state.

UpFocus 

The animation to play when entering an item area in the focused state.

FocusUp 

The animation to play when leaving an item area in the focused state.

OverDown 

The animation to play when entering an item area while being pressed.

UpOverChecked 

The animation to play when entering an item area in the checked state.

OverUpChecked 

The animation to play when leaving an item area in the checked state.

UpFocusChecked 

The animation to play when entering an item in the focused and checked state.

FocusUpChecked 

The animation to play when leaving an item in the focused and checked state.

OverDownChecked 

The animation to play when entering an item area while being pressed in the checked state.

DownUpChecked 

The animation to play when leaving an item area while being pressed in the checked state.

DownOffChecked 
DownOff 
DisableChecked 

The animation to play when disabled in the checked state.

Disable 

The animation to play when disabled in the unchecked state.

Press 

The animation to play when pressed down in the unchecked state.

Release 

The animation to play when pressed is released in the unchecked state.

ToggleOn 

The animation to play when going from the unchecked to checked state.

FocusIn 

The animation to play when an item receives a CYIEvent::Type::FocusIn CYIEvent.

FocusOut 

The animation to play when an receives a CYIEvent::Type::FocusOut CYIEvent.

PressChecked 

The animation to play when pressed down in the checked state.

ReleaseChecked 

The animation to play when pressed is released in the checked state.

FocusChecked 
ToggleOff 

The animation to play when going from the checked to unchecked state.

ProgressStart 

The animation to play to adjust the progress in a progress bar.

ScrollStart 

The animation to play to adjust the scroll bar position.

ScrollShow 

The animation to play when showing a scroll bar.

ScrollHide 

The animation to play when hiding a scroll bar.

ThumbSize 

The animation to play to adjust the scroll bar size.

DownOver 

The animation to play when a leaving an item area while being pressed in the unchecked state.

FocusInChecked 

The animation to play when an item receives a CYIEvent::Type::FocusIn CYIEvent in the checked state.

FocusOutChecked 

The animation to play when an item receives a CYIEvent::Type::FocusOut CYIEvent in the checked state.

FocusInToggleTransition 

The animation to play when an item transitions from the FocusIn state to FocusIn-Checked state.

FocusInCheckedToggleTransition 

The animation to play when an item transitions from the FocusIn-Checked state to FocusIn state.

Constructor & Destructor Documentation

◆ CYIMarkerData()

CYIMarkerData::CYIMarkerData ( CYIString  name)

Member Function Documentation

◆ GetApproximateSize()

size_t CYIMarkerData::GetApproximateSize ( ) const

Returns the approximate marker's memory size in bytes.

◆ GetDuration()

uint64_t CYIMarkerData::GetDuration ( ) const

Returns the marker's duration.

◆ GetID()

CYIMarkerData::ID CYIMarkerData::GetID ( ) const

Returns the marker's ID.

See also
CYIMarkerData::ID

◆ GetIDFromString()

static bool CYIMarkerData::GetIDFromString ( CYIStringView  markerString,
CYIMarkerData::ID *  pMarkerID 
)
static

Stores the marker's ID in pMarkerID. Returns true if pMarkerID is found.

See also
CYIMarkerData::ID

◆ GetName()

const CYIString& CYIMarkerData::GetName ( ) const

Returns the marker's name.

◆ GetProperties()

const std::map<CYIString, CYIString>& CYIMarkerData::GetProperties ( ) const

Returns the map of marker properties.

◆ GetStartTime()

uint64_t CYIMarkerData::GetStartTime ( ) const

Returns the marker's starting time.

◆ GetStringFromID() [1/2]

static CYIStringView CYIMarkerData::GetStringFromID ( CYIMarkerData::ID  markerID)
static

Returns the name of the marker corresponding to markerID. Returns an empty string view if specified marker ID could not be found.

See also
CYIMarkerData::ID

◆ GetStringFromID() [2/2]

static bool CYIMarkerData::GetStringFromID ( CYIMarkerData::ID  markerID,
CYIString *  pString 
)
static
Deprecated:
This function is deprecated and may be removed in a future release. GetStringFromID(CYIMarkerData::ID) should be used instead.

Stores the marker's name corresponding to markerID in pString. Returns true if the marker's name is found.
Returns false otherwise.

See also
CYIMarkerData::ID

◆ GetTrackSelections()

const std::vector<CYITimelineTrack::TrackIdentifier>& CYIMarkerData::GetTrackSelections ( ) const

Returns a list of parameters the marker will affect.

See also
CYITimelineTrack::TrackIdentifier

◆ SetDuration()

void CYIMarkerData::SetDuration ( uint64_t  duration)

Sets the marker's duration.

◆ SetID()

void CYIMarkerData::SetID ( CYIMarkerData::ID  id)

Sets the marker's ID.

See also
CYIMarkerData::ID

◆ SetProperties()

void CYIMarkerData::SetProperties ( std::map< CYIString, CYIString >  markerProperties)

Sets the map of marker properties.

◆ SetStartTime()

void CYIMarkerData::SetStartTime ( uint64_t  startTime)

Sets the marker's starting time.

◆ SetTrackSelections()

void CYIMarkerData::SetTrackSelections ( std::vector< CYITimelineTrack::TrackIdentifier >  trackSelections)

Sets the list of parameters the marker will affect.

See also
CYITimelineTrack::TrackIdentifier
The documentation for this class was generated from the following file: