Skip to main content

Class: EventExt<T>

Events.EventExt

Represents a custom extended event.

Type parameters​

NameType
TObject3D

Hierarchy​

Constructors​

constructor​

• new EventExt<T>(cancelable?)

Type parameters​

NameType
TObject3D<Object3DEventMap>

Parameters​

NameTypeDefault valueDescription
cancelablebooleanfalseA boolean value indicating whether the event is cancelable.

Defined in​

src/events/Events.ts:137

Properties​

cancelable​

• Readonly cancelable: any

A boolean value indicating whether the event is 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.

Defined in​

src/events/Events.ts:118

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.

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

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

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

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

Defined in​

src/events/Events.ts:126

Methods​

preventDefault​

▸ preventDefault(): void

Cancels the event.

Returns​

void

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

Defined in​

src/events/Events.ts:147

stopPropagation​

▸ stopPropagation(): void

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

Returns​

void

Defined in​

src/events/Events.ts:152