Class PointCloudRenderer

constructor

• new PointCloudRenderer(
      device: GPUDevice,
      colorFormat: GPUTextureFormat,
      depthFormat: GPUTextureFormat,
      sampleCount: number,
      startHandleId?: number,
  ): PointCloudRenderer

  Parameters

  • device: GPUDevice
  • colorFormat: GPUTextureFormat
  • depthFormat: GPUTextureFormat
  • sampleCount: number
  • OptionalstartHandleId: number

  Returns PointCloudRenderer

ReadonlyhandleIds

addAsset

• addAsset(asset: PointCloudAsset): PointCloudAssetHandle

  Parameters

  • asset: PointCloudAsset

  Returns PointCloudAssetHandle

appendChunk

• appendChunk(
      handle: PointCloudAssetHandle,
      chunk: PointCloudChunkInput,
      key?: string,
  ): void

  key makes the chunk removable on its own (removeChunk), e.g. one COPC octree node (#6869).

  Parameters

  • handle: PointCloudAssetHandle
  • chunk: PointCloudChunkInput
  • Optionalkey: string

  Returns void

beginAsset

• beginAsset(meta: PointCloudNodeMeta): PointCloudAssetHandle

  Open an empty asset that chunks will be appended to.

  Parameters

  • meta: PointCloudNodeMeta

  Returns PointCloudAssetHandle

clear

• clear(): void

  Returns void

draw

• draw(pass: GPURenderPassEncoder, state: PointCloudDrawState): void

  Issue draw calls into an already-open render pass. The caller owns the encoder/pass and is responsible for the depth attachment.

  Parameters

  • pass: GPURenderPassEncoder
  • state: PointCloudDrawState

  Returns void

endAsset

• endAsset(handle: PointCloudAssetHandle): void

  Mark streaming complete. No-op for now — kept for symmetry.

  Parameters

  • handle: PointCloudAssetHandle

  Returns void

getAssetPlacement

• getAssetPlacement(
      handle: PointCloudAssetHandle,
  ): Float64Array<ArrayBufferLike> | undefined

  Parameters

  • handle: PointCloudAssetHandle

  Returns Float64Array<ArrayBufferLike> | undefined

getAssetTransform

• getAssetTransform(
      handle: PointCloudAssetHandle,
  ): Float32Array<ArrayBufferLike> | undefined

  Parameters

  • handle: PointCloudAssetHandle

  Returns Float32Array<ArrayBufferLike> | undefined

getBounds

• getBounds(): | { max: [number, number, number]; min: [number, number, number] }
  | null

  Returns { max: [number, number, number]; min: [number, number, number] } | null

getInternalNodes

• getInternalNodes(): Iterable<PointCloudNode>

  Iterate every uploaded node. Exposed so the deviation compute pass can reach each node's vertex + deviation buffers without the renderer having to mirror its internal map.

  Returns Iterable<PointCloudNode>

getNodeCount

• getNodeCount(): number

  Returns number

getOptions

• getOptions(): Readonly<ResolvedPointCloudRenderOptions>

  Returns Readonly<ResolvedPointCloudRenderOptions>

getPickNodes

• getPickNodes(): {
      chunks: { pointCount: number; vertexBuffer: GPUBuffer }[];
      expressId: number;
      model?: Float32Array<ArrayBufferLike>;
      modelIndex?: number;
      rteOrigin?: [number, number, number];
  }[]

  Picker snapshot uses each visible splat's exact model matrix.

  Returns {
      chunks: { pointCount: number; vertexBuffer: GPUBuffer }[];
      expressId: number;
      model?: Float32Array<ArrayBufferLike>;
      modelIndex?: number;
      rteOrigin?: [number, number, number];
  }[]

getPlacementBounds

• getPlacementBounds(
      modelIndex: number,
      handle?: PointCloudAssetHandle,
  ): { max: [number, number, number]; min: [number, number, number] } | null

  Parameters

  • modelIndex: number
  • Optionalhandle: PointCloudAssetHandle

  Returns { max: [number, number, number]; min: [number, number, number] } | null

getPointCount

• getPointCount(): number

  Total number of points currently uploaded across all assets.

  Returns number

getRayQuerySources

• getRayQuerySources(): {
      classMask: Uint32Array;
      expressId: number;
      index: PointCloudSpatialIndex;
      model?: Float64Array<ArrayBufferLike>
      | Float32Array<ArrayBufferLike>;
      modelIndex?: number;
  }[]

  CPU spatial-index snapshot for measurement snapping (#1860), with the live visibility mask so hidden points cannot corrupt measurements (#1783).

  Returns {
      classMask: Uint32Array;
      expressId: number;
      index: PointCloudSpatialIndex;
      model?: Float64Array<ArrayBufferLike> | Float32Array<ArrayBufferLike>;
      modelIndex?: number;
  }[]

hasAssets

• hasAssets(): boolean

  Returns boolean

relabelAsset

• relabelAsset(
      handle: PointCloudAssetHandle,
      newExpressId: number,
      modelIndex?: number,
  ): void

  Reassign a streamed asset's identity after upload: the federated expressId (the shader reads it from a per-asset uniform, flags.x, so the next frame picks it up without touching per-vertex attributes) and, when given, the modelIndex picks and deviation readback report (#6887).

  Parameters

  • handle: PointCloudAssetHandle
  • newExpressId: number
  • OptionalmodelIndex: number

  Returns void

removeAsset

• removeAsset(handle: PointCloudAssetHandle): void

  Parameters

  • handle: PointCloudAssetHandle

  Returns void

removeChunk

• removeChunk(handle: PointCloudAssetHandle, key: string): number

  Free every GPU buffer and the snap index appended under key; returns the points removed.

  Parameters

  • handle: PointCloudAssetHandle
  • key: string

  Returns number

resolvePick

• resolvePick(
      expressId: number,
  ): { handle: PointCloudAssetHandle; meta: PointCloudNodeMeta } | null

  Resolve an objectId rgba8 sample, or null when it matches no asset.

  Parameters

  • expressId: number

  Returns { handle: PointCloudAssetHandle; meta: PointCloudNodeMeta } | null

setAssets

• setAssets(assets: readonly PointCloudAsset[]): void

  Replace every IFCx-owned asset with assets. Streamed assets are untouched. Use this from the viewer's IFCx sync hook.

  Parameters

  • assets: readonly PointCloudAsset[]

  Returns void

setAssetTransform

• setAssetTransform(
      handle: PointCloudAssetHandle,
      matrix:
          | Float64Array<ArrayBufferLike>
          | Float32Array<ArrayBufferLike>
          | null,
  ): void

  Import alignment composes with manual placement without reuploading points.

  Parameters

  • handle: PointCloudAssetHandle
  • matrix: Float64Array<ArrayBufferLike> | Float32Array<ArrayBufferLike> | null

  Returns void

setAssetTranslation

• setAssetTranslation(
      handle: PointCloudAssetHandle,
      translation: readonly [number, number, number],
  ): void

  Parameters

  • handle: PointCloudAssetHandle
  • translation: readonly [number, number, number]

  Returns void

setAssetVisible

• setAssetVisible(handle: PointCloudAssetHandle, visible: boolean): boolean

  Hide a resident asset from rendering and both point-cloud pick paths.

  Parameters

  • handle: PointCloudAssetHandle
  • visible: boolean

  Returns boolean

setModelTranslation

• setModelTranslation(
      modelIndex: number,
      translation: readonly [number, number, number],
  ): void

  Parameters

  • modelIndex: number
  • translation: readonly [number, number, number]

  Returns void

setOptions

• setOptions(opts: PointCloudRenderOptions): void

  Parameters

  • opts: PointCloudRenderOptions

  Returns void

validateModelTranslation

• validateModelTranslation(
      modelIndex: number,
      translation: readonly [number, number, number],
  ): void

  Parameters

  • modelIndex: number
  • translation: readonly [number, number, number]

  Returns void