You.i Engine
YiMarkerData.h
Go to the documentation of this file.
1 // © You i Labs Inc. All rights reserved.
2 #ifndef _YI_MARKER_DATA_H_
3 #define _YI_MARKER_DATA_H_
4 
6 #include "utility/YiString.h"
7 
8 #include <map>
9 
35 {
36 public:
37  enum class ID
38  {
39  InvalidID = 0,
40  UpOver,
41  OverUp,
42  DownUp,
43  DownChecked,
44  UpFocus,
45  FocusUp,
46  OverDown,
54  DownOff,
56  Disable,
57  Press,
58  Release,
59  ToggleOn,
60  FocusIn,
61  FocusOut,
62  PressChecked,
65  ToggleOff,
67  ScrollStart,
68  ScrollShow,
69  ScrollHide,
70  ThumbSize,
71  DownOver,
76  };
77 
83 
92  static bool GetStringFromID(CYIMarkerData::ID markerID, CYIString *pString);
93 
99  static bool GetIDFromString(CYIStringView markerString, CYIMarkerData::ID *pMarkerID);
100 
101  CYIMarkerData();
102 
106  void SetName(CYIString name);
107 
111  const CYIString &GetName() const;
112 
117  void SetID(CYIMarkerData::ID id);
118 
123  CYIMarkerData::ID GetID() const;
124 
128  void SetStartTime(uint64_t startTime);
129 
133  uint64_t GetStartTime() const;
134 
138  void SetDuration(uint64_t duration);
139 
143  uint64_t GetDuration() const;
144 
149  void SetTrackSelections(std::vector<CYITimelineTrack::TrackIdentifier> trackSelections);
150 
155  const std::vector<CYITimelineTrack::TrackIdentifier> &GetTrackSelections() const;
156 
160  void SetProperties(std::map<CYIString, CYIString> markerProperties);
161 
165  const std::map<CYIString, CYIString> &GetProperties() const;
166 
170  size_t GetApproximateSize() const;
171 
172 private:
173  CYIString m_Name;
174  CYIMarkerData::ID m_id;
175  uint64_t m_startTime;
176  uint64_t m_duration;
177  std::vector<CYITimelineTrack::TrackIdentifier> m_TrackSelections;
178  std::map<CYIString, CYIString> m_Properties;
179 };
180 
183 #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:32
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:37
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:34
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:61
The animation to play when an item receives a CYIEvent::Type::FocusIn CYIEvent.