oa::InputSystem

InputSystem class in the OA Ui public surface.

ClC++ public headers

Public Methods

InputContext oa::InputSystem::context()

bool oa::InputSystem::dispatch(const UiEvent & inEvent)

oa::Status oa::InputSystem::loadBindingsYaml(oa::StringView inPath)

void oa::InputSystem::rebind(oa::StringView inName, KeyBinding inBinding)

void oa::InputSystem::registerAction(KeyAction inAction)

void oa::InputSystem::registerDefaults()

oa::Status oa::InputSystem::saveBindingsYaml(oa::StringView inPath)

void oa::InputSystem::setCallback(oa::StringView inName, oa::Fn<void ()> inCallback)

void oa::InputSystem::setContext(InputContext inCtx)

void oa::InputSystem::unregisterAction(oa::StringView inName)

Constructor & Destructor Documentation

oa::InputSystem::InputSystem()

No public source comment is attached to this declaration.

Public Method Documentation

InputContext oa::InputSystem::context()

No public source comment is attached to this declaration.

Returns

InputContext

The declared return value.

bool oa::InputSystem::dispatch(
	const UiEvent & inEvent
)

Returns true if inEvent was consumed by a matching action.

Parameters

inEvent

const UiEvent &

—

Returns

bool

The declared return value.

oa::Status oa::InputSystem::loadBindingsYaml(
	oa::StringView inPath
)

YAML schema: {version: 1, bindings: [{action, key, modifiers, context, allow_repeat}]}. Loading is transactional for syntax and schema errors. Without yaml-cpp these calls report Unimplemented, never success.

Parameters

inPath

oa::StringView

—

Returns

oa::Status

The declared return value.

void oa::InputSystem::rebind(
	oa::StringView inName,
	KeyBinding inBinding
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

inBinding

KeyBinding

—

Returns

void

The declared return value.

void oa::InputSystem::registerAction(
	KeyAction inAction
)

No public source comment is attached to this declaration.

Parameters

inAction

KeyAction

—

Returns

void

The declared return value.

void oa::InputSystem::registerDefaults()

register the reusable Realm tool bindings. This installs named actions with no callbacks; the application owns every operation they trigger: F12 — screenshot ctrl+R — start/stop recording Space — toggle camera ctrl+Z — undo (node graph) ctrl+Y — redo ctrl+S — save F — fit-to-view (node canvas)

Returns

void

The declared return value.

oa::Status oa::InputSystem::saveBindingsYaml(
	oa::StringView inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

oa::StringView

—

Returns

oa::Status

The declared return value.

void oa::InputSystem::setCallback(
	oa::StringView inName,
	oa::Fn<void ()> inCallback
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

inCallback

oa::Fn<void ()>

—

Returns

void

The declared return value.

void oa::InputSystem::setContext(
	InputContext inCtx
)

No public source comment is attached to this declaration.

Parameters

inCtx

InputContext

—

Returns

void

The declared return value.

void oa::InputSystem::unregisterAction(
	oa::StringView inName
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

Returns

void

The declared return value.