KeyInputComponentInstance Class Reference

#include <inputcomponent.h>

Public Member Functions
	KeyInputComponentInstance (EntityInstance &entity, Component &resource)
Public Member Functions inherited from InputComponentInstance
	InputComponentInstance (EntityInstance &entity, Component &resource)
Public Member Functions inherited from ComponentInstance
	ComponentInstance (EntityInstance &entity, Component &resource)
virtual void	update (double deltaTime)
nap::EntityInstance *	getEntityInstance () const
nap::Component *	getComponent () const
template<typename T >
T *	getComponent () const
virtual bool	init (utility::ErrorState &errorState)
virtual bool	init (utility::ErrorState &errorState)
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
virtual void	onDestroy ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
Signal< const KeyPressEvent & >	pressed
	Signal emitted when a key is pressed. More...
Signal< const KeyReleaseEvent & >	released
	Signal emitted when a key is released. More...
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Protected Member Functions
virtual void	trigger (const nap::InputEvent &inEvent) override

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)

Description

Input component that receives keyboard press and release events. Register to the various signals to receive key events.

Inheritance diagram for KeyInputComponentInstance:

Collaboration diagram for KeyInputComponentInstance:

Constructor & Destructor Documentation

KeyInputComponentInstance()

KeyInputComponentInstance	(	EntityInstance &	entity,
		Component &	resource
	)

Member Function Documentation

trigger()

virtual void trigger ( const nap::InputEvent &  inEvent )

overrideprotectedvirtual

This function is called by an InputRouter derived class if it decides to route the input to this component. Implement this function in a derived class to handle input.

Parameters

inEvent

An InputEvent-derived class. Use RTTI queries to test the type of event and to retrieve data from it.

Implements InputComponentInstance.

Member Data Documentation

pressed

Signal<const KeyPressEvent&> pressed

Signal emitted when a key is pressed.

released

Signal<const KeyReleaseEvent&> released

Signal emitted when a key is released.