Communicator.NavCube

 NavCube

This class provides an interface to the navigational cube which is enabled by default. The default functionality changes the camera's view orientation based on the location the user clicks on the cube. This cube is initialized and associated with an overlay when the viewer is created. For additional information on overlays please refer to the Communicator.OverlayManager.

More information can be found here.

Methods

disable

enable

getAnchor

getEnabled

  • getEnabled(): boolean
  • Gets whether the NavCube is currently enabled.

    Returns boolean

getOverlayId

getPreserveModelUp

  • getPreserveModelUp(): boolean
  • Gets the NavCube preserveModelUp state.

    Returns boolean

    true if model up is preserved, false if camera up is preserved.

insideOverlay

  • insideOverlay(mousePos: Point2): boolean
  • Determines whether or not a point is inside the NavCube overlay.

    Parameters

    Returns boolean

    Boolean indicating whether the provided point is inside the NavCube overlay

onClickSelection

  • onClickSelection(selection: SelectionItem | null): Promise<void>
  • Called when the NavCube is clicked. Realigns the view to the side/edge/corner selected by selection, or rotates the view 90 degrees if the selection matches the current view orientation, or does nothing if no side is selected.

    Parameters

    Returns Promise<void>

onMoveSelection

  • Called when the NavCube is "moused over". Displays face/edge/corner that will be selected.

    Parameters

    Returns void

setAnchor

  • Sets the anchor position for the NavCube.

    Parameters

    Returns Promise<void>

setPreserveModelUp

  • setPreserveModelUp(preserve: boolean): void
  • Determines if model up or camera up will the preserved when navigating with the NavCube. If model up is preserved, navigation with the NavCube will keep the model upright all the time. If camera up is preserved, navigation with the NavCube will attempt to preserve the current up direction of the camera as much as possible. Defaults to true.

    Parameters

    • preserve: boolean

      If true, model up is preserved. Otherwise, camera up is preserved.

    Returns void