MouseScreenObjectState Struct

Definition

The state of the mouse.

public struct MouseScreenObjectState

Calculates a new MouseScreenObjectState based on an IScreenObject and Mouse state.

public MouseScreenObjectState(IScreenObject? screenObject, Mouse mouseData)

screenObject IScreenObject
The screen object to process with the mouse state.

mouseData Mouse
The current mouse state.

The screen object used to create the mouse state.

public readonly IScreenObject? ScreenObject { get; }

The mouse data.

public readonly Mouse Mouse { get; }

The cell the mouse is over, from IScreenObject.

public ColoredGlyphBase? Cell { readonly get; init; }

The position of the Cell.

public Point CellPosition { readonly get; init; }

The position of the mouse on the IScreenObject, based on the WorldCellPosition and the position of the ScreenObject.

public Point SurfaceCellPosition { readonly get; init; }

A cell-based location of the mouse based on the screen, not the screen object.

public Point WorldCellPosition { readonly get; init; }

The mouse position in pixels on the screen object.

public Point SurfacePixelPosition { readonly get; init; }

Indicates that the mouse is within the bounds of ScreenObject.

public bool IsOnScreenObject { readonly get; init; }