Interface MarkerOcclusionResult

Visibility result for a marker after one occlusion update.

interface MarkerOcclusionResult {
    canvasPos: Vec2;
    distanceToMarker: number;
    inFrustum: boolean;
    marker: MarkerOcclusionMarker;
    markerId: string;
    mode: "bvh";
    occluded: boolean;
    occluderMeshId: string;
    occluderObjectId: string;
    rayDir: Vec3;
    rayOrigin: Vec3;
    visible: boolean;
}

Properties

canvasPos distanceToMarker inFrustum marker markerId mode occluded occluderMeshId occluderObjectId rayDir rayOrigin visible

Properties

canvasPos

canvasPos: Vec2

Canvas-space marker position in CSS pixels, or null when not projectable.

distanceToMarker

distanceToMarker: number

Distance from ray origin to marker along rayDir, or null when skipped.

inFrustum

inFrustum: boolean

true when the marker projects inside the view frustum.

marker

marker: MarkerOcclusionMarker

Marker input that produced this result.

markerId

markerId: string

Stable ID from MarkerOcclusionMarker.id.

mode

mode: "bvh"

Backend used for this result.

occluded

occluded: boolean

Raw occlusion result for this update before hysteresis is applied.

occluderMeshId

occluderMeshId: string

Mesh ID of the occluder, if any.

occluderObjectId

occluderObjectId: string

Object ID of the occluder, if any.

rayDir

rayDir: Vec3

World-space ray direction used by the occlusion test, or null when skipped.

rayOrigin

rayOrigin: Vec3

World-space ray origin used by the occlusion test, or null when skipped.

visible

visible: boolean

true when the marker should be shown after frustum and hysteresis rules.

Settings

Member Visibility

On This Page

Properties