cohtml.InputSystem.MouseEvent
A class storing mouse input event.
Inherits from cohtml.InputSystem.PointerEvent, IMouseEventData, cohtml.InputSystem.InputEvent, cohtml.InputSystem.IViewSendable
Public Functions
| Name | |
|---|---|
| virtual override void | Send(CohtmlView view) Sends the mouse event to a CohtmlView component. |
| MouseEventData | SetNativePosition(Vector2Int position) Sets the X and Y coordinate of the events position. |
Public Properties
| Name | |
|---|---|
| override EventType | PointerEventType Returns the pointer event type. |
| MouseEventData.EventType | Type The event type of this mouse event. |
| MouseEventData.MouseButton | Button The button that the user interacted with for this mouse event. |
| float | WheelX The X coordinate of the mouse scroll for this mouse event. |
| float | WheelY The Y coordinate of the mouse scroll for this mouse event. |
| int | DeltaX The X coordinate of the difference between the current and previous event position. |
| int | DeltaY The Y coordinate of the difference between the current and previous event position. |
| EventModifiersState | Modifiers The key modifiers of this mouse event. |
| EventMouseModifiersState | MouseModifiers The mouse key modifiers of this mouse event. |
Additional inherited members
Public Types inherited from cohtml.InputSystem.PointerEvent
| Name | |
|---|---|
| enum class | EventType { Up, Down, Move} The type of the pointer event. |
Public Functions inherited from cohtml.InputSystem.PointerEvent
| Name | |
|---|---|
| void | AddView(CohtmlView view, Vector2Int position) Temporarily stores the CohtmlView component and the position where the event happened. |
| Vector2Int | GetViewPosition(CohtmlView view) Returns the position of the event that hit a CohtmlView. |
| void | RemoveView(CohtmlView view) Removes the CohtmlView from the temporary collection of events that happened. |
| void | ClearViews() Clears the collection of CohtmlView components hit by this event. |
Public Properties inherited from cohtml.InputSystem.PointerEvent
| Name | |
|---|---|
| Vector2Int | Position The position of the pointer event. |
| int | X The X coordinate of the events position. |
| int | Y The Y coordinate of the events position. |
Public Functions inherited from cohtml.InputSystem.InputEvent
| Name | |
|---|---|
| void | Dispose() |
Public Functions Documentation
function Send
virtual override void Send(
CohtmlView view
)
Sends the mouse event to a CohtmlView component.
Parameters:
- view The CohtmlView component to receive the event.
Reimplements: cohtml.InputSystem.InputEvent.Send
function SetNativePosition
MouseEventData SetNativePosition(
Vector2Int position
)
Sets the X and Y coordinate of the events position.
Parameters:
- position The event position in screen space coordinates.
Public Property Documentation
property PointerEventType
override EventType PointerEventType;
Returns the pointer event type.
property Type
MouseEventData.EventType Type;
The event type of this mouse event.
property Button
MouseEventData.MouseButton Button;
The button that the user interacted with for this mouse event.
property WheelX
float WheelX;
The X coordinate of the mouse scroll for this mouse event.
property WheelY
float WheelY;
The Y coordinate of the mouse scroll for this mouse event.
property DeltaX
int DeltaX;
The X coordinate of the difference between the current and previous event position.
property DeltaY
int DeltaY;
The Y coordinate of the difference between the current and previous event position.
property Modifiers
EventModifiersState Modifiers;
The key modifiers of this mouse event.
property MouseModifiers
EventMouseModifiersState MouseModifiers;
The mouse key modifiers of this mouse event.