IInputConsumerEx

Description

interface Tinman.Engine.Application.IInputConsumerEx

Derived from: IInputConsumer
Extended by: ICameraControl
ISceneEntityViewFocusable
IWidget
ObjectList ^sealed
SceneView ^sealed
ScrollControl ^sealed
SixDofCrosshair ^sealed

Base interface for classes that consume input events (see InputEvent) and/or poll input state (see IInputState).

An IInputConsumerEx object can request to capture the mouse (see ShouldCaptureMouse). The outer code can then honour this request (for example via IApplicationWindow.MouseCaptured).

public method InputAttach → (1)

Attaches this input consumer to the given input state object.

The input state object provides a snapshot of the input keys and buttons. It should not be used to detect up/down/click events.

public method InputDetach → ()

Detached this input consumer from its input state object.

public attribute ShouldCaptureMouse → (get)

Should the mouse be captured, because this input consumer only processes relative input?