Packagealternativa.engine3d.core.events
Classpublic class MouseEvent3D
InheritanceMouseEvent3D Inheritance Event3D Inheritance flash.events.Event

Event MouseEvent3D dispatches by Object3D, in cases when MouseEvent dispatches by DisplayObject.



Public Properties
 PropertyDefined By
  altKey : Boolean
Indicates whether the Alt key is active (true) or inactive (false).
MouseEvent3D
 Inheritedbubbles : Boolean
[override] [read-only] Indicates whether an event is a bubbling event.
Event3D
  buttonDown : Boolean
Indicates whether the main mouse button is active (true) or inactive (false).
MouseEvent3D
  ctrlKey : Boolean
On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
MouseEvent3D
 InheritedcurrentTarget : Object
[override] [read-only] The object that is actively processing the Event object with an event listener.
Event3D
  delta : int
Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.
MouseEvent3D
 InheritedeventPhase : uint
[override] [read-only] The current phase in the event flow.
Event3D
  localX : Number
X coordinate of the event at local target object's space.
MouseEvent3D
  localY : Number
Y coordinate of the event at local target object's space.
MouseEvent3D
  localZ : Number
Z coordinate of the event at local target object's space.
MouseEvent3D
  relatedObject : Object3D
A reference to an object that is related to the event.
MouseEvent3D
  shiftKey : Boolean
Indicates whether the Shift key is active (true) or inactive (false).
MouseEvent3D
  surface : Surface
[read-only] Surface on which event has been received.
MouseEvent3D
 Inheritedtarget : Object
[override] [read-only] The event target.
Event3D
Public Methods
 MethodDefined By
  
MouseEvent3D(type:String, bubbles:Boolean = true, localX:Number, localY:Number, localZ:Number, relatedObject:Object3D = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0)
Creates a MouseEvent3D object.
MouseEvent3D
  
clone():Event
[override] Duplicates an instance of an Event subclass.
MouseEvent3D
 Inherited
[override] Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event3D
 Inherited
[override] Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event3D
  
toString():String
[override] Returns a string containing all the properties of the MouseEvent3D object.
MouseEvent3D
Public Constants
 ConstantDefined By
 InheritedADDED : String = added3D
[static] Defines the value of the type property of a added event object.
Event3D
  CLICK : String = click3D
[static] Defines the value of the type property of a click3D event object.
MouseEvent3D
  DOUBLE_CLICK : String = doubleClick3D
[static] Defines the value of the type property of a doubleClick3D event object.
MouseEvent3D
  MIDDLE_CLICK : String = middleClick3D
[static] Defines the value of the type property of a middleClick3D event object.
MouseEvent3D
  MIDDLE_MOUSE_DOWN : String = middleMouseDown3D
[static] Defines the value of the type property of a middleMouseDown3D event object.
MouseEvent3D
  MIDDLE_MOUSE_UP : String = middleMouseUp3D
[static] Defines the value of the type property of a middleMouseUp3D event object.
MouseEvent3D
  MOUSE_DOWN : String = mouseDown3D
[static] Defines the value of the type property of a mouseDown3D event object.
MouseEvent3D
  MOUSE_MOVE : String = mouseMove3D
[static] Defines the value of the type property of a mouseMove3D event object.
MouseEvent3D
  MOUSE_OUT : String = mouseOut3D
[static] Defines the value of the type property of a mouseOut3D event object.
MouseEvent3D
  MOUSE_OVER : String = mouseOver3D
[static] Defines the value of the type property of a mouseOver3D event object.
MouseEvent3D
  MOUSE_UP : String = mouseUp3D
[static] Defines the value of the type property of a mouseUp3D event object.
MouseEvent3D
  MOUSE_WHEEL : String = mouseWheel3D
[static] Defines the value of the type property of a mouseWheel3D event object.
MouseEvent3D
 InheritedREMOVED : String = removed3D
[static] Defines the value of the type property of a removed event object.
Event3D
  RIGHT_CLICK : String = rightClick3D
[static] Defines the value of the type property of a rightClick3D event object.
MouseEvent3D
  RIGHT_MOUSE_DOWN : String = rightMouseDown3D
[static] Defines the value of the type property of a rightMouseDown3D event object.
MouseEvent3D
  RIGHT_MOUSE_UP : String = rightMouseUp3D
[static] Defines the value of the type property of a rightMouseUp3D event object.
MouseEvent3D
  ROLL_OUT : String = rollOut3D
[static] Defines the value of the type property of a rollOut3D event object.
MouseEvent3D
  ROLL_OVER : String = rollOver3D
[static] Defines the value of the type property of a rollOver3D event object.
MouseEvent3D
Property Detail
altKeyproperty
public var altKey:Boolean

Indicates whether the Alt key is active (true) or inactive (false).

buttonDownproperty 
public var buttonDown:Boolean

Indicates whether the main mouse button is active (true) or inactive (false).

