ecstasy::integration::user_action::Users Class Reference

UserProfile container resource. More...

#include <Users.hpp>

Inheritance diagram for ecstasy::integration::user_action::Users:

Collaboration diagram for ecstasy::integration::user_action::Users:

Classes
struct	UserActionLink
	Helper type instead of using std::pair. More...

Public Member Functions
	Users (size_t count=1)
	Construct a new Users resource.
	~Users ()=default
	Default destructor.
void	updateBindings ()
	Update the internal bindings associative maps.
void	handleEvent (Registry &registry, const event::Event &event) const
	Call action listeners associated to the event if any.
constexpr UserProfile &	getUserProfile (size_t index=0)
	Get the User Profile corresponding to the given index.
constexpr const UserProfile &	getUserProfile (size_t index=0) const
	Get the User Profile corresponding to the given index.
Public Member Functions inherited from ecstasy::IResource
virtual	~IResource ()=default
	Default destructor.

Static Public Member Functions
static void	updateBindings (Registry &registry)
	Fetch the Users resource in the registry if available and call updateBindings().

Private Member Functions
template<typename T >
void	removeOutdatedBindings (std::unordered_multimap< T, UserActionLink > &map)
template<typename T >
void	addBindingIfMissing (const UserProfile &user, const ActionBinding &binding, T input, std::unordered_multimap< T, UserActionLink > &map)

Static Private Member Functions
static void	callActionListeners (Registry &registry, Action action)
template<typename T >
static void	callListenersFromMap (Registry &registry, const std::unordered_multimap< T, Users::UserActionLink > &map, T key, float value)

Private Attributes
std::unordered_multimap< event::Mouse::Button, UserActionLink >	_mouseButtonToAction
std::unordered_multimap< event::Keyboard::Key, UserActionLink >	_keyToAction
std::unordered_multimap< event::Gamepad::Button, UserActionLink >	_gamepadButtonToAction
std::unordered_multimap< event::Gamepad::Axis, UserActionLink >	_gamepadAxisToAction
std::vector< UserProfile >	_users

Friends
class	UsersTester

Detailed Description

UserProfile container resource.

Manage all the user profiles and their associated actions and bindings.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-02)

Definition at line 40 of file Users.hpp.

Constructor & Destructor Documentation

Users()

ecstasy::integration::user_action::Users::Users

(

size_t

count = 1

)

Construct a new Users resource.

Parameters

[in]

count

Number of available users.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-02)

Definition at line 20 of file Users.cpp.

                             : _users(count)
    {
        for (size_t i = 1; i < count; i++)
            _users[i].setId(i);
    }

~Users()

ecstasy::integration::user_action::Users::~Users ( )

default

Default destructor.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-02)

Member Function Documentation

addBindingIfMissing()

template<typename T >

void ecstasy::integration::user_action::Users::addBindingIfMissing ( const UserProfile &  user, const ActionBinding &  binding, T  input, std::unordered_multimap< T, UserActionLink > &  map  )

inlineprivate

Definition at line 145 of file Users.hpp.

        {
            bool add = true;
            auto range = map.equal_range(input);
 
            for (auto it = range.first; it != range.second; ++it) {
                if (it->second.userId == user.getId() && it->second.actionId == binding.actionId) {
                    add = false;
                    break;
                }
            }
            if (add)
                map.insert({input, UserActionLink{binding.actionId, user.getId()}});
        }

callActionListeners()

void ecstasy::integration::user_action::Users::callActionListeners ( Registry &  registry, Action  action  )

staticprivate

Definition at line 61 of file Users.cpp.

    {
        if (registry.hasResource<PendingActions>())
            registry.getResource<PendingActions>().get()->push(action);
 
        for (auto [entity, maybeListener, maybeListeners] :
            registry.select<Entities, Maybe<ActionListener>, Maybe<ActionListeners>>()
                .where<Entities, Or<ActionListener, ActionListeners>>()) {
            if (maybeListener) {
                if (maybeListener->get().actionId == Action::All || maybeListener->get().actionId == action.id)
                    maybeListener->get().listener(registry, entity, action);
            } else if (maybeListeners->get().contains(action.id))
                maybeListeners->get()[action.id](registry, entity, action);
        }
    }

callListenersFromMap()

template<typename T >

static void ecstasy::integration::user_action::Users::callListenersFromMap ( Registry &  registry, const std::unordered_multimap< T, Users::UserActionLink > &  map, T  key, float  value  )

inlinestaticprivate

Definition at line 167 of file Users.hpp.

        {
            auto range = map.equal_range(key);
            for (auto it = range.first; it != range.second; ++it)
                callActionListeners(registry, Action{it->second.actionId, it->second.userId, value});
        }

getUserProfile() [1/2]

constexpr UserProfile & ecstasy::integration::user_action::Users::getUserProfile ( size_t  index = 0 )

inlineconstexpr

Get the User Profile corresponding to the given index.

Warning

This method does not perfom bounds checking.

Parameters

[in]

index

User index.

Returns

UserProfile& A reference to the requested user.

Exceptions

std::out_of_range

If the index is out of bounds.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-05)

Definition at line 115 of file Users.hpp.

        {
            return _users[index];
        }

getUserProfile() [2/2]

constexpr const UserProfile & ecstasy::integration::user_action::Users::getUserProfile ( size_t  index = 0 ) const

