Class Entity3D<TEventMap, TUserData>

Base class for any Entity that displays 3D objects.

Subclasses must call onObjectCreated when creating new Object3D, before adding them to the scene

Type Parameters

TEventMap extends Entity3DEventMap = Entity3DEventMap
TUserData = EntityUserData

Hierarchy (view full)

Entity<TEventMap & Entity3DEventMap, TUserData>
- Entity3D

Implements

Constructors

constructor

new Entity3D<TEventMap, TUserData>(object3d): Entity3D<TEventMap, TUserData>
Creates a Entity3D with the specified parameters.
Type Parameters
- TEventMap extends Entity3DEventMap = Entity3DEventMap
- TUserData = EntityUserData
Parameters
- object3d: Object3D<Object3DEventMap>
  the root Three.js of this entity
Returns Entity3D<TEventMap, TUserData>
Overrides Entity.constructor
- Defined in entities/Entity3D.ts:72

Properties

`Protected`_distance

_distance: {
max: number;
min: number;
}

`Readonly`id

id: string

The unique identifier of this entity.

`Readonly`isEntity

isEntity: boolean = ...

Read-only flag to check if a given object is of type Entity.

`Readonly`isEntity3D

isEntity3D: boolean = ...

Read-only flag to check if a given object is of type Entity3D.

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isPickable

isPickable = true

name

name: undefined | string

The name of this entity.

`Readonly`type

type: string = ...

The name of the type of this object.

`Readonly`userData

userData: TUserData

An object that can be used to store custom data about the Entity.

Accessors

clippingPlanes

get clippingPlanes(): null | Plane[]
Gets or sets the clipping planes set on this entity. Default is null (no clipping planes).

Note: custom entities must ensure that the materials and shaders used do support the clipping plane feature of three.js. Refer to the three.js documentation for more information.

Returns null | Plane[]
- Defined in entities/Entity3D.ts:171
set clippingPlanes(planes): void
Parameters
- planes: null | Plane[]
Returns void
- Defined in entities/Entity3D.ts:175

distance

get distance(): {
max: number;
min: number;
}
Returns {
max: number;
min: number;
}
- max: number
- min: number
- Defined in entities/Entity3D.ts:61

frozen

get frozen(): boolean
Gets or sets the frozen status of this entity. A frozen entity is still visible but will not be updated automatically.

Useful for debugging purposes.

Returns boolean
Inherited from Entity.frozen
- Defined in entities/Entity.ts:144
set frozen(v): void
Parameters
- v: boolean
Returns void
Inherited from Entity.frozen
- Defined in entities/Entity.ts:148

instance

get instance(): Instance
Returns Instance
Inherited from Entity.instance
- Defined in entities/Entity.ts:96

loading

get loading(): boolean
Gets whether this entity is currently loading data.

Returns boolean
Inherited from Entity.loading
- Defined in entities/Entity.ts:158

object3d

get object3d(): Object3D<Object3DEventMap>
Returns the root object of this entity.

Returns Object3D<Object3DEventMap>
- Defined in entities/Entity3D.ts:114

opacity

get opacity(): number
Gets or sets the opacity of this entity.

Returns number
- Defined in entities/Entity3D.ts:152
set opacity(v): void
Parameters
- v: number
Returns void
- Defined in entities/Entity3D.ts:156

progress

get progress(): number
Gets the current loading progress (between 0 and 1). Note: This property is only meaningful if loading is true.

Returns number
Inherited from Entity.progress
- Defined in entities/Entity.ts:167

ready

get ready(): boolean
Determine if this entity is ready to use.

Returns boolean
Inherited from Entity.ready
- Defined in entities/Entity.ts:92

renderOrder

get renderOrder(): number
Gets or sets the render order of this entity.

Returns number
- Defined in entities/Entity3D.ts:137
set renderOrder(v): void
Parameters
- v: number
Returns void
- Defined in entities/Entity3D.ts:141

visible

get visible(): boolean
Gets or sets the visibility of this entity. A non-visible entity will not be automatically updated.

