• Preparing search index...
  • The search index is not available
@xeokit/sdk - v0.1.0
  • @xeokit/sdk
  • presentations
  • cameraTour
  • planCameraTour

Function planCameraTour

  • planCameraTour(params: CameraTourPlanParams): Promise<SDKResult<CameraTour>>

    Compose the four-stage camera-tour planning pipeline:

    1. Extract — SpaceExtractor turns the source into a SpaceGraph. Defaults to extractSpacesFromIfc.
    2. Sample — ViewpointSampler emits candidate viewpoints per space, scored for visibility. Defaults to sampleVisibilityGrid.
    3. Plan tour — TourPlanner picks the order and the chosen viewpoint per stop. Defaults to planTourTwoOpt (greedy NN seeded then refined by 2-opt swaps). Pass planTourGreedy directly via params.planner to skip the refinement pass on time- critical / headless paths.
    4. Smooth — buildTourWaypoints inserts portal- transit waypoints between adjacent room transitions and emits the final flat waypoint list.

    The defaults target IFC building models — supply a DataModel paired with the SceneModel and the pipeline self-configures. For non-IFC sources, override CameraTourPlanParams.extractor with a geometry-fallback extractor.

    Returns the tour as pure data — playback against a View is playCameraTour's job and is decoupled so the planner can run headless (e.g. on a server to precompute tours).

    Parameters

    • params: CameraTourPlanParams

    Returns Promise<SDKResult<CameraTour>>

    • Defined in packages/sdk/src/presentations/cameraTour/plan/planCameraTour.ts:59

Settings

Member Visibility
@xeokit/sdk - v0.1.0
  • Loading...

Generated using TypeDoc