You.i Engine
YiContentOverlay.h
Go to the documentation of this file.
1 #ifndef _YI_CONTENT_OVERLAY_H_
2 #define _YI_CONTENT_OVERLAY_H_
3 
4 #include <utility/YiString.h>
5 #include <view/YiSceneView.h>
6 
13 {
18 {
19  Configuration(CYISceneView *pContentOverlayNode,
20  const CYISceneView *pInitialFocusNode = nullptr,
21  const CYIString &inAnimationName = CYIString::EmptyString(),
22  const CYIString &outAnimationName = CYIString::EmptyString(),
23  const CYIString &closeKey = CYIString("back"),
24  const int idleTime = 5)
25  : m_pContentOverlayNode(pContentOverlayNode)
26  , m_pInitialFocusNode(pInitialFocusNode)
27  , m_inAnimation(inAnimationName)
28  , m_outAnimation(outAnimationName)
29  , m_closeKey(closeKey)
30  , m_idleTimerDuration(idleTime)
31  {
32  }
39 };
40 
44 enum class State
45 {
46  Show,
47  Hide
48 };
49 
50 }; // namespace CYIContentOverlay
51 
54 #endif
The base class for all view types. Views are containers of renderable elements that often define inte...
Definition: YiSceneView.h:46
Configuration(CYISceneView *pContentOverlayNode, const CYISceneView *pInitialFocusNode=nullptr, const CYIString &inAnimationName=CYIString::EmptyString(), const CYIString &outAnimationName=CYIString::EmptyString(), const CYIString &closeKey=CYIString("back"), const int idleTime=5)
Definition: YiContentOverlay.h:19
Container class for Unicode strings. Conceptually, a CYIString object is a sequence of Unicode charac...
Definition: YiString.h:32
Structure identifying the settings for a cloud content overlay.
Definition: YiContentOverlay.h:17
static const CYIString & EmptyString()
CYIString m_inAnimation
Definition: YiContentOverlay.h:35
CYISceneView * m_pContentOverlayNode
Definition: YiContentOverlay.h:33
State
Enumeration that defines the different content overlay states.
Definition: YiContentOverlay.h:44
Definition: YiContentOverlay.h:12
int m_idleTimerDuration
Definition: YiContentOverlay.h:38
const CYISceneView * m_pInitialFocusNode
Definition: YiContentOverlay.h:34
CYIString m_outAnimation
Definition: YiContentOverlay.h:36
CYIString m_closeKey
Definition: YiContentOverlay.h:37