NAP
Public Member Functions | List of all members
DefaultInputRouter Class Reference

#include <inputrouter.h>

Public Member Functions

 DefaultInputRouter ()=default
 
 DefaultInputRouter (bool recursive)
 
virtual void routeEvent (const InputEvent &event, const EntityList &entities)
 
void setRecursive (bool value)
 
bool isRecursive () const
 

Additional Inherited Members

- Public Types inherited from InputRouter
using EntityList = std::vector< EntityInstance * >
 

Description

Default implementation of an input router. Sends input events to all input components that are associated with the selection of entities.

Inheritance diagram for DefaultInputRouter:
[legend]
Collaboration diagram for DefaultInputRouter:
[legend]

Constructor & Destructor Documentation

◆ DefaultInputRouter() [1/2]

DefaultInputRouter ( )
default

Default constructor

◆ DefaultInputRouter() [2/2]

DefaultInputRouter ( bool  recursive)

Constructor that sets the recursive flag

Parameters
recursiveif child entities are taken into consideration

Member Function Documentation

◆ isRecursive()

bool isRecursive ( ) const
Returns
If input events are forwarded recursively to child entities

◆ routeEvent()

virtual void routeEvent ( const InputEvent event,
const EntityList entities 
)
virtual

Sends event to all entities in the entity list. Note that when recursive is set to true child entities are considered as well

Parameters
eventthe event to forward to the list of entities
entitiesthe entities to forward the events to

Implements InputRouter.

◆ setRecursive()

void setRecursive ( bool  value)
Parameters
valueIf input events are forward recursively to child entities