View source

class MouseEvent3D

package away3d.events

extends Event

@:directlyUsed

Available on all platforms

A MouseEvent3D is dispatched when a mouse event occurs over a mouseEnabled object in View3D. todo: we don't have screenZ data, tho this should be easy to implement

Static variables

@:value("click3d")staticinlineread onlyCLICK:String = "click3d"

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

@:value("doubleClick3d")staticinlineread onlyDOUBLE_CLICK:String = "doubleClick3d"

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

@:value("mouseDown3d")staticinlineread onlyMOUSE_DOWN:String = "mouseDown3d"

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

@:value("mouseMove3d")staticinlineread onlyMOUSE_MOVE:String = "mouseMove3d"

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

@:value("mouseOut3d")staticinlineread onlyMOUSE_OUT:String = "mouseOut3d"

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

@:value("mouseOver3d")staticinlineread onlyMOUSE_OVER:String = "mouseOver3d"

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

@:value("mouseUp3d")staticinlineread onlyMOUSE_UP:String = "mouseUp3d"

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

@:value("mouseWheel3d")staticinlineread onlyMOUSE_WHEEL:String = "mouseWheel3d"

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

Constructor

new(type:String)

Create a new MouseEvent3D object.

Parameters:

type

The type of the MouseEvent3D.

Variables

altKey:Bool

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

ctrlKey:Bool

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

delta:Int

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

index:Int

The index of the face where the event took place.

localNormal:Vector3D

The normal in object space where the event took place

localPosition:Vector3D

The position in object space where the event took place

material:MaterialBase

The material of the 3d element inside which the event took place.

object:ObjectContainer3D

The 3d object inside which the event took place.

renderable:IRenderable

The renderable inside which the event took place.

read onlysceneNormal:Vector3D

read onlyscenePosition:Vector3D

screenX:Float

The horizontal coordinate at which the event occurred in view coordinates.

screenY:Float

The vertical coordinate at which the event occurred in view coordinates.

shiftKey:Bool

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

subGeometryIndex:Int

The index of the subGeometry where the event took place.

uv:Point

The uv coordinate inside the draw primitive where the event took place.

view:View3D

The view object inside which the event took place.

Methods

clone():Event

Creates a copy of the MouseEvent3D object and sets the value of each property to match that of the original.

@:value({ v : null })getSceneNormal(?v:Vector3D):Vector3D

The normal in scene space where the event took place @return

Parameters:

v

destination Vector3D

@:value({ v : null })getScenePosition(?v:Vector3D):Vector3D

The position in scene space where the event took place @return

Parameters:

v

destination Vector3D

stopImmediatePropagation():Void

@inheritDoc

stopPropagation():Void

@inheritDoc