Class: MouseEventExt<T, R>
Events.MouseEventExt
Represents a custom extended mouse event.
Type parameters
| Name | Type | Description |
|---|---|---|
T | Object3D | The type of the primary target for the event (default is Object3D). |
R | Object3D | The type of the related target for the event (default is Object3D). |
Hierarchy
EventExt<T>↳
MouseEventExt
Constructors
constructor
• new MouseEventExt<T, R>(event, intersection, relatedTarget?, cancelable?)
Type parameters
| Name | Type |
|---|---|
T | Object3D<Object3DEventMap> |
R | Object3D<Object3DEventMap> |
Parameters
| Name | Type | Description |
|---|---|---|
event | MouseEvent | Original dom event. |
intersection | IntersectionExt | The intersection information between the mouse event and 3D objects in the scene. |
relatedTarget? | R | The secondary target for the event. |
cancelable? | boolean | A boolean value indicating whether the event is cancelable. |
Overrides
Defined in
Properties
cancelable
• Readonly cancelable: any
A boolean value indicating whether the event is cancelable.
Inherited from
Defined in
currentTarget
• currentTarget: T
A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent. It's possible this has been changed along the way through retargeting.
Inherited from
Defined in
domEvent
• Readonly domEvent: MouseEvent
Original dom event.
Defined in
intersection
• Readonly intersection: IntersectionExt
Returns the intersection information between the mouse event and 3D objects in the scene.
Defined in
relatedTarget
• Readonly relatedTarget: R
The secondary target for the event, if there is one.
Defined in
timeStamp
• Readonly timeStamp: number
The time at which the event was created (in milliseconds). By specification, this value is time since epoch—but in reality, browsers' definitions vary. In addition, work is underway to change this to be a DOMHighResTimeStamp instead.
Inherited from
Defined in
Accessors
altKey
• get altKey(): boolean
Returns true if the alt key was down when the mouse event was fired.
Returns
boolean
Defined in
bubbles
• get bubbles(): boolean
A boolean value indicating whether or not the event bubbles up through the DOM.
Returns
boolean
Inherited from
EventExt.bubbles
Defined in
button
• get button(): number
The button number that was pressed (if applicable) when the mouse event was fired.
Returns
number
Defined in
buttons
• get buttons(): number
The buttons being pressed (if any) when the mouse event was fired.
Returns
number
Defined in
clientX
• get clientX(): number
The X coordinate of the mouse pointer in local (DOM content) coordinates.
Returns
number
Defined in
clientY
• get clientY(): number
The Y coordinate of the mouse pointer in local (DOM content) coordinates.
Returns
number
Defined in
ctrlKey
• get ctrlKey(): boolean
Returns true if the control key was down when the mouse event was fired.
Returns
boolean
Defined in
defaultPrevented
• get defaultPrevented(): boolean
Indicates whether or not the call to event.preventDefault() canceled the event.
Returns
boolean
Inherited from
EventExt.defaultPrevented
Defined in
metaKey
• get metaKey(): boolean
Returns true if the meta key was down when the mouse event was fired.
Returns
boolean
Defined in
movementX
• get movementX(): number
The X coordinate of the pointer relative to the position of the last event.
Returns
number
Defined in
movementY
• get movementY(): number
The Y coordinate of the pointer relative to the position of the last event.
Returns
number
Defined in
offsetX
• get offsetX(): number
The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
Returns
number
Defined in
offsetY
• get offsetY(): number
The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
Returns
number
Defined in
pageX
• get pageX(): number
The X coordinate of the mouse pointer relative to the whole document.
Returns
number
Defined in
pageY
• get pageY(): number
The Y coordinate of the mouse pointer relative to the whole document.
Returns
number
Defined in
screenX
• get screenX(): number
The X coordinate of the mouse pointer in global (screen) coordinates.
Returns
number
Defined in
screenY
• get screenY(): number
The Y coordinate of the mouse pointer in global (screen) coordinates.
Returns
number
Defined in
shiftKey
• get shiftKey(): boolean
Returns true if the shift key was down when the mouse event was fired.
Returns
boolean
Defined in
target
• get target(): T
A reference to the object to which the event was originally dispatched.
Returns
T
Inherited from
EventExt.target
Defined in
type
• get type(): keyof MiscEvents | keyof InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity> | keyof UpdateEvents
The case-insensitive name identifying the type of the event.
Returns
keyof MiscEvents | keyof InteractionEvents<Object3D<Object3DEventMap>, Object3D<Object3DEventMap>, Object3D<Object3DEventMap> | InstancedMeshEntity> | keyof UpdateEvents
Inherited from
EventExt.type
Defined in
Methods
getModifierState
▸ getModifierState(keyArg): boolean
Returns the current state of the specified modifier key. See KeyboardEvent.getModifierState() for details.
Parameters
| Name | Type |
|---|---|
keyArg | string |
Returns
boolean
Defined in
preventDefault
▸ preventDefault(): void
Cancels the event.
Returns
void
Inherited from
Defined in
stopImmediatePropagation
▸ stopImmediatePropagation(): void
For this particular event, prevent all other listeners from being called. This includes listeners attached to the same element as well as those attached to elements that will be traversed later (during the capture phase, for instance).
Returns
void
Inherited from
EventExt.stopImmediatePropagation
Defined in
stopPropagation
▸ stopPropagation(): void
Stops the propagation of events further along in the Object3D hierarchy.
Returns
void