Class RaycastEngine

Index

Constructors

Methods

clearCaches getRaycaster getSnapDetector invalidateBVHCache raycastScene raycastSceneMagnetic setPointCloudProvider setSourceSnapCurves

Constructors

constructor

new RaycastEngine(
    camera: Camera,
    scene: RaycastScene,
    canvas: HTMLCanvasElement,
): RaycastEngine
Parameters
- camera: Camera
- scene: RaycastScene
- canvas: HTMLCanvasElement
Returns RaycastEngine

Methods

clearCaches

clearCaches(): void

Clear all caches (call when geometry changes)

Returns void

getRaycaster

getRaycaster(): Raycaster

Get the raycaster for advanced usage.

Returns Raycaster

getSnapDetector

getSnapDetector(): SnapDetector

Get the snap detector for advanced usage.

Returns SnapDetector

invalidateBVHCache

invalidateBVHCache(): void

Invalidate BVH cache (call when geometry changes)

Returns void

raycastScene

raycastScene(
    x: number,
    y: number,
    options?: PickOptions & { snapOptions?: Partial<SnapOptions> },
    clip?: PickClipState | null,
): { intersection: Intersection; snap?: SnapTarget } | null
Raycast into the scene to get precise 3D intersection point This is more accurate than pick() as it returns the exact surface point

Note: x, y are CSS pixel coordinates relative to the canvas element. The ray is built in that same CSS space (see cssViewport).
Parameters
- x: number
- y: number
- Optionaloptions: PickOptions & { snapOptions?: Partial<SnapOptions> }
- Optionalclip: PickClipState | null
Returns { intersection: Intersection; snap?: SnapTarget } | null

raycastSceneMagnetic

raycastSceneMagnetic(
    x: number,
    y: number,
    currentEdgeLock: EdgeLockInput,
    options?: PickOptions & { snapOptions?: Partial<SnapOptions> },
    clip?: PickClipState | null,
): MagneticSnapResult & { intersection: Intersection | null }
Raycast with magnetic edge snapping behavior This provides the "stick and slide along edges" experience

Note: x, y are CSS pixel coordinates relative to the canvas element. The ray is built in that same CSS space (see cssViewport).
Parameters
- x: number
- y: number
- currentEdgeLock: EdgeLockInput
- Optionaloptions: PickOptions & { snapOptions?: Partial<SnapOptions> }
- Optionalclip: PickClipState | null
Returns MagneticSnapResult & { intersection: Intersection | null }

setPointCloudProvider

setPointCloudProvider(provider: PointCloudRayProvider | null): void
Renderer wires this once point clouds are initialised so the measure tool can snap to scan points (#1860). Pass null to disable.
Parameters
- provider: PointCloudRayProvider | null
Returns void

setSourceSnapCurves

setSourceSnapCurves(curves: readonly SourceSnapCurve[]): void
Replace the selected, visible authored curves available to magnetic picking.
Parameters
- curves: readonly SourceSnapCurve[]
Returns void