inlineconstexpr

Get the User Profile corresponding to the given index.

Warning

This method does not perfom bounds checking.

Parameters

[in]

index

User index.

Returns

UserProfile& A reference to the requested user.

Exceptions

std::out_of_range

If the index is out of bounds.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-05)

Definition at line 121 of file Users.hpp.

        {
            return _users[index];
        }

handleEvent()

void ecstasy::integration::user_action::Users::handleEvent	(	Registry &	registry,
		const event::Event &	event
	)		const

Call action listeners associated to the event if any.

Parameters

[in]	registry	Registry owning the event.
[in]	event	Event to handle.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-02)

Definition at line 77 of file Users.cpp.

    {
        switch (e.type) {
            case event::Event::Type::MouseButtonPressed:
            case event::Event::Type::MouseButtonReleased:
                callListenersFromMap(
                    registry, _mouseButtonToAction, e.mouseButton.button, static_cast<float>(e.mouseButton.pressed));
                break;
 
            case event::Event::Type::KeyPressed:
            case event::Event::Type::KeyReleased:
                callListenersFromMap(registry, _keyToAction, e.key.key, static_cast<float>(e.key.pressed));
                break;
 
            case event::Event::Type::GamepadButtonPressed:
            case event::Event::Type::GamepadButtonReleased:
                callListenersFromMap(registry, _gamepadButtonToAction, e.gamepadButton.button,
                    static_cast<float>(e.gamepadButton.pressed));
                break;
 
            case event::Event::Type::GamepadAxis:
                callListenersFromMap(
                    registry, _gamepadAxisToAction, e.gamepadAxis.axis, static_cast<float>(e.gamepadAxis.value));
                break;
            default: break;
        }
    }

removeOutdatedBindings()

template<typename T >

void ecstasy::integration::user_action::Users::removeOutdatedBindings ( std::unordered_multimap< T, UserActionLink > &  map )

inlineprivate

Definition at line 130 of file Users.hpp.

        {
            for (auto it = map.begin(); it != map.end();) {
                if (it->second.userId >= _users.size()
                    || !_users[it->second.userId].getActionBindings().contains(
                        ActionBinding(it->second.actionId, it->first)))
                    it = map.erase(it);
                else
                    ++it;
            }
        }

updateBindings() [1/2]

void ecstasy::integration::user_action::Users::updateBindings

(

)

Update the internal bindings associative maps.

Note

This should be called when one UserProfile binding changed.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-02)

Definition at line 33 of file Users.cpp.

    {
        removeOutdatedBindings(_mouseButtonToAction);
        removeOutdatedBindings(_keyToAction);
        removeOutdatedBindings(_gamepadButtonToAction);
        removeOutdatedBindings(_gamepadAxisToAction);
 
        for (UserProfile &user : _users) {
            auto &bindings = user.getActionBindings().getBindings();
 
            for (ActionBinding binding : bindings) {
                switch (binding.type) {
                    case ActionBinding::Type::MouseButton:
                        addBindingIfMissing(user, binding, binding.mouseButton, _mouseButtonToAction);
                        break;
                    case ActionBinding::Type::Key: addBindingIfMissing(user, binding, binding.key, _keyToAction); break;
                    case ActionBinding::Type::GamepadButton:
                        addBindingIfMissing(user, binding, binding.gamepadButton, _gamepadButtonToAction);
                        break;
                    case ActionBinding::Type::GamepadAxis:
                        addBindingIfMissing(user, binding, binding.gamepadAxis, _gamepadAxisToAction);
                        break;
                    default: break;
                }
            }
        }
    }

updateBindings() [2/2]

void ecstasy::integration::user_action::Users::updateBindings ( Registry &  registry )

static

Fetch the Users resource in the registry if available and call updateBindings().

Parameters

[in]

registry

Registry owning the Users resource.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-12-02)

Definition at line 26 of file Users.cpp.

    {
        if (!registry.hasResource<Users>()) [[unlikely]]
            return;
        registry.getResource<Users>().get().updateBindings();
    }

Friends And Related Symbol Documentation

UsersTester

friend class UsersTester

friend

Definition at line 187 of file Users.hpp.

Member Data Documentation

_gamepadAxisToAction

std::unordered_multimap<event::Gamepad::Axis, UserActionLink> ecstasy::integration::user_action::Users::_gamepadAxisToAction

private

Definition at line 182 of file Users.hpp.

_gamepadButtonToAction

std::unordered_multimap<event::Gamepad::Button, UserActionLink> ecstasy::integration::user_action::Users::_gamepadButtonToAction

private

Definition at line 180 of file Users.hpp.

_keyToAction

std::unordered_multimap<event::Keyboard::Key, UserActionLink> ecstasy::integration::user_action::Users::_keyToAction

private

Definition at line 178 of file Users.hpp.

_mouseButtonToAction

std::unordered_multimap<event::Mouse::Button, UserActionLink> ecstasy::integration::user_action::Users::_mouseButtonToAction

private

Definition at line 176 of file Users.hpp.

_users

std::vector<UserProfile> ecstasy::integration::user_action::Users::_users

private

Definition at line 184 of file Users.hpp.

---

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

• src/ecstasy/integrations/user_action/Users.hpp
• src/ecstasy/integrations/user_action/Users.cpp