Class FeatureCollection<UserData>

An Entity3D that represent simple features as 3D meshes.

❗ Arbitrary triangulated meshes (TINs) are not supported.

Supported geometries

Both 2D and 3D geometries are supported. In the case of 2D geometries (with only XY coordinates), you can specify an elevation (Z) to display the geometries at arbitrary heights, using the elevation option in the constructor.

Supported geometries:

Point and MultiPoint
LineString and MultiLineString
Polygon and MultiPolygon. Polygons can additionally be extruded (e.g to display buildings from footprints) with the extrusionOffset constructor option.

Data sources

At the moment, this entity accepts an OpenLayers VectorSource that returns features.

NOTE: if your source doesn't have a notion of level of detail, like a WFS server, you must choose one level where data will be downloaded. The level giving the best user experience depends on the data source. You must configure both minLevel and maxLevel to this level.

For example, in the case of a WFS source:

import VectorSource from 'ol/source/Vector.js';
import FeatureCollection from '@giro3d/giro3d/entities/FeatureCollection';

const vectorSource = new VectorSource({
 // ...
});
const featureCollection = new FeatureCollection('features', {
 source: vectorSource
 minLevel: 10,
 maxLevel: 10,
 elevation: (feature) => feat.getProperties().elevation,
});

instance.add(featureCollection);

Supported CRSes

The FeatureCollection supports the reprojection of geometries if the source has a different CRS than the scene. Any custom CRS must be registered first with Instance.registerCRS().

Related examples:

Styling

Features can be styled using a FeatureStyle, either using the same style for the entire entity, or using a style function that will return a style for each feature.

❗ All features that share the same style will internally use the same material. It is not advised to modify this material to avoid affecting all shared objects. Those materials are automatically disposed when the entity is removed from the instance.

Textures used by point styles are also disposed if they were created internally by the entity (from a provided URL) rather than provided as a texture.

Overriding material generators

By default, styles are converted to materials using default generator functions. It is possible to override those function to create custom materials. For example, to use custom line materials, you can pass the lineMaterialGenerator option to the constructor.

Type Parameters

UserData = EntityUserData

Hierarchy (view full)

Entity3D<Entity3DEventMap, UserData>
- FeatureCollection

Constructors

constructor

new FeatureCollection<UserData>(options): FeatureCollection<UserData>
Construct a FeatureCollection.
Type Parameters
- UserData = EntityUserData
Parameters
- options: {
      dataProjection?: string;
      elevation?: number | number[] | FeatureElevationCallback;
      extent: Extent;
      extrusionOffset?: number | number[] | FeatureExtrusionOffsetCallback;
      ignoreZ?: boolean;
      lineMaterialGenerator?: LineMaterialGenerator<StrokeStyle, LineMaterial>;
      maxLevel?: number;
      minLevel?: number;
      object3d?: Object3D<Object3DEventMap>;
      pointMaterialGenerator?: PointMaterialGenerator<PointStyle, SpriteMaterial>;
      shadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>;
      source: external.olsource.Vector<Geometry>;
      style?: FeatureStyle | FeatureStyleCallback;
      unshadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>;
  }
  Constructor options.
  - Optional dataProjection?: string
    The projection code for the projections of the features. If null or empty, no reprojection will be done. If a valid epsg code is given and if different from instance.referenceCrs, each feature will be reprojected before mesh conversion occurs. Note that reprojection can be somewhat heavy on CPU resources.
  - Optional elevation?: number | number[] | FeatureElevationCallback
    Set the elevation of the features received from the source. It can be a constant for every feature, or a callback. The callback version is particularly useful to derive the elevation from the properties of the feature. Requires _ignoreZ to be false.
  - extent: Extent
    The geographic extent of the entity.
  - Optional extrusionOffset?: number | number[] | FeatureExtrusionOffsetCallback
    If set, this will cause 2D features to be extruded of the corresponding amount. If a single value is given, it will be used for all the vertices of every feature. If an array is given, each extruded vertex will use the corresponding value. If a callback is given, it allows to extrude each feature individually.
  - Optional ignoreZ?: boolean
    If true, the Z-coordinates of geometries will be ignored and set to zero.
    Default Value
    false
  - Optional lineMaterialGenerator?: LineMaterialGenerator<StrokeStyle, LineMaterial>
    An optional material generator for lines.
  - Optional maxLevel?: number
    The max level to subdivide the extent and process features.
  - Optional minLevel?: number
    The min subdivision level to start processing features. Useful for WFS or other untiled servers, to avoid to download the entire dataset when the whole extent is visible.
  - Optional object3d?: Object3D<Object3DEventMap>
    The optional 3D object to use as the root
  - Optional pointMaterialGenerator?: PointMaterialGenerator<PointStyle, SpriteMaterial>
    An optional material generator for points.
  - Optional shadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>
    An optional material generator for shaded surfaces.
  - source: external.olsource.Vector<Geometry>
    The OpenLayers VectorSource providing features to this entity
  - Optional style?: FeatureStyle | FeatureStyleCallback
    An style or a callback returning a style to style the individual features. If an object is used, the informations it contains will be used to style every feature the same way. If a function is provided, it will be called with the feature. This allows to individually style each feature.
  - Optional unshadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>
    An optional material generator for unshaded surfaces.
