Class SoftwareOcclusionTester

constructor

• new SoftwareOcclusionTester(
      aabbStore: IAABBStore,
      params?: ISoftwareOcclusionTesterParams,
  ): SoftwareOcclusionTester

  Parameters

  • aabbStore: IAABBStore
  • params: ISoftwareOcclusionTesterParams = {}

  Returns SoftwareOcclusionTester

Readonly_ocTesterType

Readonlystats

debugLineCount

• get debugLineCount(): number

  Returns number

debugLines

• get debugLines(): Float32Array<ArrayBufferLike>

  Returns Float32Array<ArrayBufferLike>

debugMesh

• get debugMesh(): Mesh | null

  Returns Mesh | null

debugOccluders

• get debugOccluders(): boolean

  Returns boolean

• set debugOccluders(value: boolean): void

  Parameters

  • value: boolean

  Returns void

height

• get height(): number

  Returns number

occluders

• get occluders(): OccluderStore

  Occluder store.

  Returns OccluderStore

ready

• get ready(): boolean

  Returns boolean

reserved

• get reserved(): Required<ISoftwareOcclusionPreallocate>

  Returns Required<ISoftwareOcclusionPreallocate>

results

• get results(): Uint32Array<ArrayBufferLike>

  Returns Uint32Array<ArrayBufferLike>

width

• get width(): number

  Returns number

debugDraw

• debugDraw(app: AppBase, color?: Color, depthTest?: boolean): void

  Draws the last worker debug wireframe on the immediate layer. Call from update, before that layer is rendered. The GPU mesh is rebuilt only when the worker sends new debugLines.

  Parameters

  • app: AppBase
  • color: Color = pc.Color.YELLOW
  • depthTest: boolean = true

  Returns void

destroy

• destroy(): void

  Returns void

enqueue

• enqueue(id: number, _extra?: number | number[]): number

  Adds the object to the queue for occlusion testing.

  Parameters

  • id: number

    The unique identifier returned earlier by the lock() method.

  • Optional_extra: number | number[]

  Returns number

  A queue index or -1 (if internal verification inconsistencies occur, for example, the tester is unavailable or the tester is waiting for synchronization).

enqueueAabbUpdate

• enqueueAabbUpdate(
      id: number,
      boundingBox: BoundingBox,
      matrix?: Mat4,
      extra1?: number,
      extra2?: number,
  ): void

  Forwards AABB updates to the store and marks the id dirty for worker sync. Prefer this over calling IAABBStore.enqueueUpdate directly so the worker mirror stays incremental instead of a full resync.

  Parameters

  • id: number
  • boundingBox: BoundingBox
  • Optionalmatrix: Mat4
  • extra1: number = 0
  • extra2: number = 0

  Returns void

execute

• execute(camera: Camera): void

  Runs an occlusion check for the specified camera.

  Parameters

  • camera: Camera

    The camera

  Returns void

getOcclusionStatus

• getOcclusionStatus(id: number): TOcclusionResult

  Return the result of the last occlusion test for the specified object.

  Parameters

  • id: number

    The unique identifier of the object.

  Returns TOcclusionResult

  OCCLUSION_UNKNOWN, OCCLUSION_VISIBLE, or OCCLUSION_OCCLUDED.

lock

• lock(
      boundingBox: BoundingBox,
      matrix?: Mat4,
      extra1?: number,
      extra2?: number,
  ): number

  Registers a BoundingBox for subsequent occlusion testing.

  Parameters

  • boundingBox: BoundingBox

    The bounds of the object in local or world coordinates.

  • Optionalmatrix: Mat4

    Optional transformation matrix (if a local BoundingBox is used).

  • extra1: number = 0

    Optional extra data 1.

  • extra2: number = 0

    Optional extra data 2.

  Returns number

  A unique identifier for the registered object.

lockMinMaxScalars

• lockMinMaxScalars(
      data: ArrayLike<number>,
      offset: number,
      matrix?: Mat4,
      extra1?: number,
      extra2?: number,
  ): number

  Registers a BoundingBox for subsequent occlusion testing.

  Parameters

  • data: ArrayLike<number>

    The array containing the bounding box data (min and max points) in local or world coordinates [minX, maxX, minY, maxY, minZ, maxZ].

  • offset: number

    The offset in the array where the bounding box data starts.

  • Optionalmatrix: Mat4

    Optional transformation matrix (if a local BoundingBox is used).

  • Optionalextra1: number

    Optional extra data 1.

  • Optionalextra2: number

    Optional extra data 2.

  Returns number

  A unique identifier for the registered object.

preallocate

• preallocate(sizes: ISoftwareOcclusionPreallocate): void

  Grows occluder capacity (and retained mesh/vertex hints). Does not shrink. Worker capacity is updated on the next idle execute via a resize patch.

  Parameters

  • sizes: ISoftwareOcclusionPreallocate

  Returns void

resize

• resize(): void

  Returns void

unlock

• unlock(id: number): void

  Releases a previously registered identifier and removes associated data.

  Parameters

  • id: number

    The unique identifier obtained from the lock() call.

  Returns void