You.i Engine
YiMarkerData.h
Go to the documentation of this file.
1 // © You i Labs Inc. 2000-2017. All rights reserved.
2 #ifndef _YI_MARKER_DATA_H_
3 #define _YI_MARKER_DATA_H_
4 
5 #include "utility/YiString.h"
7 
33 {
34 public:
35 
36  typedef enum
37  {
75  }
76  MARKER_ID;
77 
84  static bool GetStringFromID(MARKER_ID eMarkerID, CYIString *pString);
85 
91  static const char *GetStringFromID(MARKER_ID eMarkerID);
92 
98  static bool GetIDFromString(const CYIString &markerString, MARKER_ID *peMarkerID);
99 
100  CYIMarkerData();
101  ~CYIMarkerData();
102 
106  void SetName(const CYIString &rName);
107 
111  const CYIString &GetName() const;
112 
117  void SetID(MARKER_ID eID);
118 
124 
128  void SetStartTime(uint64_t uStartTime);
129 
133  uint64_t GetStartTime() const;
134 
138  void SetDuration(uint64_t uDuration);
139 
143  uint64_t GetDuration() const;
144 
149  void SetTrackSelections(const std::list<CYITimelineTrack::TRACK_IDENTIFIER> &rTrackSelections);
150 
155  const std::list<CYITimelineTrack::TRACK_IDENTIFIER> &GetTrackSelections() const;
156 
160  void SetProperties(const std::map<CYIString, CYIString> &markerProperties);
161 
165  const std::map<CYIString, CYIString> &GetProperties() const;
166 
170  int32_t GetApproximateSize() const;
171 
172 private:
173 
174  CYIString m_Name;
175  MARKER_ID m_eID;
176  uint64_t m_uStartTime;
177  uint64_t m_uDuration;
178  std::list<CYITimelineTrack::TRACK_IDENTIFIER> m_TrackSelections;
179  std::map<CYIString, CYIString> m_Properties;
180 };
181 
184 #endif /* _YI_MARKER_DATA_H_ */
The animation to play when pressed down in the checked state.
Definition: YiMarkerData.h:61
void SetStartTime(uint64_t uStartTime)
Definition: YiMarkerData.h:63
The animation to play when an item receives a YI_FOCUS_OUT CYIEvent in the checked state...
Definition: YiMarkerData.h:72
The animation to play when entering an item area while being pressed in the checked state...
Definition: YiMarkerData.h:50
uint64_t GetStartTime() const
The animation to play when entering an item area while being pressed.
Definition: YiMarkerData.h:45
The animation to play when an receives a YI_FOCUS_OUT CYIEvent.
Definition: YiMarkerData.h:60
The animation to play to adjust the scroll bar size.
Definition: YiMarkerData.h:69
The animation to play when entering an item area in the focused state.
Definition: YiMarkerData.h:43
Container class for Unicode strings. Conceptually, a CYIString object is a sequence of Unicode charac...
Definition: YiString.h:35
The animation to play when leaving an item area while being pressed.
Definition: YiMarkerData.h:41
The animation to play when going from the unchecked to checked state.
Definition: YiMarkerData.h:58
The animation to play when disabled in the checked state.
Definition: YiMarkerData.h:54
The animation to play when leaving an item area in the focused state.
Definition: YiMarkerData.h:44
static bool GetIDFromString(const CYIString &markerString, MARKER_ID *peMarkerID)
Definition: YiMarkerData.h:52
The animation to play when showing a scroll bar.
Definition: YiMarkerData.h:67
uint64_t GetDuration() const
void SetID(MARKER_ID eID)
The animation to play to adjust the scroll bar position.
Definition: YiMarkerData.h:66
void SetDuration(uint64_t uDuration)
The animation to play when leaving an item area while being pressed in the checked state...
Definition: YiMarkerData.h:51
void SetProperties(const std::map< CYIString, CYIString > &markerProperties)
The animation to play when pressed is released in the unchecked state.
Definition: YiMarkerData.h:57
int32_t GetApproximateSize() const
Invalid marker. It is used as the default value in most cases.
Definition: YiMarkerData.h:38
const std::map< CYIString, CYIString > & GetProperties() const
The animation to play when leaving an item area in the unchecked state.
Definition: YiMarkerData.h:40
MARKER_ID
Definition: YiMarkerData.h:36
The animation to play when a leaving an item area while being pressed in the unchecked state...
Definition: YiMarkerData.h:70
The animation to play when leaving an item area in the checked state.
Definition: YiMarkerData.h:42
The animation to play when pressed is released in the checked state.
Definition: YiMarkerData.h:62
static bool GetStringFromID(MARKER_ID eMarkerID, CYIString *pString)
The animation to play when going from the checked to unchecked state.
Definition: YiMarkerData.h:64
The animation to play when entering an item area in the unchecked state.
Definition: YiMarkerData.h:39
The animation to play when pressed down in the unchecked state.
Definition: YiMarkerData.h:56
The animation to play when entering an item area in the checked state.
Definition: YiMarkerData.h:46
void SetTrackSelections(const std::list< CYITimelineTrack::TRACK_IDENTIFIER > &rTrackSelections)
The animation to play to adjust the progress in a progress bar.
Definition: YiMarkerData.h:65
void SetName(const CYIString &rName)
const CYIString & GetName() const
The animation to play when leaving an item in the focused and checked state.
Definition: YiMarkerData.h:49
The animation to play when disabled in the unchecked state.
Definition: YiMarkerData.h:55
Definition: YiMarkerData.h:53
The animation to play when an item receives a YI_FOCUS_IN CYIEvent.
Definition: YiMarkerData.h:59
const std::list< CYITimelineTrack::TRACK_IDENTIFIER > & GetTrackSelections() const
The animation to play when entering an item in the focused and checked state.
Definition: YiMarkerData.h:48
Contains information on an exported marker from After Effects.
Definition: YiMarkerData.h:32
The animation to play when an item transitions from the FocusIn state to FocusIn-Checked state...
Definition: YiMarkerData.h:73
The animation to play when an item transitions from the FocusIn-Checked state to FocusIn state...
Definition: YiMarkerData.h:74
The animation to play when leaving an item area in the checked state.
Definition: YiMarkerData.h:47
The animation to play when hiding a scroll bar.
Definition: YiMarkerData.h:68
CYIMarkerData::MARKER_ID GetID() const
The animation to play when an item receives a YI_FOCUS_IN CYIEvent in the checked state...
Definition: YiMarkerData.h:71