Returns boolean
- Defined in entities/Entity3D.ts:122
set visible(v): void
Parameters
- v: boolean
Returns void
- Defined in entities/Entity3D.ts:126

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(TEventMap & Entity3DEventMap & EntityEventMap)[T], T, Entity3D<TEventMap, TUserData>>
  The function that gets called when the event is fired.
Returns void
Inherited from Entity.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52

`Protected`assignRenderOrder

assignRenderOrder(obj): void
Assigns the render order of this object.

This may be overriden to perform custom logic.
Parameters
- obj: Object3D<Object3DEventMap>
Returns void
- Defined in entities/Entity3D.ts:329

contains

contains(obj): boolean
Test whether this entity contains the given object.

The object may be a component of the entity, or a 3D object.
Parameters
- obj: unknown
  The object to test.
Returns boolean
true if the entity contains the object.
- Defined in entities/Entity3D.ts:342

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends string
Parameters
- event: BaseEvent<T> & (TEventMap & Entity3DEventMap & EntityEventMap)[T]
  The event that gets fired.
Returns void
Inherited from Entity.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

dispose(): void
Disposes this entity and all resources associated with it.

The default implementation of this method does nothing. You should implement it in your custom entities to handle any special logic of disposal.

For example: disposing materials, geometries, stopping HTTP requests, etc.

Returns void
Inherited from Entity.dispose
- Defined in entities/Entity.ts:330

filterChangeSources

filterChangeSources(updateSources): Set<unknown>
Filters what objects need to be updated, based on updatedSources. The returned objects are then passed to preUpdate and postUpdate.

Inherited classes should override shouldFullUpdate and shouldUpdate if they need to change this behavior.
Parameters
- updateSources: Set<unknown>
  Sources that triggered an update
Returns Set<unknown>
Set of objects to update
Inherited from Entity.filterChangeSources
- Defined in entities/Entity.ts:254

getBoundingBox

getBoundingBox(): null | Box3
Returns an approximated bounding box of this entity in the scene.

Returns null | Box3
the resulting bounding box, or null if it could not be computed.
- Defined in entities/Entity3D.ts:273

getMemoryUsage

getMemoryUsage(_context): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- _context: GetMemoryUsageContext
Returns void
Implementation of MemoryUsage.getMemoryUsage
- Defined in entities/Entity3D.ts:97

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(TEventMap & Entity3DEventMap & EntityEventMap)[T], T, Entity3D<TEventMap, TUserData>>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Entity.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:62

`Protected`isOwned

isOwned(obj): boolean
Returns true if this object belongs to this entity.
Parameters
- obj: unknown
  The object to test.
Returns boolean
- Defined in entities/Entity3D.ts:245

`Protected`notifyChange

notifyChange(source?): void
Notifies the parent instance that a change occured in the scene.
Parameters
- Optionalsource: unknown
Returns void
Inherited from Entity.notifyChange
- Defined in entities/Entity.ts:337

`Protected`onObjectCreated

onObjectCreated(obj): void
Applies entity-level setup on a new object.

Note: this method should be called from the subclassed entity to notify the parent class that a new 3D object has just been created, so that it can be setup with entity-wide parameters.
Parameters
- obj: Object3D<Object3DEventMap>
  The object to prepare.
Returns void
Example
```
// In the subclass
const obj = new Object3D();

// Notify the parent class
this.onObjectCreated(obj);
```
- Defined in entities/Entity3D.ts:309

onRenderingContextLost

onRenderingContextLost(options): void
Called when the rendering context has been lost.
Parameters
- options: {
  canvas: HTMLCanvasElement;
  }
  The options.
  - canvas: HTMLCanvasElement
Returns void
Implementation of RenderingContextHandler.onRenderingContextLost
- Defined in entities/Entity3D.ts:102

onRenderingContextRestored

onRenderingContextRestored(options): void
Called when the rendering context has been restored.
Parameters
- options: {
  canvas: HTMLCanvasElement;
  }
  The options.
  - canvas: HTMLCanvasElement
Returns void
Implementation of RenderingContextHandler.onRenderingContextRestored
- Defined in entities/Entity3D.ts:107

