You.i Engine
YiMarkerData.h
Go to the documentation of this file.
1 // © You i Labs Inc. 2000-2020. All rights reserved.
2 #ifndef _YI_MARKER_DATA_H_
3 #define _YI_MARKER_DATA_H_
4 
6 #include "utility/YiString.h"
7 
33 {
34 public:
35  enum class ID
36  {
37  InvalidID = 0,
38  UpOver,
39  OverUp,
40  DownUp,
41  DownChecked,
42  UpFocus,
43  FocusUp,
44  OverDown,
52  DownOff,
54  Disable,
55  Press,
56  Release,
57  ToggleOn,
58  FocusIn,
59  FocusOut,
60  PressChecked,
63  ToggleOff,
65  ScrollStart,
66  ScrollShow,
67  ScrollHide,
68  ThumbSize,
69  DownOver,
74  };
75 
81 
90  static bool GetStringFromID(CYIMarkerData::ID markerID, CYIString *pString);
91 
97  static bool GetIDFromString(CYIStringView markerString, CYIMarkerData::ID *pMarkerID);
98 
99  CYIMarkerData();
100 
104  void SetName(CYIString name);
105 
109  const CYIString &GetName() const;
110 
115  void SetID(CYIMarkerData::ID id);
116 
121  CYIMarkerData::ID GetID() const;
122 
126  void SetStartTime(uint64_t startTime);
127 
131  uint64_t GetStartTime() const;
132 
136  void SetDuration(uint64_t duration);
137 
141  uint64_t GetDuration() const;
142 
147  void SetTrackSelections(std::vector<CYITimelineTrack::TrackIdentifier> trackSelections);
148 
153  const std::vector<CYITimelineTrack::TrackIdentifier> &GetTrackSelections() const;
154 
158  void SetProperties(std::map<CYIString, CYIString> markerProperties);
159 
163  const std::map<CYIString, CYIString> &GetProperties() const;
164 
168  size_t GetApproximateSize() const;
169 
170 private:
171  CYIString m_Name;
172  CYIMarkerData::ID m_id;
173  uint64_t m_startTime;
174  uint64_t m_duration;
175  std::vector<CYITimelineTrack::TrackIdentifier> m_TrackSelections;
176  std::map<CYIString, CYIString> m_Properties;
177 };
178 
181 #endif /* _YI_MARKER_DATA_H_ */
The animation to play when an item receives a CYIEvent::Type::FocusOut CYIEvent in the checked state...
const CYIString & GetName() const
The animation to play when an item transitions from the FocusIn state to FocusIn-Checked state...
static CYIStringView GetStringFromID(CYIMarkerData::ID markerID)
The animation to play to adjust the progress in a progress bar.
The animation to play when entering an item area while being pressed.
The animation to play when an item transitions from the FocusIn-Checked state to FocusIn state...
The animation to play when pressed is released in the unchecked state.
Container class for Unicode strings. Conceptually, a CYIString object is a sequence of Unicode charac...
Definition: YiString.h:36
The animation to play to adjust the scroll bar position.
The animation to play when entering an item area in the unchecked state.
ID
Definition: YiMarkerData.h:35
void SetName(CYIString name)
The animation to play to adjust the scroll bar size.
CYIMarkerData::ID GetID() const
The animation to play when leaving an item area in the checked state.
The animation to play when entering an item area while being pressed in the checked state...
uint64_t GetStartTime() const
Invalid marker. It is used as the default value in most cases.
The animation to play when pressed down in the unchecked state.
static bool GetIDFromString(CYIStringView markerString, CYIMarkerData::ID *pMarkerID)
The animation to play when entering an item area in the focused state.
The animation to play when entering an item area in the checked state.
The animation to play when leaving an item area in the unchecked state.
The animation to play when showing a scroll bar.
The animation to play when leaving an item in the focused and checked state.
void SetDuration(uint64_t duration)
The animation to play when an receives a CYIEvent::Type::FocusOut CYIEvent.
The animation to play when a leaving an item area while being pressed in the unchecked state...
The animation to play when going from the unchecked to checked state.
void SetProperties(std::map< CYIString, CYIString > markerProperties)
The animation to play when hiding a scroll bar.
const std::vector< CYITimelineTrack::TrackIdentifier > & GetTrackSelections() const
The animation to play when entering an item in the focused and checked state.
The animation to play when disabled in the checked state.
uint64_t GetDuration() const
The animation to play when going from the checked to unchecked state.
void SetStartTime(uint64_t startTime)
The animation to play when disabled in the unchecked state.
The animation to play when leaving an item area while being pressed.
size_t GetApproximateSize() const
Contains information on an exported marker from After Effects.
Definition: YiMarkerData.h:32
The animation to play when pressed is released in the checked state.
The animation to play when leaving an item area in the checked state.
The animation to play when leaving an item area while being pressed in the checked state...
The animation to play when pressed down in the checked state.
void SetID(CYIMarkerData::ID id)
The animation to play when an item receives a CYIEvent::Type::FocusIn CYIEvent in the checked state...
const std::map< CYIString, CYIString > & GetProperties() const
The animation to play when leaving an item area in the focused state.
void SetTrackSelections(std::vector< CYITimelineTrack::TrackIdentifier > trackSelections)
A lightweight wrapper around a sequence of Unicode characters.
Definition: YiStringView.h:57
The animation to play when an item receives a CYIEvent::Type::FocusIn CYIEvent.