Urho3D::DirectionalPadAdapter Class Reference

#include <Urho3D/Input/DirectionalPadAdapter.h>

Inheritance diagram for Urho3D::DirectionalPadAdapter:

Classes
struct	AggregatedState

Public Member Functions
	DirectionalPadAdapter (Context *context)
	Construct.
void	SetEnabled (bool enabled)
	Set enabled flag. The object subscribes for events when enabled.
void	SetSubscriptionMask (DirectionalPadAdapterFlags mask)
	Set input device subscription mask.
void	SetAxisUpperThreshold (float threshold)
	Set axis upper threshold. Axis value greater than threshold is interpreted as key press.
void	SetAxisLowerThreshold (float threshold)
	Set axis lower threshold. Axis value lower than threshold is interpreted as key press.
void	SetRepeatDelay (float delayInSeconds)
	Set repeat delay in seconds.
void	SetRepeatInterval (float intervalInSeconds)
	Set repeat interval in seconds.
bool	IsEnabled () const
	Get enabled flag.
DirectionalPadAdapterFlags	GetSubscriptionMask () const
	Get input device subscription mask.
bool	GetKeyDown (Key key) const
	Check if a key is held down by Key code. Only Up, Down, Left and Right keys are supported.
bool	GetScancodeDown (Scancode scancode) const
	Check if a key is held down by scancode. Only Up, Down, Left and Right scancodes are supported.
float	GetAxisUpperThreshold () const
	Get axis upper threshold. Axis value greater than threshold is interpreted as key press.
float	GetAxisLowerThreshold () const
	Get axis lower threshold. Axis value lower than threshold is interpreted as key press.
float	GetRepeatDelay () const
	Get repeat delay in seconds.
float	GetRepeatInterval () const
	Get repeat interval in seconds.
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 void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
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	InputType { External = 0, Keyboard = 1, JoystickAxis = 100, JoystickDPad = 200 }

Private Member Functions
void	UpdateSubscriptions (DirectionalPadAdapterFlags flags)
void	HandleInputFocus (StringHash eventType, VariantMap &args)
void	HandleUpdate (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	Append (AggregatedState &activeInput, InputType input)
void	Remove (AggregatedState &activeInput, InputType input)
void	RemoveIf (AggregatedState &activeInput, const ea::function< bool(InputType)> &pred)
void	SendKeyUp (Scancode key)
void	SendKeyDown (Scancode key, bool repeat)

Private Attributes
bool	enabled_ {false}
	Is adapter enabled.
DirectionalPadAdapterFlags	enabledSubscriptions_ {DirectionalPadAdapterMask::All}
	Enabled subscriptions.
DirectionalPadAdapterFlags	subscriptionFlags_ {DirectionalPadAdapterMask::None}
	Active subscriptions bitmask.
Input *	input_ {}
AggregatedState	up_
AggregatedState	down_
AggregatedState	left_
AggregatedState	right_
int	ignoreJoystickId_ {ea::numeric_limits<int>::lowest()}
float	axisUpperThreshold_ {0.6f}
float	axisLowerThreshold_ {0.4f}
float	repeatDelay_ {0.5f}
float	repeatInterval_ {0.03f}

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Adapter to translate gamepad axis and DPad messages along with keyboard (WASD and arrows) and externally provided directions into keyboard arrow messages.

DPadAdapter collects all inputs that it can categorize as a movement into specific direction. When at least one input received it sends a corresponding keyboard message about arrow key been pressed. When last input is released it sends a message about key been released. It can also be used as a substitute for Input as it implements GetScancodeDown and GetKeyDown methods but it only supports arrow key and scan codes.

---

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

• Urho3D/Input/DirectionalPadAdapter.h
• Urho3D/Input/DirectionalPadAdapter.cpp