pick

pick(canvasCoords, options?): PickResult<unknown>[]
Picks objects from this entity.

Implementations must respect at least limit and filter options.
Parameters
- canvasCoords: Vector2
  Coordinates on the rendering canvas
- Optionaloptions: PickOptions
  Options
Returns PickResult<unknown>[]
Target
Implementation of Pickable.pick
- Defined in entities/Entity3D.ts:399

postUpdate

postUpdate(context, changeSources): void
Method called after Entity.update.
Parameters
- context: Context
  the update context.
- changeSources: Set<unknown>
  the objects that triggered an update step. This is useful to filter out unnecessary updates if no sources are relevant to this entity. For example, if one of the sources is a camera that moved during the previous frame, any entity that depends on the camera's field of view should be updated.
Returns void
Inherited from Entity.postUpdate
- Defined in entities/Entity.ts:317

`Protected`preprocess

preprocess(_opts): Promise<void>
Asynchronously preprocess the entity. This method may be overriden to perform any operation that must be done before the entity can be used in the scene, such as fetching metadata about a dataset, etc.
Parameters
- _opts: EntityPreprocessOptions
Returns Promise<void>
A promise that resolves when the entity is ready to be used.
Inherited from Entity.preprocess
- Defined in entities/Entity.ts:181

preUpdate

preUpdate(context, changeSources): null | unknown[]
This method is called just before update() to filter and select which elements should be actually updated. For example, in the case of complex entities made of a hierarchy of elements, the entire hierarchy may not need to be updated.

Use this method to optimize the update step by reducing the number of elements to process.

Note: if this functions returns nothing, update() will not be called.
Parameters
- context: Context
  the update context.
- changeSources: Set<unknown>
  the objects that triggered an update step. This is useful to filter out unnecessary updates if no sources are relevant to this entity. For example, if one of the sources is a camera that moved during the previous frame, any entity that depends on the camera's field of view should be updated.
Returns null | unknown[]
the elements to update during update().
Overrides Entity.preUpdate
- Defined in entities/Entity3D.ts:256

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<(TEventMap & Entity3DEventMap & EntityEventMap)[T], T, Entity3D<TEventMap, TUserData>>
  The listener function that gets removed.
Returns void
Inherited from Entity.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:72

`Protected`setupMaterial

setupMaterial(material): void
Applies entity-level setup on new object's material.

Subclasses can override this to setup custom logic, for instance if the entity can produce objects that are naturally transparent.
Parameters
- material: Material
  the material of the newly created object
Returns void
- Defined in entities/Entity3D.ts:286

shouldCheckForUpdate

shouldCheckForUpdate(): boolean
This method is called before update to check if the MainLoop should try to update this entity or not. For better performances, it should return false if the entity has no impact on the rendering (e.g. the element is not visible).

The inherited child can completely ignore this value if it makes sense.

Returns boolean
true if should check for update
Overrides Entity.shouldCheckForUpdate
- Defined in entities/Entity3D.ts:228

shouldFullUpdate

shouldFullUpdate(updateSource): boolean
This method is called at the beginning of the update step to determine if we should do a full render of the object. This should be the case if, for instance, the source is the camera.

You can override this depending on your needs. The inherited child should not ignore this value, it should do a boolean OR, e.g.: return super.shouldFullUpdate(updateSource) || this.contains(updateSource);
Parameters
- updateSource: unknown
  Source of change
Returns boolean
true if requires a full update of this object
Overrides Entity.shouldFullUpdate
- Defined in entities/Entity3D.ts:232

shouldUpdate

shouldUpdate(updateSource): boolean
This method is called at the beginning of the update step to determine if we should re-render updateSource. Not used when shouldFullUpdate returns true.

You can override this depending on your needs. The inherited child should not ignore this value, it should do a boolean OR, e.g.: return super.shouldUpdate(updateSource) || this.contains(updateSource);
Parameters
- updateSource: unknown
  Source of change
Returns boolean
true if requires an update of updateSource
Overrides Entity.shouldUpdate
- Defined in entities/Entity3D.ts:236

