Communicator.AxisTriad

 AxisTriad

This class provides an interface to the axis triad which is enabled by default. The default functionality orients the camera based on the axis that is clicked. This triad is initialized and associated with an overlay when the viewer is created. For additional information on overlays please refer to the OverlayManager.

More information can be found here.

Methods

disable

enable

getAnchor

  • Gets the anchor position for this AxisTriad. Default position is in the lower left corner.

    Returns OverlayAnchor

    The overlay anchor value of the triad.

getEnabled

  • getEnabled(): boolean
  • Gets the current state of this AxisTriad.

    Returns boolean

    true if enabled and false otherwise.

getOverlayId

  • Gets the overlay id. This id should be considered reserved and not be used by client applications.

    Returns OverlayIndex

    The overlay id used by this AxisTriad.

getSelectionAxis

  • Checks if a selection is part of the axis triad, and return the corresponding axis.

    Parameters

    Returns Axis | null

    Axis if selected, null otherwise.

insideOverlay

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

    Parameters

    Returns boolean

    Boolean indicating whether the provided point is inside the axis triad overlay

onClickSelection

  • onClickSelection(selection: SelectionItem | null): Promise<void>
  • Called when the axis triad is clicked. Realigns the view along the axis selected by selection or does nothing if no axis is selected.

    Parameters

    Returns Promise<void>

setAnchor

  • Sets the anchor position for this AxisTriad.

    Parameters

    Returns Promise<void>

    A promise that resolves on completion.

setAxisColor

  • setAxisColor(axis: Axis, color: Color): Promise<void>
  • Sets the color of one axis on this AxisTriad

    Parameters

    • axis: Axis

      The axis that will change color

    • color: Color

      The color to set

    Returns Promise<void>