ViewerGizmoAPI

• ViewerGizmoAPI

Interface ViewerGizmoAPI

interface ViewerGizmoAPI {
    createCollectionFromGizmo(
        includeOverlappingNodes: boolean,
    ): Promise<number>;
    getActiveItem(): ActiveItemInfo;
    getAvailableGizmoTransformationModes(): number;
    getBoxGizmoProperties(): BoxGizmoProperties;
    getCurrentGizmoType(): GizmoType;
    getGizmoSize(): Vector3 | Float32Array<ArrayBufferLike>;
    getGizmoTransform(): Matrix4x4 | Float32Array<ArrayBufferLike>;
    getGizmoTransformationMode(): GizmoTransformationMode;
    hideAllLineMarkers(): void;
    hideAllMarkers(): void;
    hideAllPointMarkers(): void;
    hideGizmo(): void;
    hidePointMarker(index?: number): void;
    setActiveItem(id: number, type: ActiveItemType): void;
    setCORGizmoVisible(flag: boolean): void;
    setGizmoTransformationMode(mode: GizmoTransformationMode): void;
    showAxisMarker(
        values:
            | Float32Array<ArrayBufferLike>
            | [number, number, number, number, number, number],
        scale?: number,
        index?: number,
    ): void;
    showBoxGizmo(properties?: BoxGizmoProperties): void;
    showClippingBoxGizmo(clipRoomID: number): void;
    showPointMarker(
        position: Vector3 | Float32Array<ArrayBufferLike>,
        index?: number,
    ): void;
    showSelectionBoxGizmo(
        size?: Vector3 | Float32Array<ArrayBufferLike>,
        transform?: Matrix4x4 | Float32Array<ArrayBufferLike>,
    ): void;
    showSelectionBoxGizmoFromVolume(volume?: BoxVolume): void;
    showSelectionTransformationGizmo(nodeIds: number[]): void;
}

Hierarchy (View Summary)

• ViewerGizmoAPI
  • ViewerAPI

Index

Methods

createCollectionFromGizmo getActiveItem getAvailableGizmoTransformationModes getBoxGizmoProperties getCurrentGizmoType getGizmoSize getGizmoTransform getGizmoTransformationMode hideAllLineMarkers hideAllMarkers hideAllPointMarkers hideGizmo hidePointMarker setActiveItem setCORGizmoVisible setGizmoTransformationMode showAxisMarker showBoxGizmo showClippingBoxGizmo showPointMarker showSelectionBoxGizmo showSelectionBoxGizmoFromVolume showSelectionTransformationGizmo

Methods

createCollectionFromGizmo

• createCollectionFromGizmo(includeOverlappingNodes: boolean): Promise<number>

  Parameters

  • includeOverlappingNodes: boolean

  Returns Promise<number>

  Deprecated

  The CollectionAPI is deprecated and will be removed in a future release. Use ContextAPI.requestNodeIdsByBoxVolume instead:

  const ctx = webvis.getContext();
  const boxGizmoProps = ctx.getViewer().getBoxGizmoProperties();
  const nodeIds = await ctx.requestNodeIdsByBoxVolume(boxGizmoProps.volume, includeOverlappingNodes);
  

getActiveItem

• getActiveItem(): ActiveItemInfo

  Returns ActiveItemInfo

getAvailableGizmoTransformationModes

• getAvailableGizmoTransformationModes(): number

  Returns number

getBoxGizmoProperties

• getBoxGizmoProperties(): BoxGizmoProperties

  Returns the properties of the BoxGizmo

  Returns BoxGizmoProperties

  The properties of the BoxGizmo

getCurrentGizmoType

• getCurrentGizmoType(): GizmoType

  Returns GizmoType

getGizmoSize

• getGizmoSize(): Vector3 | Float32Array<ArrayBufferLike>

  Returns Vector3 | Float32Array<ArrayBufferLike>

getGizmoTransform

• getGizmoTransform(): Matrix4x4 | Float32Array<ArrayBufferLike>

  Returns Matrix4x4 | Float32Array<ArrayBufferLike>

getGizmoTransformationMode

• getGizmoTransformationMode(): GizmoTransformationMode

  Returns GizmoTransformationMode

hideAllLineMarkers

• hideAllLineMarkers(): void

  Returns void

hideAllMarkers

• hideAllMarkers(): void

  Returns void

hideAllPointMarkers

• hideAllPointMarkers(): void

  Returns void

hideGizmo

• hideGizmo(): void

  Hides the currently visible Gizmo

  Returns void

hidePointMarker

• hidePointMarker(index?: number): void

  Parameters

  • Optionalindex: number

  Returns void

setActiveItem

• setActiveItem(id: number, type: ActiveItemType): void

  Parameters

  • id: number
  • type: ActiveItemType

  Returns void

setCORGizmoVisible

• setCORGizmoVisible(flag: boolean): void

  Parameters

  • flag: boolean

  Returns void

setGizmoTransformationMode

• setGizmoTransformationMode(mode: GizmoTransformationMode): void

  Parameters

  • mode: GizmoTransformationMode

  Returns void

showAxisMarker

• showAxisMarker(
      values:
          | Float32Array<ArrayBufferLike>
          | [number, number, number, number, number, number],
      scale?: number,
      index?: number,
  ): void

  Parameters

  • values: Float32Array<ArrayBufferLike> | [number, number, number, number, number, number]
  • Optionalscale: number
  • Optionalindex: number

  Returns void

showBoxGizmo

• showBoxGizmo(properties?: BoxGizmoProperties): void

  Shows the BoxGizmo based on the specified properties. If the BoxGizmo is already visible the specified properties will be updated.

  Parameters

  • Optionalproperties: BoxGizmoProperties

    The properties of the BoxGizmo.

  Returns void

showClippingBoxGizmo

• showClippingBoxGizmo(clipRoomID: number): void

  Parameters

  • clipRoomID: number

  Returns void

showPointMarker

• showPointMarker(
      position: Vector3 | Float32Array<ArrayBufferLike>,
      index?: number,
  ): void

  Parameters

  • position: Vector3 | Float32Array<ArrayBufferLike>
  • Optionalindex: number

  Returns void

showSelectionBoxGizmo

• showSelectionBoxGizmo(
      size?: Vector3 | Float32Array<ArrayBufferLike>,
      transform?: Matrix4x4 | Float32Array<ArrayBufferLike>,
  ): void

  Parameters

  • Optionalsize: Vector3 | Float32Array<ArrayBufferLike>
  • Optionaltransform: Matrix4x4 | Float32Array<ArrayBufferLike>

  Returns void

showSelectionBoxGizmoFromVolume

• showSelectionBoxGizmoFromVolume(volume?: BoxVolume): void

  Parameters

  • Optionalvolume: BoxVolume

  Returns void

showSelectionTransformationGizmo

• showSelectionTransformationGizmo(nodeIds: number[]): void

  Parameters

  • nodeIds: number[]

  Returns void

---

Was this page helpful? Please leave a thumbs up or down.

👍 Yes 👎 No