Daikon Forge GUI  v1.0.16
Daikon Forge user interface library for Unity
 All Classes Functions Variables Enumerations Enumerator Properties Events Pages
dfMouseEventArgs Class Reference

Encapsulates data for the MouseUp, MouseDown, and MouseMove events. More...

Inheritance diagram for dfMouseEventArgs:
dfControlEventArgs dfTouchEventArgs

Detailed Description

Encapsulates data for the MouseUp, MouseDown, and MouseMove events.

Public Member Functions

 dfMouseEventArgs (dfControl Source, dfMouseButtons button, int clicks, Ray ray, Vector2 location, float wheel)
 Initializes a new instance of the dfMouseEventArgs class. More...
 
 dfMouseEventArgs (dfControl Source)
 
- Public Member Functions inherited from dfControlEventArgs
void Use ()
 Set by an event subscriber to indicate that the mouse event has been processed. If not called by an event subscriber, then the event will be "bubbled" up to the parent for additional processing. More...
 

Properties

dfMouseButtons Buttons [get, set]
 Gets which mouse button was pressed. More...
 
int Clicks [get, set]
 Gets the number of times the mouse button was pressed and released. More...
 
Vector2 MoveDelta [get, set]
 Returns how much the mouse was moved since the last time the mouse was polled More...
 
Vector2 Position [get, set]
 Gets the location of the mouse during the generating mouse event. More...
 
Ray Ray [get, set]
 Returns the Ray that was used to raycast during the mouse event More...
 
float WheelDelta [get, set]
 Gets a signed currentIndex of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel. More...
 
- Properties inherited from dfControlEventArgs
dfControl Source [get, set]
 The dfControl instance that this event was originally generated for More...
 
bool Used [get, set]
 Indicates whether this event has already been processed by an event subscriber More...
 

Constructor & Destructor Documentation

dfMouseEventArgs.dfMouseEventArgs ( dfControl  Source,
dfMouseButtons  button,
int  clicks,
Ray  ray,
Vector2  location,
float  wheel 
)

Initializes a new instance of the dfMouseEventArgs class.

Parameters
SourceThe dfControl that originally received this event notification
buttonOne of the dfMouseButtons values indicating which mouse button was pressed.
clicksThe number of times a mouse button was pressed.
rayThe Ray from the screen mouse location through the Source control
locationThe screen coordinates of a mouse click, in pixels.
wheelA signed currentIndex of the number of detents the wheel has rotated.
dfMouseEventArgs.dfMouseEventArgs ( dfControl  Source)

Property Documentation

dfMouseButtons dfMouseEventArgs.Buttons
getset

Gets which mouse button was pressed.

int dfMouseEventArgs.Clicks
getset

Gets the number of times the mouse button was pressed and released.

Vector2 dfMouseEventArgs.MoveDelta
getset

Returns how much the mouse was moved since the last time the mouse was polled

Vector2 dfMouseEventArgs.Position
getset

Gets the location of the mouse during the generating mouse event.

Returns
A Vector2 containing the x- and y- coordinate of the mouse, in pixels, relative to the top-left corner of the screen
Ray dfMouseEventArgs.Ray
getset

Returns the Ray that was used to raycast during the mouse event

float dfMouseEventArgs.WheelDelta
getset

Gets a signed currentIndex of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel.