ViewerGizmoAPI

• webVis API Reference
• ViewerGizmoAPI

Interface ViewerGizmoAPI

Hierarchy

• ViewerGizmoAPI
  • ViewerAPI

Index

Methods

createCollectionFromGizmo getActiveItem getAvailableGizmoTransformationModes getCurrentGizmoType getGizmoSize getGizmoTransform getGizmoTransformationMode hideAllLineMarkers hideAllMarkers hideAllPointMarkers hideGizmo hidePointMarker setActiveItem setCORGizmoVisible setGizmoTransformationMode showAxisMarker 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

getCurrentGizmoType

• getCurrentGizmoType(): GizmoType

• Returns GizmoType

getGizmoSize

• getGizmoSize(): Float32Array | [number, number, number]

• Returns Float32Array | [number, number, number]

getGizmoTransform

• getGizmoTransform(): Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

• Returns Float32Array | [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

• Returns void

hidePointMarker

• hidePointMarker(index?: number): void

• Parameters

  • Optional index: number

  Returns void

setActiveItem

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

• Parameters

  • id: number

  • type: NodeType

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

• Parameters

  • values: Float32Array | [number, number, number]

  • Optional scale: number

  • Optional index: number

  Returns void

showClippingBoxGizmo

• showClippingBoxGizmo(clipRoomID: number): void

• Parameters

  • clipRoomID: number

  Returns void

showPointMarker

• showPointMarker(position: Float32Array | [number, number, number], index?: number): void

• Parameters

  • position: Float32Array | [number, number, number]

  • Optional index: number

  Returns void

showSelectionBoxGizmo

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

• Parameters

  • Optional size: Float32Array | [number, number, number]

  • Optional transform: Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

  Returns void

showSelectionBoxGizmoFromVolume

• showSelectionBoxGizmoFromVolume(volume?: BoxVolume): void

• Parameters

  • Optional volume: BoxVolume

  Returns void

showSelectionTransformationGizmo

• showSelectionTransformationGizmo(nodeIds: number[]): void

• Parameters

  • nodeIds: number[]

  Returns void