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(CYIViewTemplate::DEFAULT_TIMELINE_INDEX);
std::shared_ptr<CYITimelineBackingStore> pTimelineBackingStore = pTimelineSource->GetTimelineBackingStore();
CYIMarkerData *pMarkerData = pTimelineBackingStore->GetMarkerData("OnPress");

#include <animation/YiMarkerData.h>

Public Types
enum	MARKER_ID { INVALID_MARKER_ID, UP_OVER, OVER_UP, DOWN_UP, DOWN_CHECKED, UP_FOCUS, FOCUS_UP, OVER_DOWN, UP_OVER_CHECKED, OVER_UP_CHECKED, UP_FOCUS_CHECKED, FOCUS_UP_CHECKED, OVER_DOWN_CHECKED, DOWN_UP_CHECKED, DOWN_OFF_CHECKED, DOWN_OFF, DISABLE_CHECKED, DISABLE, PRESS, RELEASE, TOGGLE_ON, FOCUS_IN, FOCUS_OUT, PRESS_CHECKED, RELEASE_CHECKED, FOCUS_CHECKED, TOGGLE_OFF, PROGRESS_START, SCROLL_START, SCROLL_SHOW, SCROLL_HIDE, THUMB_SIZE, DOWN_OVER, FOCUS_IN_CHECKED, FOCUS_OUT_CHECKED, FOCUS_IN_TOGGLE_TRANSITION, FOCUS_IN_CHECKED_TOGGLE_TRANSITION }

Public Member Functions
	CYIMarkerData ()

	~CYIMarkerData ()

void	SetName (const CYIString &rName)

const CYIString &	GetName () const

void	SetID (MARKER_ID eID)

CYIMarkerData::MARKER_ID	GetID () const

void	SetStartTime (uint64_t uStartTime)

uint64_t	GetStartTime () const

void	SetDuration (uint64_t uDuration)

uint64_t	GetDuration () const

void	SetTrackSelections (const std::list< CYITimelineTrack::TRACK_IDENTIFIER > &rTrackSelections)

const std::list< CYITimelineTrack::TRACK_IDENTIFIER > &	GetTrackSelections () const

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

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

int32_t	GetApproximateSize () const

Static Public Member Functions
static bool	GetStringFromID (MARKER_ID eMarkerID, CYIString *pString)

static const char *	GetStringFromID (MARKER_ID eMarkerID)

static bool	GetIDFromString (const CYIString &markerString, MARKER_ID *peMarkerID)

Member Enumeration Documentation

enum CYIMarkerData::MARKER_ID

Enumerator
INVALID_MARKER_ID	Invalid marker. It is used as the default value in most cases.
UP_OVER	The animation to play when entering an item area in the unchecked state.
OVER_UP	The animation to play when leaving an item area in the unchecked state.
DOWN_UP	The animation to play when leaving an item area while being pressed.
DOWN_CHECKED	The animation to play when leaving an item area in the checked state.
UP_FOCUS	The animation to play when entering an item area in the focused state.
FOCUS_UP	The animation to play when leaving an item area in the focused state.
OVER_DOWN	The animation to play when entering an item area while being pressed.
UP_OVER_CHECKED	The animation to play when entering an item area in the checked state.
OVER_UP_CHECKED	The animation to play when leaving an item area in the checked state.
UP_FOCUS_CHECKED	The animation to play when entering an item in the focused and checked state.
FOCUS_UP_CHECKED	The animation to play when leaving an item in the focused and checked state.
OVER_DOWN_CHECKED	The animation to play when entering an item area while being pressed in the checked state.
DOWN_UP_CHECKED	The animation to play when leaving an item area while being pressed in the checked state.
DOWN_OFF_CHECKED
DOWN_OFF
DISABLE_CHECKED	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.
TOGGLE_ON	The animation to play when going from the unchecked to checked state.
FOCUS_IN	The animation to play when an item receives a YI_FOCUS_IN CYIEvent.
FOCUS_OUT	The animation to play when an receives a YI_FOCUS_OUT CYIEvent.
PRESS_CHECKED	The animation to play when pressed down in the checked state.
RELEASE_CHECKED	The animation to play when pressed is released in the checked state.
FOCUS_CHECKED
TOGGLE_OFF	The animation to play when going from the checked to unchecked state.
PROGRESS_START	The animation to play to adjust the progress in a progress bar.
SCROLL_START	The animation to play to adjust the scroll bar position.
SCROLL_SHOW	The animation to play when showing a scroll bar.
SCROLL_HIDE	The animation to play when hiding a scroll bar.
THUMB_SIZE	The animation to play to adjust the scroll bar size.
DOWN_OVER	The animation to play when a leaving an item area while being pressed in the unchecked state.
FOCUS_IN_CHECKED	The animation to play when an item receives a YI_FOCUS_IN CYIEvent in the checked state.
FOCUS_OUT_CHECKED	The animation to play when an item receives a YI_FOCUS_OUT CYIEvent in the checked state.
FOCUS_IN_TOGGLE_TRANSITION	The animation to play when an item transitions from the FocusIn state to FocusIn-Checked state.
FOCUS_IN_CHECKED_TOGGLE_TRANSITION	The animation to play when an item transitions from the FocusIn-Checked state to FocusIn state.

Constructor & Destructor Documentation

CYIMarkerData::CYIMarkerData ( )

CYIMarkerData::~CYIMarkerData ( )

Member Function Documentation

int32_t CYIMarkerData::GetApproximateSize ( ) const

Returns the approximate marker's memory size in bytes.

uint64_t CYIMarkerData::GetDuration ( ) const

Returns the marker's duration.

CYIMarkerData::MARKER_ID CYIMarkerData::GetID ( ) const

Returns the marker's ID.

See also: MARKER_ID

static bool CYIMarkerData::GetIDFromString	(	const CYIString &	markerString,
		MARKER_ID *	peMarkerID
	)

static

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

See also: MARKER_ID

const CYIString& CYIMarkerData::GetName ( ) const

Returns the marker's name.

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

Returns the map of marker properties.

uint64_t CYIMarkerData::GetStartTime ( ) const

Returns the marker's starting time.

static bool CYIMarkerData::GetStringFromID	(	MARKER_ID	eMarkerID,
		CYIString *	pString
	)

static

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

See also: MARKER_ID

static const char* CYIMarkerData::GetStringFromID ( MARKER_ID eMarkerID )

static

Returns the marker's name. Returns nullptr if the marker doesn't exist.

See also: MARKER_ID

const std::list<CYITimelineTrack::TRACK_IDENTIFIER>& CYIMarkerData::GetTrackSelections ( ) const

Returns a list of parameters the marker will affect.

See also: CYITimelineTrack::TRACK_IDENTIFIER

void CYIMarkerData::SetDuration ( uint64_t uDuration )

Sets the marker's duration.

void CYIMarkerData::SetID ( MARKER_ID eID )

Sets the marker's ID.

See also: MARKER_ID

void CYIMarkerData::SetName ( const CYIString & rName )

Sets the marker's name.

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

Sets the map of marker properties.

void CYIMarkerData::SetStartTime ( uint64_t uStartTime )

Sets the marker's starting time.

void CYIMarkerData::SetTrackSelections ( const std::list< CYITimelineTrack::TRACK_IDENTIFIER > & rTrackSelections )

Sets the list of parameters the marker will affect.

See also: CYITimelineTrack::TRACK_IDENTIFIER

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

animation/YiMarkerData.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation