Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ViewerGizmoAPI

• webVis API Reference
• ViewerGizmoAPI

Interface ViewerGizmoAPI

interface ViewerGizmoAPI {
    createCollectionFromGizmo(
        includeOverlappingNodes: boolean,
    ): Promise<number>;
    getActiveItem(): ActiveItemInfo;
    getAvailableGizmoTransformationModes(): number;
    getBoxGizmoProperties(): BoxGizmoProperties;
    getCurrentGizmoType(): GizmoType;
    getGizmoSize(): Float32Array<ArrayBufferLike> | [number, number, number];
    getGizmoTransform(): | Float32Array<ArrayBufferLike>
    | [
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
    ];
    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: Float32Array<ArrayBufferLike> | [number, number, number],
        index?: number,
    ): void;
    showSelectionBoxGizmo(
        size?: Float32Array<ArrayBufferLike> | [number, number, number],
        transform?:
            | Float32Array<ArrayBufferLike>
            | [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ],
    ): 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>

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(): Float32Array<ArrayBufferLike> | [number, number, number]

• Returns Float32Array<ArrayBufferLike> | [number, number, number]

getGizmoTransform

• getGizmoTransform(): | Float32Array<ArrayBufferLike>
  | [
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
  ]

• Returns
      | Float32Array<ArrayBufferLike>
      | [
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
      ]

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: Float32Array<ArrayBufferLike> | [number, number, number],
      index?: number,
  ): void

• Parameters

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

  Returns void

showSelectionBoxGizmo

• showSelectionBoxGizmo(
      size?: Float32Array<ArrayBufferLike> | [number, number, number],
      transform?:
          | Float32Array<ArrayBufferLike>
          | [
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
              number,
          ],
  ): void

• Parameters

  • Optionalsize: Float32Array<ArrayBufferLike> | [number, number, number]
  • Optionaltransform:
        | Float32Array<ArrayBufferLike>
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]

  Returns void

showSelectionBoxGizmoFromVolume

• showSelectionBoxGizmoFromVolume(volume?: BoxVolume): void

• Parameters

  • Optionalvolume: BoxVolume

  Returns void

showSelectionTransformationGizmo

• showSelectionTransformationGizmo(nodeIds: number[]): void

• Parameters

  • nodeIds: number[]

  Returns void