Interface PointCloudSource<TEventMap>

Provides point cloud data.

interface PointCloudSource<
    TEventMap extends PointCloudSourceEventMap = PointCloudSourceEventMap,
> {
    id: string;
    isMemoryUsage: true;
    ready: boolean;
    type: string;
    get loading(): boolean;
    get progress(): number;
    dispose(): void;
    getHierarchy(): Promise<PointCloudNode>;
    getMemoryUsage(context: GetMemoryUsageContext): void;
    getMetadata(): Promise<PointCloudMetadata>;
    getNodeData(params: GetNodeDataOptions): Promise<PointCloudNodeData>;
    initialize(): Promise<PointCloudSource<TEventMap>>;
}

Type Parameters

TEventMap extends PointCloudSourceEventMap = PointCloudSourceEventMap

Hierarchy (View Summary)

Progress
Disposable
MemoryUsage
EventDispatcher<TEventMap>
- PointCloudSource

Implemented by

Index

Properties

id isMemoryUsage ready type

Accessors

loading progress

Methods

dispose getHierarchy getMemoryUsage getMetadata getNodeData initialize

Properties

`Readonly`id

id: string

isMemoryUsage

isMemoryUsage: true

Readonly flag to indicate that his object implements MemoryUsage.

ready

ready: boolean

A flag that indicates that the source is ready to use. This flag should be true when initialize has finished.

type

type: string

The name of the source implementation.

Accessors

loading

get loading(): boolean
Gets whether the object is currently performing an asynchronous operation.

Returns boolean
Inherited from Progress.loading
- Defined in core/Progress.ts:14

progress

get progress(): number
Returns the percentage of progress, in normalized value (i.e in the [0, 1] range), of the asynchronous operations that are scheduled to run on this object. 1 means that all operations have finished.

Returns number
Inherited from Progress.progress
- Defined in core/Progress.ts:20

Methods

dispose

dispose(): void
Releases unmanaged resources from this object.

Returns void
Inherited from Disposable.dispose
- Defined in core/Disposable.ts:14

getHierarchy

getHierarchy(): Promise<PointCloudNode>
Gets the hierarchy of this point cloud.

Note: this does not provide point cloud data itself.

Returns Promise<PointCloudNode>
- Defined in sources/PointCloudSource.ts:257

getMemoryUsage

getMemoryUsage(context: GetMemoryUsageContext): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
  The graphics context.
Returns void
Inherited from MemoryUsage.getMemoryUsage
- Defined in core/MemoryUsage.ts:38

getMetadata

getMetadata(): Promise<PointCloudMetadata>
Gets the metadata of this source.

Returns Promise<PointCloudMetadata>
- Defined in sources/PointCloudSource.ts:262

getNodeData

getNodeData(params: GetNodeDataOptions): Promise<PointCloudNodeData>
Loads buffer data for the specific PointCloudNode.
Parameters
- params: GetNodeDataOptions
  Options.
Returns Promise<PointCloudNodeData>
- Defined in sources/PointCloudSource.ts:268

initialize

initialize(): Promise<PointCloudSource<TEventMap>>
Initialize this source. As long as this source is not initialized, it cannot be used.

Returns Promise<PointCloudSource<TEventMap>>
- Defined in sources/PointCloudSource.ts:250