Urho3D::DirectionAggregator Class Reference

Class to aggregate all movement inputs into a single direction vector. More...

#include <Urho3D/Input/DirectionAggregator.h>

Inheritance diagram for Urho3D::DirectionAggregator:

Classes
struct	AxisState

Public Member Functions
	DirectionAggregator (Context *context)
	Construct.
	~DirectionAggregator ()
	Destruct.
void	SetEnabled (bool enabled)
	Set enabled flag. The object subscribes for events when enabled.
void	SetSubscriptionMask (DirectionAggregatorFlags mask)
	Set input device subscription mask.
void	SetUIElement (UIElement *element)
	Set UI element to filter touch events. Only touch events originated in the element going to be handled.
void	SetDeadZone (float deadZone)
	Set dead zone to mitigate axis drift.
bool	IsEnabled () const
	Get enabled flag.
DirectionAggregatorFlags	GetSubscriptionMask () const
	Get input device subscription mask.
UIElement *	GetUIElement () const
	Get UI element to filter touch events.
float	GetDeadZone () const
	Get dead zone.
Vector2	GetDirection () const
	Get aggregated direction vector with X pointing right and Y pointing down (similar to gamepad axis).
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Private Types
enum class	InputType {   External = 0 , Keyboard = 1 , Touch = 2 , JoystickAxis = 3 ,   JoystickDPad = 4 }
	Type of input source.
typedef ea::fixed_vector< AxisState, 4 >	InputVector
	Type definition for active input sources.

Private Member Functions
void	UpdateSubscriptions (DirectionAggregatorFlags flags)
void	HandleInputFocus (StringHash eventType, VariantMap &args)
void	HandleKeyDown (StringHash eventType, VariantMap &args)
void	HandleKeyUp (StringHash eventType, VariantMap &args)
void	HandleJoystickAxisMove (StringHash eventType, VariantMap &args)
void	HandleJoystickHatMove (StringHash eventType, VariantMap &args)
void	HandleJoystickDisconnected (StringHash eventType, VariantMap &args)
void	HandleTouchBegin (StringHash eventType, VariantMap &args)
void	HandleTouchMove (StringHash eventType, VariantMap &args)
void	HandleTouchEnd (StringHash eventType, VariantMap &args)
void	UpdateAxis (ea::fixed_vector< AxisState, 4 > &activeStates, AxisState state)

Private Attributes
bool	enabled_ {false}
	Is aggregator enabled.
DirectionAggregatorFlags	enabledSubscriptions_ {DirectionAggregatorMask::All}
	Enabled subscriptions.
DirectionAggregatorFlags	subscriptionFlags_ {DirectionAggregatorMask::None}
	Active subscriptions bitmask.
Input *	input_ {}
	Cached input subsystem pointer.
InputVector	verticalAxis_
	Collection of active vertical axis inputs.
InputVector	horizontalAxis_
	Collection of active horizontal axis inputs.
AxisAdapter	axisAdapter_ {}
	Joystick axis adapter.
int	ignoreJoystickId_ {-1}
	Joystick to ignore (SDL gyroscope virtual joystick)
WeakPtr< UIElement >	uiElement_ {}
	UI element to filter touch events.
ea::optional< int >	activeTouchId_ {}
	Identifier of active touch.
IntVector2	touchOrigin_ {}
	Origin of the touch.
float	touchSensitivity_ {}
	Touch sensitivity.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Class to aggregate all movement inputs into a single direction vector.

Member Function Documentation

GetDirection()

Vector2 Urho3D::DirectionAggregator::GetDirection

(

)

const

Get aggregated direction vector with X pointing right and Y pointing down (similar to gamepad axis).

Get aggregated direction vector.

---

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

• Urho3D/Input/DirectionAggregator.h
• Urho3D/Input/DirectionAggregator.cpp