A3DGE - Amateur 3D Game Engine
Class TMouse
Unit
Declaration
type TMouse = class(TObject)
Description
Encapsulates mouse input.
Hierarchy
- TObject
- TMouse
Overview
Methods
 |
constructor Create; |
|
DESTRUCTOR Destroy; override; |
|
procedure ShowCursor; inline; |
|
procedure HideCursor; inline; |
|
function GetState: ALLEGRO_MOUSE_STATE; inline; |
|
procedure GetCursorPos (out aX, aY: Integer); inline; |
|
procedure SetCursor ( aCursor: ALLEGRO_BITMAPptr; aXFocus, aYFocus: Integer ); |
|
procedure SetCursorPos (const aX, aY: Integer); inline; |
|
procedure WarpMouse; inline; |
Properties
|
property NumButtons: Integer read GetNumButtons; |
|
property InDisplay: Boolean read fInDisplay; |
|
property OnButtonClick: TMouseNotifyEvent
read fOnButtonClick write fOnButtonClick; |
|
property OnButtonUp: TMouseNotifyEvent
read fOnButtonUp write fOnButtonUp; |
|
property OnMove: TMouseNotifyEvent read fOnMove write fOnMove; |
|
property OnOutDisplay: TNotifyEvent
read fOnOutDisplay write fOnOutDisplay; |
|
property OnInDisplay: TNotifyEvent
read fOnInDisplay write fOnInDisplay; |
Description
Methods
|
constructor Create; |
|
Constructor. | |
|
DESTRUCTOR Destroy; override; |
|
Destructor. | |
|
procedure ShowCursor; inline; |
|
Show mouse cursor. | |
|
procedure HideCursor; inline; |
|
Hide mouse cursor. | |
|
function GetState: ALLEGRO_MOUSE_STATE; inline; |
|
Returns current mouse state. | |
|
procedure GetCursorPos (out aX, aY: Integer); inline; |
|
Get current mouse coordinates. | |
|
procedure SetCursor ( aCursor: ALLEGRO_BITMAPptr; aXFocus, aYFocus: Integer ); |
|
Set cursor bitmap. | |
|
procedure SetCursorPos (const aX, aY: Integer); inline; |
|
Set cursor position. | |
|
procedure WarpMouse; inline; |
|
Moves cursor to display center. | |
Properties
|
property NumButtons: Integer read GetNumButtons; |
|
How many buttons has the mouse. | |
|
property InDisplay: Boolean read fInDisplay; |
|
Is mouse cursor inside the display. | |
|
property OnButtonClick: TMouseNotifyEvent
read fOnButtonClick write fOnButtonClick; |
|
Event triggered when a mouse button is pressed. | |
|
property OnButtonUp: TMouseNotifyEvent
read fOnButtonUp write fOnButtonUp; |
|
Event triggered when a mouse button is released. | |
|
property OnMove: TMouseNotifyEvent read fOnMove write fOnMove; |
|
Event triggered when mouse moved. | |
|
property OnOutDisplay: TNotifyEvent
read fOnOutDisplay write fOnOutDisplay; |
|
Event triggered when mouse moves out of the display. | |
|
property OnInDisplay: TNotifyEvent
read fOnInDisplay write fOnInDisplay; |
|
Event triggered when mouse moves inside of the display. | |
Generated by PasDoc 0.15.0. Generated on 2025-07-31 11:41:01.