ViewerGizmoAPI¶

Interface ViewerGizmoAPI

Hierarchy

ViewerGizmoAPI
- ViewerAPI

Methods

createCollectionFromGizmo

createCollectionFromGizmo(includeOverlappingNodes): 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 | [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
Hides the currently visible Gizmo

Returns void

hidePointMarker

hidePointMarker(index?): void
Parameters
- Optional index: number
Returns void

setActiveItem

setActiveItem(id, type): void
Parameters
- id: number
- type: ActiveItemType
Returns void

setCORGizmoVisible

setCORGizmoVisible(flag): void
Parameters
- flag: boolean
Returns void

setGizmoTransformationMode

setGizmoTransformationMode(mode): void
Parameters
- mode: GizmoTransformationMode
Returns void

showAxisMarker

showAxisMarker(values, scale?, index?): void
Parameters
- values: Float32Array | [number, number, number, number, number, number]
- Optional scale: number
- Optional index: number
Returns void

showBoxGizmo

showBoxGizmo(properties?): void
Shows the BoxGizmo based on the specified properties. If the BoxGizmo is already visible the specified properties will be updated.
Parameters
- Optional properties: BoxGizmoProperties
  
  The properties of the BoxGizmo.
Returns void

showClippingBoxGizmo

showClippingBoxGizmo(clipRoomID): void
Parameters
- clipRoomID: number
Returns void

showPointMarker

showPointMarker(position, index?): void
Parameters
- position: Float32Array | [number, number, number]
- Optional index: number
Returns void

showSelectionBoxGizmo

showSelectionBoxGizmo(size?, transform?): 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?): void
Parameters
- Optional volume: BoxVolume
Returns void

showSelectionTransformationGizmo

showSelectionTransformationGizmo(nodeIds): void
Parameters
- nodeIds: number[]
Returns void

toggleStatsViewer

toggleStatsViewer(): void
Toggles the visibility of the Viewer statistics window.

Returns void