Vertex Viewer SDK
    Preparing search index...

    Interface VertexViewerTeleportTool

    The <vertex-viewer-teleport-tool> allows for click-based "teleportation" around a model, which is particularly useful for walking through a model. This tool is automatically included as part of the .

    interface VertexViewerTeleportTool {
        animationMs?: number;
        animationsDisabled?: boolean;
        controller?: WalkModeController;
        mode?: ViewerTeleportMode;
        model?: WalkModeModel;
        onControllerChanged?: (
            event: VertexViewerTeleportToolCustomEvent<WalkModeController>,
        ) => void;
        viewer?: HTMLVertexViewerElement;
    }
    Index
    animationMs?: number

    The duration of animations, in milliseconds. Defaults to 500.

    500
    
    animationsDisabled?: boolean

    Indicates whether animations will be used when performing camera operations. Defaults to false.

    false
    
    controller?: WalkModeController

    The type of teleportation to perform when clicking.

    teleport - the camera's position is moved to the location of the hit result constrained by the plane represented by the camera's current position and up vectors.

    teleport-and-align - the camera's position, lookAt, and up vectors are updated to align to the plane represented by the hit result's position and normal.

    teleport-toward - the camera's position is moved a fixed distance toward the location of the hit result constrained by the plane represented by the camera's current position and up vectors.

    undefined - no teleportation will occur when clicking.

    Defaults to undefined.

    new WalkModeModel()
    
    onControllerChanged?: (
        event: VertexViewerTeleportToolCustomEvent<WalkModeController>,
    ) => void

    Event emitted when the WalkModeController associated with this tool changes.

    viewer?: HTMLVertexViewerElement

    The viewer that this component is bound to. This is automatically assigned if added to the light-dom of a parent viewer element.