PowerUI.MouseEvent Class Reference
Inheritance diagram for PowerUI.MouseEvent:
PowerUI.UIEvent Dom.Event PowerUI.PointerEvent

Public Member Functions

 MouseEvent ()
 
 MouseEvent (float x, float y, int button, bool down)
 
 MouseEvent (string type, object init)
 
- Public Member Functions inherited from PowerUI.UIEvent
bool getModifierState (string keyArg)
 Gets the modifier state for the given key. More...
 
 UIEvent ()
 An empty UI event. More...
 
 UIEvent (string type)
 Creates an event for the given type. More...
 
 UIEvent (string type, bool bubbles)
 Creates an event for the given type. More...
 
 UIEvent (string type, bool bubbles, bool cancelable)
 Creates an event for the given type. More...
 
 UIEvent (float x, float y, bool down)
 Creates a new UI event for the mouse. More...
 
 UIEvent (int key, char ch, bool down)
 Creates a new UI event for a keypress. More...
 
 UIEvent (string type, object init)
 
void SetModifiers ()
 Sets up the Modifiers property from the current Unity event allowing things like capsLock to work. More...
 
Css.ComputedStyle getComputedStyle ()
 Gets the target computed style. More...
 
- Public Member Functions inherited from Dom.Event
 Event ()
 
 Event (string type)
 
 Event (string type, object init)
 
virtual void Reset ()
 Reset an event so it can be reused. Doesn't affect bubbles/ trusted etc. More...
 
void initEvent (string type, bool bubb, bool canc)
 used to initialize the value of an event created using Document.createEvent() More...
 
virtual void Setup (object init)
 Sets up the init dictionary. Note that it can be null. More...
 
void stopPropagation ()
 Stops the event bubbling to any other elements. More...
 
void stopImmediatePropagation ()
 Stops the event bubbling to any other elements. More...
 
EventTarget[] deepPath ()
 The deep path of this event. (Unclear working draft spec; subject to change). http://w3c.github.io/webcomponents/spec/shadow/#widl-Event-deepPath-sequence-EventTarget More...
 
void preventDefault ()
 Stops the default event handler occuring. More...
 
void initUIEvent (string type, bool canBubble, bool cancelable, PowerUI.Window view, ulong detail)
 Sets up this UIEvent. More...
 

Properties

bool raySuccess [get]
 True if rayHit was successful and hit something. More...
 
RaycastHit rayHit [get]
 The raycast hit that was sent into the scene whilst looking for WorldUI's. It's default(RaycastHit) if it didn't hit anything (see raySuccess). More...
 
override int which [get]
 
float screenX [get]
 Screen x coordinate. More...
 
float screenY [get]
 Screen y coordinate. More...
 
float pageX [get]
 X coordinate relative to the page (accounts for scrolling too). More...
 
float pageY [get]
 Y coordinate relative to the page (accounts for scrolling too). More...
 
- Properties inherited from PowerUI.UIEvent
bool repeat [get]
 True if this event is repeating. More...
 
string code [get]
 The keycode as text. More...
 
string key [get]
 The keycode. More...
 
bool modifierFn [get]
 Is this an fn button? More...
 
bool capsLock [get]
 Is caps lock on? More...
 
bool metaKey [get]
 Is a meta key (Windows key/ the Mac key etc) down? More...
 
bool altKey [get]
 Is an alt key down? More...
 
bool ctrlKey [get]
 Is a control key down? More...
 
bool shiftKey [get]
 Is a shift key down? More...
 
PowerUI.Window view [get]
 The view the event came from. More...
 
HtmlElement htmlTarget [get]
 A convenience shortcut to save casting 'target' to a HtmlElement. It's like this because SVG can also generate events. More...
 
KeyCode unityKeyCode [get]
 Gets the keycode as a UnityEngine.KeyCode. More...
 
bool leftMouseDown [get]
 Is the left mouse button currently down? More...
 
bool rightMouseDown [get]
 Is the right mouse button currently down? More...
 
virtual int which [get]
 
HtmlDocument htmlDocument [get]
 The HTML document that this event has come from, if any. More...
 
WorldUI worldUI [get]
 The WorldUI that this event has come from, if any. More...
 
float relativeX [get]
 A 0-1 value of where this event occured relative to the target element. 0 is left edge, 1 is right edge. More...
 
float relativeY [get]
 A 0-1 value of where this event occured relative to the target element. 0 is top edge, 1 is bottom edge. More...
 
double x [get]
 Alias for clientX. More...
 
double y [get]
 Alias for clientY. More...
 
double offsetX [get]
 X Position relative to the parent. More...
 
double offsetY [get]
 Y Position relative to the parent. More...
 
float localX [get]
 The position of the event relative to the top left corner of the target element in pixels. More...
 
float localY [get]
 The position of the event relative to the top left corner of the target element in pixels. More...
 
- Properties inherited from Dom.Event
bool cancelBubble [get, set]
 Set to true if you do not want this event to bubble any further. More...
 
bool isTrusted [get]
 True if this was created by the UA. Use isTrusted. More...
 
string type [get, set]
 The type of this event. More...
 
Node srcElement [get]
 The node that was clicked on or focused. More...
 
bool defaultPrevented [get]
 True if the default has been prevented. More...
 
DateTime timeStamp [get]
 Current time of this event. More...
 
string char [get]
 The printable character if it is one. More...
 
int button [get]
 The mouse button that was pressed. See isLeftMouse and isRightMouse for clearer ways of using this value. More...
 
bool isLeftMouse [get]
 Mouseup/down only. Was it the left mouse button? More...
 
bool isRightMouse [get]
 Mouseup/down only. Was it the right mouse button? More...
 
Document document [get]
 The document that this event has come from, if any. More...
 
Windows.Window sparkWindow [get]
 The window that the currentTarget of the event is in. More...
 

Additional Inherited Members

- Public Attributes inherited from PowerUI.UIEvent
UnityEngine.Event unityEvent
 The source Unity event if there is one. More...
 
InputPointer trigger
 The pointer that triggered this event. More...
 
EventTarget relatedTarget
 A related target, if there is one. More...
 
- Package Functions inherited from Dom.Event
void SetTrusted ()
 
void SetTrusted (bool bubbles)
 
- Package Attributes inherited from Dom.Event
string EventType
 The type of this event. Only set if you directly use the UIEvent(type) constructor. See type instead. More...
 
bool _Cancelled
 True if this event has been cancelled via preventDefault. More...
 
bool _CancelImmediate
 True if this has been immediately cancelled. More...
 
bool _IsTrusted
 True if this was created by the UA. Use isTrusted. More...
 

Constructor & Destructor Documentation

PowerUI.MouseEvent.MouseEvent ( )
inline
PowerUI.MouseEvent.MouseEvent ( float  x,
float  y,
int  button,
bool  down 
)
inline
PowerUI.MouseEvent.MouseEvent ( string  type,
object  init 
)
inline

Property Documentation

float PowerUI.MouseEvent.pageX
get

X coordinate relative to the page (accounts for scrolling too).

float PowerUI.MouseEvent.pageY
get

Y coordinate relative to the page (accounts for scrolling too).

RaycastHit PowerUI.MouseEvent.rayHit
get

The raycast hit that was sent into the scene whilst looking for WorldUI's. It's default(RaycastHit) if it didn't hit anything (see raySuccess).

bool PowerUI.MouseEvent.raySuccess
get

True if rayHit was successful and hit something.

float PowerUI.MouseEvent.screenX
get

Screen x coordinate.

float PowerUI.MouseEvent.screenY
get

Screen y coordinate.

override int PowerUI.MouseEvent.which
get