ctrlKeyproperty 
public var ctrlKey:Boolean

On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). On Macintosh, indicates whether either the Control key or the Command key is activated.

deltaproperty 
public var delta:int

Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.

localXproperty 
public var localX:Number

X coordinate of the event at local target object's space.

localYproperty 
public var localY:Number

Y coordinate of the event at local target object's space.

localZproperty 
public var localZ:Number

Z coordinate of the event at local target object's space.

relatedObjectproperty 
public var relatedObject:Object3D

A reference to an object that is related to the event. This property applies to the mouseOut, mouseOver, rollOut и rollOver. For example, when mouseOut occurs, relatedObject point to the object over which mouse cursor placed now.

shiftKeyproperty 
public var shiftKey:Boolean

Indicates whether the Shift key is active (true) or inactive (false).

surfaceproperty 
surface:Surface  [read-only]

Surface on which event has been received. The object that owns the surface, can differs from the target event.


Implementation
    public function get surface():Surface
Constructor Detail
MouseEvent3D()Constructor
public function MouseEvent3D(type:String, bubbles:Boolean = true, localX:Number, localY:Number, localZ:Number, relatedObject:Object3D = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0)

Creates a MouseEvent3D object.

Parameters
type:String — Type.
 
bubbles:Boolean (default = true) — Indicates whether an event is a bubbling event.
 
localX:Number (default = NaN) — Y coordinate of the event at local target object's space.
 
localY:Number (default = NaN) — X coordinate of the event at local target object's space.
 
localZ:Number (default = NaN) — Z coordinate of the event at local target object's space.
 
relatedObject:Object3D (default = null)Object3D, eelated to the MouseEvent3D.
 
ctrlKey:Boolean (default = false) — Indicates whether the Alt key is active.
 
altKey:Boolean (default = false) — Indicates whether the Control key is active.
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key is active.
 
buttonDown:Boolean (default = false) — Indicates whether the main mouse button is active .
 
delta:int (default = 0) — Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.
Method Detail
clone()method
override public function clone():Event

Duplicates an instance of an Event subclass. Returns a new MouseEvent3D object that is a copy of the original instance of the Event object.

Returns
Event — A new MouseEvent3D object that is identical to the original.
toString()method 
override public function toString():String

Returns a string containing all the properties of the MouseEvent3D object.

Returns
String — A string containing all the properties of the MouseEvent3D object
Constant Detail
CLICKConstant
public static const CLICK:String = click3D

Defines the value of the type property of a click3D event object.

DOUBLE_CLICKConstant 
public static const DOUBLE_CLICK:String = doubleClick3D

Defines the value of the type property of a doubleClick3D event object.

MIDDLE_CLICKConstant 
public static const MIDDLE_CLICK:String = middleClick3D

Defines the value of the type property of a middleClick3D event object.

MIDDLE_MOUSE_DOWNConstant 
public static const MIDDLE_MOUSE_DOWN:String = middleMouseDown3D

Defines the value of the type property of a middleMouseDown3D event object.

MIDDLE_MOUSE_UPConstant 
public static const MIDDLE_MOUSE_UP:String = middleMouseUp3D

Defines the value of the type property of a middleMouseUp3D event object.

MOUSE_DOWNConstant 
public static const MOUSE_DOWN:String = mouseDown3D

Defines the value of the type property of a mouseDown3D event object.

MOUSE_MOVEConstant 
public static const MOUSE_MOVE:String = mouseMove3D

Defines the value of the type property of a mouseMove3D event object.

MOUSE_OUTConstant 
public static const MOUSE_OUT:String = mouseOut3D

Defines the value of the type property of a mouseOut3D event object.

MOUSE_OVERConstant 
public static const MOUSE_OVER:String = mouseOver3D

Defines the value of the type property of a mouseOver3D event object.

MOUSE_UPConstant 
public static const MOUSE_UP:String = mouseUp3D

Defines the value of the type property of a mouseUp3D event object.

MOUSE_WHEELConstant 
public static const MOUSE_WHEEL:String = mouseWheel3D

Defines the value of the type property of a mouseWheel3D event object.

RIGHT_CLICKConstant 
public static const RIGHT_CLICK:String = rightClick3D

Defines the value of the type property of a rightClick3D event object.

RIGHT_MOUSE_DOWNConstant 
public static const RIGHT_MOUSE_DOWN:String = rightMouseDown3D

Defines the value of the type property of a rightMouseDown3D event object.

RIGHT_MOUSE_UPConstant 
public static const RIGHT_MOUSE_UP:String = rightMouseUp3D

Defines the value of the type property of a rightMouseUp3D event object.

ROLL_OUTConstant 
public static const ROLL_OUT:String = rollOut3D

Defines the value of the type property of a rollOut3D event object.

ROLL_OVERConstant 
public static const ROLL_OVER:String = rollOver3D

Defines the value of the type property of a rollOver3D event object.