Returns FeatureCollection<UserData>
Overrides Entity3D.constructor
- Defined in entities/FeatureCollection.ts:298

Properties

`Protected` _distance

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

Type declaration

max: number
min: number

`Readonly` dataProjection

dataProjection: null | string

The projection code of the data source.

`Readonly` extent

extent: Extent

The extent of this entity.

`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` isFeatureCollection

isFeatureCollection: true = ...

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

`Readonly` isMemoryUsage

isMemoryUsage: true = ...

`Readonly` isPickable

isPickable: true = true

`Readonly` maxLevel

maxLevel: number = 0

The maximum LOD at which this entity is displayed.

`Readonly` minLevel

minLevel: number = 0

The minimum LOD at which this entity is displayed.

name

name: undefined | string

The name of this entity.

sseScale

sseScale: number = 1

The factor to drive the subdivision of feature nodes. The heigher, the bigger the nodes.

`Readonly` type

type: "FeatureCollection" = ...

The name of the type of this object.

`Readonly` userData

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[]
Inherited from Entity3D.clippingPlanes
- Defined in entities/Entity3D.ts:171
set clippingPlanes(planes): void
Parameters
- planes: null | Plane[]
Returns void
Inherited from Entity3D.clippingPlanes
- Defined in entities/Entity3D.ts:175

distance

get distance(): {
max: number;
min: number;
}
Returns {
max: number;
min: number;
}
- max: number
- min: number
Inherited from Entity3D.distance
- 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 Entity3D.frozen
- Defined in entities/Entity.ts:144
set frozen(v): void
Parameters
- v: boolean
Returns void
Inherited from Entity3D.frozen
- Defined in entities/Entity.ts:148

instance

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

loading

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

Returns boolean
Overrides Entity3D.loading
- Defined in entities/FeatureCollection.ts:451

materialCount

get materialCount(): number
The number of materials managed by this entity.

Returns number
- Defined in entities/FeatureCollection.ts:289

object3d

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

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

opacity

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

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

progress

get progress(): number
Gets the progress value of the data loading.

Returns number
Overrides Entity3D.progress
- Defined in entities/FeatureCollection.ts:458

ready

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

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

renderOrder

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

Returns number
Inherited from Entity3D.renderOrder
- Defined in entities/Entity3D.ts:137
set renderOrder(v): void
Parameters
- v: number
Returns void
Inherited from Entity3D.renderOrder
- 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
Inherited from Entity3D.visible
- Defined in entities/Entity3D.ts:122
set visible(v): void
Parameters
- v: boolean
Returns void
Inherited from Entity3D.visible
- Defined in entities/Entity3D.ts:126

