Skip to main content

Class: FocusEventExt<T, R>

Events.FocusEventExt

Represents a custom extended focus event.

Type parameters

NameTypeDescription
TObject3DThe type of the primary target for the event (default is Object3D).
RObject3DThe type of the related target for the event (default is Object3D).

Hierarchy

Constructors

constructor

new FocusEventExt<T, R>(relatedTarget)

Type parameters

NameType
TObject3D<Object3DEventMap>
RObject3D<Object3DEventMap>

Parameters

NameTypeDescription
relatedTargetRThe secondary target for the event.

Overrides

EventExt.constructor

Defined in

src/events/Events.ts:361

Properties

cancelable

Readonly cancelable: any

A boolean value indicating whether the event is cancelable.

Inherited from

EventExt.cancelable

Defined in

src/events/Events.ts:116


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

EventExt.currentTarget

Defined in

src/events/Events.ts:118


relatedTarget

relatedTarget: R

The secondary target for the event.

Defined in

src/events/Events.ts:356


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

EventExt.timeStamp

Defined in

src/events/Events.ts:124

Accessors

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

src/events/Events.ts:114


defaultPrevented

get defaultPrevented(): boolean

Indicates whether or not the call to event.preventDefault() canceled the event.

Returns

boolean

Inherited from

EventExt.defaultPrevented

Defined in

src/events/Events.ts:120


target

get target(): T

A reference to the object to which the event was originally dispatched.

Returns

T

Inherited from

EventExt.target

Defined in

src/events/Events.ts:122


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

src/events/Events.ts:126

Methods

preventDefault

preventDefault(): void

Cancels the event.

Returns

void

Inherited from

EventExt.preventDefault

Defined in

src/events/Events.ts:142


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

src/events/Events.ts:147


stopPropagation

stopPropagation(): void

Stops the propagation of events further along in the Object3D hierarchy.

Returns

void

Inherited from

EventExt.stopPropagation

Defined in

src/events/Events.ts:152