Documentation - v19.12.0-dev
    Preparing search index...

    Class PathPlugin

    Viewer plugin providing guide paths, voxelization-based navigation graphs, flood-fill classification and routing between points in the scene.

    Hierarchy

    • PluginBaseClass
      • PathPlugin
    Index

    Constructors

    constructor

    Properties

    floodFillController floodFillSeedSceneController name navigationGraphController navigationGraphSceneController navigationGraphSettings navigationRoutingController navigationRoutingSceneController pathController settings viewer voxelDebugController voxelizationController

    Methods

    clear dependencies hasSettings onRegister onUnregister setNavigationToolsVisible Create

    Constructors

    • Parameters

      Returns PathPlugin

    Properties

    floodFillController: FloodFillController
    floodFillSeedSceneController: FloodFillSeedSceneController
    name: string

    Display name of the plugin

    navigationGraphController: NavigationGraphController
    navigationGraphSceneController: NavigationGraphSceneController
    navigationGraphSettings: {
        connectNodesAutomatically: BooleanController;
        mergeThreshold: NumberController;
        routingConnectionDistance: NumberController;
    } = ...
    navigationRoutingController: NavigationRoutingController

    Runtime settings used by the navigation graph editing tools.

    navigationRoutingSceneController: NavigationRoutingSceneController
    pathController: PathController
    settings: {
        color: ColorController;
        cornerRadius: NumberController;
        heightOffset: NumberController;
        opacity: NumberController;
        pointRadius: NumberController;
        segmentLength: NumberController;
        segmentSpacing: NumberController;
        smoothing: NumberController;
        speed: NumberController;
        thickness: NumberController;
    }

    Plugin settings

    viewer: Viewer
    voxelDebugController: VoxelDebugController
    voxelizationController: VoxelizationController

    Methods

    • Returns void

    • List of plugins this plugin depends on

      Returns readonly (keyof ViewerPluginRegistry)[]

    • Indicates whether the plugin has settings

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    • Shows or hides the permanent graph and the temporary route construction geometry together.

      Parameters

      • visible: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods