OGLplus  (0.59.0) a C++ wrapper for rendering APIs

eagine::application::input_setup Class Reference

Class that managers user input state. More...

#include <eagine/application/input.hpp>

Public Member Functions

auto value_kinds (input_value_kinds init) noexcept -> auto &
 Constructor with input kinds specification.
 
auto relative () noexcept -> auto &
 Specifies that relative input values are tracked. More...
 
auto absolute_norm () noexcept -> auto &
 Specifies that absolute normalized input values are tracked. More...
 
auto absolute_free () noexcept -> auto &
 Specifies that absolute unbounded input values are tracked. More...
 
auto any_value_kind () noexcept -> auto &
 Specifies that input values of any kind are tracked. More...
 
auto has (input_value_kind kind) const noexcept -> bool
 Indicates if values of the specified kind are tracked.
 
auto trigger () noexcept -> auto &
 Specifies that this is a trigger-like input. More...
 
auto invert (bool init=true) noexcept -> auto &
 Specifies that the raw value from the input source should be inverted.
 
auto multiply (double mult) noexcept -> auto &
 Specifies the multiplier for the raw value from the input source.
 
auto multiplier () const noexcept
 Returns the raw input value multiplier and the inverse setting.
 
auto only_if (bool &flag) noexcept -> auto &
 Registers a flag that "switches" the input on and off. More...
 
auto is_applicable () const noexcept
 Checks if an input value is currently applicable. More...
 

Detailed Description

Class that managers user input state.

Member Function Documentation

◆ absolute_free()

auto eagine::application::input_setup::absolute_free ( ) -> auto&
inlinenoexcept

Specifies that absolute unbounded input values are tracked.

See also
relative
absolute_norm
any_value_kind

Referenced by trigger().

◆ absolute_norm()

auto eagine::application::input_setup::absolute_norm ( ) -> auto&
inlinenoexcept

Specifies that absolute normalized input values are tracked.

See also
relative
absolute_free
any_value_kind

◆ any_value_kind()

auto eagine::application::input_setup::any_value_kind ( ) -> auto&
inlinenoexcept

Specifies that input values of any kind are tracked.

See also
relative
absolute_norm
absolute_free

◆ is_applicable()

auto eagine::application::input_setup::is_applicable ( ) const
inlinenoexcept

Checks if an input value is currently applicable.

See also
only_if

◆ only_if()

auto eagine::application::input_setup::only_if ( bool &  flag) -> auto&
inlinenoexcept

Registers a flag that "switches" the input on and off.

See also
is_applicable

◆ relative()

auto eagine::application::input_setup::relative ( ) -> auto&
inlinenoexcept

Specifies that relative input values are tracked.

See also
absolute_norm
absolute_free
any_value_kind

◆ trigger()

auto eagine::application::input_setup::trigger ( ) -> auto&
inlinenoexcept

Specifies that this is a trigger-like input.

See also
absolute_norm
absolute_free

The documentation for this class was generated from the following file:

Copyright © 2015-2021 Matúš Chochlík.
<chochlik -at -gmail.com>
Documentation generated on Tue Apr 13 2021 by Doxygen (version 1.8.17).