traverse

traverse(callback, root?): void
Traverses all objects in the hierarchy of this entity.
Parameters
- callback: ((arg0: Object3D<Object3DEventMap>) => void)
  The callback.
  - - (arg0): void
    - Parameters
      arg0: Object3D<Object3DEventMap>
      Returns void
- root: undefined | Object3D<Object3DEventMap> = undefined
  The traversal root. If undefined, the traversal starts at the root object of this entity.
Returns void
- Defined in entities/Entity3D.ts:393

traverseMaterials

traverseMaterials(callback, root?): void
Traverses all materials in the hierarchy of this entity.
Parameters
- callback: ((arg0: Material) => void)
  The callback.
  - - (arg0): void
    - Parameters
      arg0: Material
      Returns void
- root: undefined | Object3D<Object3DEventMap> = undefined
  The traversal root. If undefined, the traversal starts at the root object of this entity.
Returns void
- Defined in entities/Entity3D.ts:353

traverseMeshes

traverseMeshes(callback, root?): void
Traverses all meshes in the hierarchy of this entity.
Parameters
- callback: ((arg0: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>) => void)
  The callback.
  - - (arg0): void
    - Parameters
      arg0: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
      Returns void
- root: undefined | Object3D<Object3DEventMap> = undefined
  The raversal root. If undefined, the traversal starts at the root object of this entity.
Returns void
- Defined in entities/Entity3D.ts:376

update

update(context, element): undefined | null | unknown[]
Performs an update on an element of the entity.

Note: this method will be called for each element returned by preUpdate().
Parameters
- context: Context
  the update context. This is the same object that the entity whose update() is being called.
- element: unknown
  the element to update. This is one of the elements returned by preUpdate.
Returns undefined | null | unknown[]
New elements to update
Inherited from Entity.update
- Defined in entities/Entity.ts:302

updateClippingPlanes

updateClippingPlanes(): void
Updates the clipping planes of all objects under this entity.

Returns void
- Defined in entities/Entity3D.ts:222

updateOpacity

updateOpacity(): void
Updates the opacity of the entity. Note: this method can be overriden for custom implementations.

Returns void
- Defined in entities/Entity3D.ts:195

updateRenderOrder

updateRenderOrder(): void
Updates the render order of the entity. Note: this method can be overriden for custom implementations.

Returns void
- Defined in entities/Entity3D.ts:212

updateVisibility

updateVisibility(): void
Updates the visibility of the entity. Note: this method can be overriden for custom implementations.

Returns void
- Defined in entities/Entity3D.ts:186

Class Entity3D<TEventMap, TUserData>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Entity3D<TEventMap, TUserData>

Properties

Protected_distance

Readonlyid

ReadonlyisEntity

ReadonlyisEntity3D

ReadonlyisMemoryUsage

ReadonlyisPickable

name

Readonlytype

ReadonlyuserData

Accessors

clippingPlanes

Returns null | Plane[]

Parameters

Returns void

distance

Returns { max: number; min: number; }

max: number

min: number

frozen

Returns boolean

Parameters

Returns void

instance

Returns Instance

loading

Returns boolean

object3d

Returns Object3D<Object3DEventMap>

opacity

Returns number

Parameters

Returns void

progress

Returns number

ready

Returns boolean

renderOrder

Returns number

Parameters

Returns void

visible

Returns boolean

Parameters

Returns void

Methods

addEventListener

Type Parameters

Parameters

Returns void

ProtectedassignRenderOrder

Parameters

Returns void

contains

Parameters

Returns boolean

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

filterChangeSources

Parameters

Returns Set<unknown>

getBoundingBox

`Protected`_distance

`Readonly`id

`Readonly`isEntity

`Readonly`isEntity3D

`Readonly`isMemoryUsage

`Readonly`isPickable

`Readonly`type

`Readonly`userData

Returns {
max: number;
min: number;
}

`Protected`assignRenderOrder

`Protected`isOwned

`Protected`notifyChange

`Protected`onObjectCreated

`Protected`preprocess

`Protected`setupMaterial