class MAGES::Interaction::UI::MouseModel¶

Overview¶

A model for a mouse input device. More…

class MouseModel
{
public:
    // fields

    GameObject TargetObject;
    List HoveredObjects;
    Vector2 ScrollDelta;
    GameObject PointerEnter;

    // properties

    int PointerId;
    Vector2 Position;
    Vector2 PositionDelta;

    // methods

    MouseModel(int pointerId);
    void OnEndOfFrame();
    ButtonModel GetMouseButtonModel(int button);
    ButtonModel GetLeftButtonModel();
    ButtonModel GetRightButtonModel();
    ButtonModel GetMiddleButtonModel();
    void CopyToEventData(PointerEventData eventData);
    void CopyFromEventData(PointerEventData eventData);
};

Detailed Documentation¶

A model for a mouse input device.

Fields¶

Vector2 ScrollDelta

The scroll since the last frame.

GameObject PointerEnter

The gameobject that received the OnPointerEnter.

Properties¶

int PointerId

Gets the pointer id.

Vector2 Position

Gets or sets the screen pixel-space coords.

Vector2 PositionDelta

Gets the movement in pixel-space since last frame.

Methods¶

void CopyToEventData(PointerEventData eventData)

Copies the mouse button data to the pointer event data.

Parameters:

void CopyFromEventData(PointerEventData eventData)

Copies the mouse data from the pointer event data to the mouse and mouse button models.

Parameters: