class MAGES::Interaction::UI::MAGESInputModule¶

Overview¶

An input module with support for Mouse,Touch and Tracked Devices. More…

class MAGESInputModule: public BaseInputModule
{
public:
    // structs

    struct RegisteredUIInteractor;

    // methods

    override void ActivateModule();
    override void DeactivateModule();
    override void Process();
    void RegisterInteractor(IUIInteractor interactor);
    void DeregisterInteractor(IUIInteractor interactor);
    TrackedDeviceModel TryGetTrackedDeviceModelForUIInteractor(IUIInteractor interactor);
    override bool IsPointerOverGameObject(int pointerId);
    PointerEventData TryGetLastPointerEventData(int pointerId);
};

Detailed Documentation¶

An input module with support for Mouse,Touch and Tracked Devices.

Methods¶

void RegisterInteractor(IUIInteractor interactor)

Register a iUIInteractor with the input module.

Parameters:

void DeregisterInteractor(IUIInteractor interactor)

Removes an IUIInteractor from the input module.

Parameters:

TrackedDeviceModel TryGetTrackedDeviceModelForUIInteractor(IUIInteractor interactor)

Tries to get the TrackedDeviceModel for a given IUIInteractor.

Parameters:

Returns:

The model if exists, null otherwise.

override bool IsPointerOverGameObject(int pointerId)

Gets if the pointer with the given pointer id is over a game object.

Parameters:

Returns:

true if pointer is over a gameobject.

PointerEventData TryGetLastPointerEventData(int pointerId)

Gets the last frame pointer event data for the given pointer id.

Parameters:

Returns:

The last frame pointer event data for the given pointer id, or null if not found.