You.i Engine
CYIGestureEvent Class Reference

Detailed Description

Gesture related events.

Gesture events include all touch inputs on a device from simple things like one-finger tap to more complicated multi-touch inputs.

Note
Gesture events are only available when accessibility is enabled.
Action events are also raised in addition to gesture events.
See also
CYIActionEvent
CYISwipeGestureEvent

#include <event/YiGestureEvent.h>

Inheritance diagram for CYIGestureEvent:

Public Types

enum  State {
  State::Began,
  State::Changed,
  State::Ended
}
 
- Public Types inherited from CYIActionEvent
enum  ButtonType : uint8_t {
  ButtonType::Left = 0,
  ButtonType::Right,
  ButtonType::Middle,
  ButtonType::None
}
 
- Public Types inherited from CYIEvent
enum  Type : uint8_t {
  Type::None = 0,
  Type::ActionMove,
  Type::ActionDown,
  Type::ActionDelayedDown,
  Type::ActionUp,
  Type::ActionWheel,
  Type::ActionWheelHorizontal,
  Type::ActionWheelVertical,
  Type::ActionClick,
  Type::ActionOut,
  Type::ActionIn,
  Type::ActionEnter,
  Type::ActionLeave,
  Type::ActionPick,
  Type::ActionLongPress,
  Type::ActionSuppressedMove,
  Type::KeyDown,
  Type::KeyUp,
  Type::KeyInput,
  Type::SignalEmit,
  Type::StateMachineWrapped,
  Type::StateMachineSignal,
  Type::GPUGenerateHandle,
  Type::GPULoadBuffer,
  Type::GPUUnloadBuffer,
  Type::GPUFreeHandle,
  Type::GPUInvalidateHandle,
  Type::FocusIn,
  Type::FocusOut,
  Type::TrackpadDown,
  Type::TrackpadMove,
  Type::TrackpadUp,
  Type::DeferredDeletion,
  Type::Task,
  Type::AccessibilityAnnounce,
  Type::AccessibilityFocusIn,
  Type::AccessibilityFocusOut,
  Type::AccessibilityFocusNext,
  Type::AccessibilityFocusPrevious,
  Type::GestureTap,
  Type::GestureDoubleTap,
  Type::GestureSwipe,
  Type::GestureDrag,
  Type::GestureScrub,
  Type::TypesCount
}
 The event type of the CYIEvent class instance. More...
 
enum  Phase : uint8_t {
  Phase::None = 0,
  Phase::Capture,
  Phase::AtTarget,
  Phase::Bubble,
  Phase::Broadcast
}
 The current processing phase of the event. More...
 
enum  Priority {
  Priority::Highest = 2,
  Priority::High = 1,
  Priority::Normal = 0,
  Priority::Low = -1,
  Priority::Lowest = -2,
  Priority::Default = Normal
}
 Priority of the event in the event queue. More...
 

Public Member Functions

 CYIGestureEvent (CYIEvent::Type eventType)
 
 CYIGestureEvent (const CYIGestureEvent &other)=default
 
virtual std::unique_ptr< CYIEventClone () const
 
- Public Member Functions inherited from CYIActionEvent
 CYIActionEvent (CYIEvent::Type eventType)
 
 CYIActionEvent (const CYIActionEvent &rOther)=default
 
virtual ~CYIActionEvent ()
 
- Public Member Functions inherited from CYIEvent
 CYIEvent (CYIEvent::Type eventType)
 
 CYIEvent (const CYIEvent &rOther)
 
virtual ~CYIEvent ()
 
const CYIStringGetName () const
 
CYIEvent::Type GetType () const
 
void SetType (CYIEvent::Type eventType)
 
bool IsActionEvent () const
 
std::unique_ptr< CYIActionEventCloneAsActionEvent () const
 
bool IsKeyEvent () const
 
std::unique_ptr< CYIKeyEventCloneAsKeyEvent () const
 
bool IsFocusEvent () const
 
std::unique_ptr< CYIFocusEventCloneAsFocusEvent () const
 
bool IsTrackpadEvent () const
 
std::unique_ptr< CYITrackpadEventCloneAsTrackpadEvent () const
 
bool IsAccessibilityEvent () const
 
std::unique_ptr< CYIAccessibilityEventCloneAsAccessibilityEvent () const
 
bool IsGestureEvent () const
 
std::unique_ptr< CYIGestureEventCloneAsGestureEvent () const
 
bool IsSwipeGestureEvent () const
 
bool IsScrubGestureEvent () const
 
std::unique_ptr< CYISwipeGestureEventCloneAsSwipeGestureEvent () const
 
void SetTarget (CYIEventTarget *pTarget)
 
CYIEventTargetGetTarget () const
 
const std::shared_ptr< CYIEventTargetProxy > & GetTargetProxy () const
 
void SetCurrentTarget (CYIEventTarget *pTarget)
 
const CYIEventTargetGetCurrentTarget () const
 
CYIEventTargetGetCurrentTarget ()
 
const std::shared_ptr< CYIEventTargetProxy > & GetCurrentTargetProxy () const
 

Public Attributes

State m_state
 
uint32_t m_numberOfFingers
 
- Public Attributes inherited from CYIActionEvent
int32_t m_x
 
int32_t m_y
 
int32_t m_flippedY
 
int32_t m_wheelDelta
 
ButtonType m_button
 
bool m_isHoverType
 
uint8_t m_pointerID
 
CYIRay m_Ray
 
glm::vec3 m_localSpaceLocation
 
- Public Attributes inherited from CYIEvent
uint64_t m_eventTimeMs
 
Phase m_phase
 
bool m_canCancel
 
bool m_canBubble
 
bool m_canCapture
 
bool m_stopPropagation
 
bool m_handled
 

Member Enumeration Documentation

◆ State

Enumerator
Began 
Changed 
Ended 

Constructor & Destructor Documentation

◆ CYIGestureEvent() [1/2]

CYIGestureEvent::CYIGestureEvent ( CYIEvent::Type  eventType)

◆ CYIGestureEvent() [2/2]

CYIGestureEvent::CYIGestureEvent ( const CYIGestureEvent other)
default

Member Function Documentation

◆ Clone()

virtual std::unique_ptr<CYIEvent> CYIGestureEvent::Clone ( ) const
virtual

Reimplemented from CYIActionEvent.

Reimplemented in CYISwipeGestureEvent.

Member Data Documentation

◆ m_numberOfFingers

uint32_t CYIGestureEvent::m_numberOfFingers

◆ m_state

State CYIGestureEvent::m_state

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