Structure f3d::interactor::BindingParam
Definition: interactor.h (line 169)
Parameter shape for calls to addBinding(...).
Bind modifiers is a binary flag from the dedicated enum that represent KeyModifiers. Bind interaction can be a pressed key symbol, eg: "C", or a dedicated key symbol for special keys: "Left", "Right", "Up", "Down", "Space", "Enter", "Escape", "Question".
Command is the action to perform when this binding is triggered.
Group is an optional arg to group bindings together for better display of the documentation.
DocumentationCallback is an optional function that returns a pair of string, the first is the doc itself, the second is the current value as a string, if any.
Type is an optional type of binding to provide, it can be used for presenting the binding in a coherent way in logs and cheatsheet.
If notify is true, a notification is triggered when pressing the binding.
If repeat is true, the binding is applied repeatedly when holding down the key.
Members
Public attributes
Variable Bind
Definition: interactor.h (line 171)
interaction_bind_t f3d::interactor::BindingParam::Bind
Type: interaction_bind_t
Variable Commands
Definition: interactor.h (line 172)
std::vector<std::string> f3d::interactor::BindingParam::Commands
Type: std::vector< std::string >
Variable Group
Definition: interactor.h (line 173)
std::string f3d::interactor::BindingParam::Group = {}
Type: std::string
Variable DocCallback
Definition: interactor.h (line 174)
documentation_callback_t f3d::interactor::BindingParam::DocCallback = nullptr
Type: documentation_callback_t
Variable Type
Definition: interactor.h (line 175)
BindingType f3d::interactor::BindingParam::Type = BindingType::OTHER
Type: BindingType
Variable Notify
Definition: interactor.h (line 176)
bool f3d::interactor::BindingParam::Notify = true
Type: bool
Variable Repeat
Definition: interactor.h (line 177)
bool f3d::interactor::BindingParam::Repeat = false
Type: bool