class MAGES::Interaction::MAGESUIInputModule¶

Overview¶

The MAGES UI Input Module. More…

class MAGESUIInputModule: public BaseInputModule
{
public:
    // structs

    struct RaycastHitData;

    // classes

    class UIInteractorData;

    // methods

    override void Process();
    void RegisterInteractor(IUIInteractor interactor);
    void DeregisterInteractor(IUIInteractor interactor);
    int GetPointerIdFromUIInteractor(IUIInteractor interactor);
    override bool IsPointerOverGameObject(int pointerId);
    bool TryGetLastRaycastHit(int pointerId, out RaycastHitData hit);
};

Detailed Documentation¶

The MAGES UI Input Module.

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:

int GetPointerIdFromUIInteractor(IUIInteractor interactor)

Gets the pointer Id of the given interactor.

Parameters:

Returns:

The pointer Id of the given interactor or -1 if is not registered.

override bool IsPointerOverGameObject(int pointerId)

Gets if a pointer is over a GameObject.

Parameters:

Returns:

true if the pointer is over a gameobject, else false if the pointer id does not exist or the pointer is not over a gameobject.

bool TryGetLastRaycastHit(int pointerId, out RaycastHitData hit)

Gets the last raycast hit for the given pointer id.

Parameters:

Returns:

true on success.