Methods

addEventListener

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

`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
Overrides Entity3D.assignRenderOrder
- Defined in entities/FeatureCollection.ts:636

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.
Inherited from Entity3D.contains
- Defined in entities/Entity3D.ts:350

dispatchEvent

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

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
Overrides Entity3D.dispose
- Defined in entities/FeatureCollection.ts:1031

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 Entity3D.filterChangeSources
- Defined in entities/Entity.ts:253

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.
Inherited from Entity3D.getBoundingBox
- Defined in entities/Entity3D.ts:275

getMemoryUsage

getMemoryUsage(context): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
  The graphics context.
Returns void
Overrides Entity3D.getMemoryUsage
- Defined in entities/FeatureCollection.ts:414

hasEventListener

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

`Protected` isOwned

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

`Protected` notifyChange

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

`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);
```
Inherited from Entity3D.onObjectCreated
- Defined in entities/Entity3D.ts:315

onRenderingContextLost

onRenderingContextLost(options): void
Called when the rendering context has been lost.
Parameters
- options: {
  canvas: HTMLCanvasElement;
  }
  The options.
  - canvas: HTMLCanvasElement
Returns void
Inherited from Entity3D.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
Inherited from Entity3D.onRenderingContextRestored
- Defined in entities/Entity3D.ts:107

pick

pick(canvasCoords, options?): PickResult<unknown>[]
Parameters
- canvasCoords: Vector2
- Optional options: PickOptions
Returns PickResult<unknown>[]
Inherited from Entity3D.pick
- Defined in entities/Entity3D.ts:411

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 Entity3D.postUpdate
- Defined in entities/Entity.ts:316

preUpdate

preUpdate(_, changeSources): FeatureTile[]
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
  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 FeatureTile[]
the elements to update during update().
Overrides Entity3D.preUpdate
- Defined in entities/FeatureCollection.ts:501

preprocess

preprocess(): 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.

Returns Promise<void>
A promise that resolves when the entity is ready to be used.
Overrides Entity3D.preprocess
- Defined in entities/FeatureCollection.ts:422

removeEventListener

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

`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
Inherited from Entity3D.setupMaterial
- Defined in entities/Entity3D.ts:292

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
Inherited from Entity3D.shouldCheckForUpdate
- Defined in entities/Entity3D.ts:230

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
Inherited from Entity3D.shouldFullUpdate
- Defined in entities/Entity3D.ts:234

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
Inherited from Entity3D.shouldUpdate
- Defined in entities/Entity3D.ts:238

traverse

