Class AxisGrid<UserData>

Create a 3D axis grid. This is represented as a box volume where each side of the box is itself a grid.

// Create a 200x200 meters extent
const extent = new Extent('EPSG:3857', -100, +100, -100, +100);

// Create an AxisGrid on this extent, with the grid floor at zero meters,
// and the grid ceiling at 2500 meters.
//
// Display a tick (grid line), every 10 meters on the horizontal axes,
// and every 50 meters on the vertical axis.
const grid = new AxisGrid({
  volume: {
      extent,
      floor: 0,
      ceiling: 2500,
  },
  origin: TickOrigin.Relative,
  ticks: {
      x: 10,
      y: 10,
      z: 50,
  },
});

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

_distance id isAxisGrid isEntity isEntity3D isMemoryUsage isPickable name showHelpers type userData

Accessors

clippingPlanes color distance frozen instance loading object3d opacity origin progress ready renderOrder showCeilingGrid showFloorGrid showLabels showSideGrids style ticks visible volume

Methods

addEventListener assignRenderOrder contains dispatchEvent dispose filterChangeSources getBoundingBox getMemoryUsage hasEventListener isOwned notifyChange onObjectCreated onRenderingContextLost onRenderingContextRestored pick postUpdate preprocess preUpdate refresh removeEventListener setupMaterial shouldCheckForUpdate shouldFullUpdate shouldUpdate traverse traverseMaterials traverseMeshes update updateClippingPlanes updateOpacity updateRenderOrder updateVisibility

Constructors

constructor

Properties

Protected_distance

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

Readonlyid

id: string

The unique identifier of this entity.

ReadonlyisAxisGrid

isAxisGrid: true = ...

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

ReadonlyisEntity

isEntity: boolean = ...

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

ReadonlyisEntity3D

isEntity3D: boolean = ...

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

ReadonlyisMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

ReadonlyisPickable

isPickable = true

name

name: undefined | string

The name of this entity.

showHelpers

showHelpers: boolean

Readonlytype

type: "AxisGrid" = ...

The name of the type of this object.

ReadonlyuserData

userData: UserData

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[]

  • set clippingPlanes(planes): void

  • Parameters

    Returns void

color

distance

  • get distance(): {
        max: number;
        min: number;
    }

  • Returns {
        max: number;
        min: number;
    }

    • max: number
    • min: number

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

  • set frozen(v): void

  • Parameters

    • v: boolean

    Returns void

instance

loading

  • get loading(): boolean

  • Gets whether this entity is currently loading data.

    Returns boolean

object3d

opacity

  • get opacity(): number

  • Gets or sets the opacity of this entity.

    Returns number

  • set opacity(v): void

  • Parameters

    • v: number

    Returns void

origin

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

ready

  • get ready(): boolean

  • Determine if this entity is ready to use.

    Returns boolean

renderOrder

  • get renderOrder(): number

  • Gets or sets the render order of this entity.

    Returns number

  • set renderOrder(v): void

  • Parameters

    • v: number

    Returns void

showCeilingGrid

showFloorGrid

showLabels

showSideGrids

style

ticks

visible

  • get visible(): boolean

  • Gets or sets the visibility of this entity. A non-visible entity will not be automatically updated.

    Returns boolean

  • set visible(v): void

  • Parameters

    • v: boolean

    Returns void

volume

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Adds a listener to an event type.

    Type Parameters

    • T extends
          | "initialized"
          | "frozen-property-changed"
          | "visible-property-changed"
          | "opacity-property-changed"
          | "clippingPlanes-property-changed"
          | "renderOrder-property-changed"
          | "object-created"

    Parameters

    Returns void

  • addEventListener<T>(type, listener): void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

ProtectedassignRenderOrder

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.

dispatchEvent

  • dispatchEvent<T>(event): void

  • Fire an event type.

    Type Parameters

    • T extends
          | "initialized"
          | "frozen-property-changed"
          | "visible-property-changed"
          | "opacity-property-changed"
          | "clippingPlanes-property-changed"
          | "renderOrder-property-changed"
          | "object-created"

    Parameters

    Returns void

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

filterChangeSources

getBoundingBox

getMemoryUsage

hasEventListener

  • hasEventListener<T>(type, listener): boolean

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends
          | "initialized"
          | "frozen-property-changed"
          | "visible-property-changed"
          | "opacity-property-changed"
          | "clippingPlanes-property-changed"
          | "renderOrder-property-changed"
          | "object-created"

    Parameters

    Returns boolean

  • hasEventListener<T>(type, listener): boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

ProtectedisOwned

  • isOwned(obj): boolean

  • Returns true if this object belongs to this entity.

    Parameters

    • obj: unknown

      The object to test.

    Returns boolean

ProtectednotifyChange

ProtectedonObjectCreated

  • 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

    Returns void

    Example

    // In the subclass
    const obj = new Object3D();

    // Notify the parent class
    this.onObjectCreated(obj);

onRenderingContextLost

  • onRenderingContextLost(options): void

  • Called when the rendering context has been lost.

    Parameters

    • options: {
          canvas: HTMLCanvasElement;
      }

      The options.

      • canvas: HTMLCanvasElement

    Returns void

onRenderingContextRestored

pick

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

Protectedpreprocess

  • 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.

preUpdate

  • preUpdate(context): object[]

  • 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.

    Returns object[]

    the elements to update during update().

refresh

  • refresh(): void

  • Rebuilds the grid. This is necessary after changing the ticks, volume or origin.

    Returns void

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Removes a listener from an event type.

    Type Parameters

    • T extends
          | "initialized"
          | "frozen-property-changed"
          | "visible-property-changed"
          | "opacity-property-changed"
          | "clippingPlanes-property-changed"
          | "renderOrder-property-changed"
          | "object-created"

    Parameters

    Returns void

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

ProtectedsetupMaterial

  • 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

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

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

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

traverse

traverseMaterials

traverseMeshes

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

updateClippingPlanes

updateOpacity

updateRenderOrder

updateVisibility

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods