Inheritance diagram for Urho3D::InputMap:

Public Types
using	StringActionMappingMap = ea::unordered_map< ea::string, Detail::ActionMapping, ea::hash< ea::string >, ea::equal_to< ea::string >, EASTLAllocatorType, true >
	Map from string to action mapping. Cache string hashes.

Public Member Functions
	InputMap (Context *context)
	Construct.

void	SerializeInBlock (Archive &archive) override
	Force override of SerializeInBlock.

void	SetDeadZone (float deadZone)
	Set dead zone half-width to mitigate axis drift.

float	GetDeadZone () const
	Get dead zone half-width.

void	MapKeyboardKey (const ea::string &action, Scancode scancode)
	Map keyboard key to the action.

void	MapControllerButton (const ea::string &action, ControllerButton button)
	Map controller button to the action.

void	MapJoystickButton (const ea::string &action, unsigned buttonIndex)
	Map generic joystick button to the action.

void	MapControllerAxis (const ea::string &action, ControllerAxis axis, float neutral, float pressed)
	Map controller axis to the action.

void	MapJoystickAxis (const ea::string &action, unsigned axis, float neutral, float pressed)
	Map generic joystick axis to the action.

void	MapHat (const ea::string &action, HatPosition hatPosition)
	Map controller hat to the action.

void	MapMouseButton (const ea::string &action, MouseButton mouseButton)
	Map mouse button to the action.

void	MapScreenButton (const ea::string &action, const ea::string &elementName)
	Map screen button to the action.

const Detail::ActionMapping &	GetMapping (const ea::string &action) const
	Get mapping for the action.

const Detail::ActionMapping &	GetMappingByHash (StringHash actionHash) const
	Get mapping for the action.

void	AddMetadata (const ea::string &name, const Variant &value)
	Add new metadata variable or overwrite old value.

void	RemoveMetadata (const ea::string &name)
	Remove metadata variable.

void	RemoveAllMetadata ()
	Remove all metadata variables.

const Variant &	GetMetadata (const ea::string &name) const
	Return metadata variable.

bool	HasMetadata () const
	Return whether the resource has metadata.

const StringActionMappingMap &	GetMappings () const
	Get all action mappings.

float	Evaluate (const ea::string &action)
	Evaluate action state.

float	EvaluateByHash (StringHash actionHash)
	Evaluate action state by action string hash.

Public Member Functions inherited from Urho3D::SimpleResource
	SimpleResource (Context *context)
	Construct.

bool	Save (Serializer &dest, InternalResourceFormat format) const
	Save resource in specified internal format.

bool	SaveFile (const FileIdentifier &fileName, InternalResourceFormat format) const
	Save file with specified internal format.

bool	BeginLoad (Deserializer &source) override

bool	EndLoad () override
	Finish resource loading. Always called from the main thread. Return true if successful.

bool	Save (Serializer &dest) const override
	Save resource. Return true if successful.

bool	SaveFile (const FileIdentifier &fileName) const override
	Save resource to file.

Public Member Functions inherited from Urho3D::Resource
	Resource (Context *context)
	Construct.

bool	Load (Deserializer &source)
	Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.

bool	LoadFile (const FileIdentifier &fileName)
	Load resource from file.

void	SetName (const ea::string &name)

void	SetMemoryUse (unsigned size)
	Set memory use in bytes, possibly approximate.

void	ResetUseTimer ()
	Reset last used timer.

void	SetAsyncLoadState (AsyncLoadState newState)
	Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.

void	SetAbsoluteFileName (const ea::string &fileName)
	Set absolute file name.

const ea::string &	GetName () const

StringHash	GetNameHash () const
	Return name hash.

unsigned	GetMemoryUse () const

unsigned	GetUseTimer ()

AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.

const ea::string &	GetAbsoluteFileName () const
	Return absolute file name.

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.

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.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory and attributes.

static ea::span< ea::string_view >	GetScanCodeNames ()
	Get scancode names.

static ea::span< ea::string_view >	GetControllerButtonNames ()
	Get controller button names.

static ea::span< ea::string_view >	GetControllerHatNames ()
	Get controller directional pad (hat) names.

static ea::span< ea::string_view >	GetMouseButtonNames ()
	Get mouse button names.

static SharedPtr< InputMap >	Load (Context *context, const ea::string &name)
	Load input map from config or resources.

Static Public Member Functions inherited from Urho3D::Resource
static Resource *	LoadFromCache (Context *context, StringHash type, const ea::string &name)
	Load resource by reference.

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Public Attributes
const float	DEFAULT_DEADZONE {0.1f}

Private Member Functions
	URHO3D_OBJECT (InputMap, SimpleResource)

Detail::ActionMapping &	GetOrAddMapping (const ea::string &action)

Private Attributes
StringActionMappingMap	actions_
	All mapped actions.

StringVariantMap	metadata_
	Extra data: sensitivity, controller axis dead zone, etc.

float	deadZone_ {0.1f}
	Axis dead zone.

int	ignoreJoystickId_ {-1}
	Joystick to ignore (SDL gyroscope virtual joystick)

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Member Functions inherited from Urho3D::SimpleResource
virtual BinaryMagic	GetBinaryMagic () const
	Binary archive magic word. Should be 4 bytes.

virtual const char *	GetRootBlockName () const
	Root block name. Used for XML serialization only.

virtual InternalResourceFormat	GetDefaultInternalFormat () const
	Default internal resource format on save.

virtual bool	LoadLegacyXML (const XMLElement &source)
	Try to load legacy XML format, whatever it is.

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

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

Urho3D/Input/InputMap.h
Urho3D/Input/InputMap.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members