traverse(callback, root?): void
Traverses all objects in the hierarchy of this entity.
Parameters
- callback: ((arg0) => 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
Inherited from Entity3D.traverse
- Defined in entities/Entity3D.ts:403

traverseGeometries

traverseGeometries(callback): void
Parameters
- callback: ((geom) => void)
  - - (geom): void
    - Parameters
      geom: SimpleGeometryMesh<MeshUserData, SimpleGeometryMeshEventMap>
      Returns void
Returns void
- Defined in entities/FeatureCollection.ts:687

traverseMaterials

traverseMaterials(callback, root?): void
Traverses all materials in the hierarchy of this entity.
Parameters
- callback: ((arg0) => 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
Inherited from Entity3D.traverseMaterials
- Defined in entities/Entity3D.ts:361

traverseMeshes

traverseMeshes(callback, root?): void
Traverses all meshes in the hierarchy of this entity.
Parameters
- callback: ((arg0) => 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
Inherited from Entity3D.traverseMeshes
- Defined in entities/Entity3D.ts:384

update

update(ctx, tile): undefined | null | Object3D<Object3DEventMap>[]
Performs an update on an element of the entity.

Note: this method will be called for each element returned by preUpdate().
Parameters
- ctx: Context
  the update context. This is the same object that the entity whose update() is being called.
- tile: FeatureTile
  the element to update. This is one of the elements returned by preUpdate.
Returns undefined | null | Object3D<Object3DEventMap>[]
New elements to update
Overrides Entity3D.update
- Defined in entities/FeatureCollection.ts:847

updateClippingPlanes

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

Returns void
Inherited from Entity3D.updateClippingPlanes
- Defined in entities/Entity3D.ts:224

updateOpacity

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

Returns void
Overrides Entity3D.updateOpacity
- Defined in entities/FeatureCollection.ts:679

updateRenderOrder

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

Returns void
Overrides Entity3D.updateRenderOrder
- Defined in entities/FeatureCollection.ts:673

updateStyles

updateStyles(objects?): void
Updates the styles of the given objects, or all objects if unspecified.
Parameters
- Optional objects: (SimpleGeometryMesh<MeshUserData, SimpleGeometryMeshEventMap> | default<MeshUserData>)[]
  The objects to update.
Returns void
- Defined in entities/FeatureCollection.ts:547

updateVisibility

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

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

Class FeatureCollection<UserData>

Supported geometries

Data sources

Supported CRSes

Styling

Overriding material generators

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Optional dataProjection?: string

Optional elevation?: number | number[] | FeatureElevationCallback

extent: Extent

Optional extrusionOffset?: number | number[] | FeatureExtrusionOffsetCallback

Optional ignoreZ?: boolean

Default Value

Optional lineMaterialGenerator?: LineMaterialGenerator<StrokeStyle, LineMaterial>

Optional maxLevel?: number

Optional minLevel?: number

Optional object3d?: Object3D<Object3DEventMap>

Optional pointMaterialGenerator?: PointMaterialGenerator<PointStyle, SpriteMaterial>

Optional shadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>

source: external.olsource.Vector<Geometry>

Optional style?: FeatureStyle | FeatureStyleCallback

Optional unshadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>

Returns FeatureCollection<UserData>

Properties

Protected _distance

Type declaration

max: number

min: number

Readonly dataProjection

Readonly extent

Readonly id

Readonly isEntity

Readonly isEntity3D

Readonly isFeatureCollection

Readonly isMemoryUsage

Readonly isPickable

Readonly maxLevel

Readonly minLevel

name

sseScale

Readonly type

Readonly userData

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

materialCount

Returns number

object3d

Returns Object3D<Object3DEventMap>

opacity

Returns number

Parameters

Returns void

progress

Returns number

ready

`Optional` dataProjection?: string

`Optional` elevation?: number | number[] | FeatureElevationCallback

`Optional` extrusionOffset?: number | number[] | FeatureExtrusionOffsetCallback

`Optional` ignoreZ?: boolean

`Optional` lineMaterialGenerator?: LineMaterialGenerator<StrokeStyle, LineMaterial>

`Optional` maxLevel?: number

`Optional` minLevel?: number

`Optional` object3d?: Object3D<Object3DEventMap>

`Optional` pointMaterialGenerator?: PointMaterialGenerator<PointStyle, SpriteMaterial>

`Optional` shadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>

`Optional` style?: FeatureStyle | FeatureStyleCallback

`Optional` unshadedSurfaceMaterialGenerator?: SurfaceMaterialGenerator<FillStyle, Material>

`Protected` _distance

`Readonly` dataProjection

`Readonly` extent

`Readonly` id

`Readonly` isEntity

`Readonly` isEntity3D

`Readonly` isFeatureCollection

`Readonly` isMemoryUsage

`Readonly` isPickable

`Readonly` maxLevel

`Readonly` minLevel

`Readonly` type

`Readonly` userData

Returns {
max: number;
min: number;
}

`Protected` assignRenderOrder

`Protected` isOwned

`Protected` notifyChange

`Protected` onObjectCreated