Class TransformationGizmo

Represents a transformation gismo for manipulating elements.

Hierarchy

TransformationGizmo

Constructors

constructor

new TransformationGizmo(renderer: BaseRenderer, initOptions: RendererInititializationOptions): TransformationGizmo
Creates an instance of TransformationGismo.
Parameters
- renderer: BaseRenderer
  
  The renderer associated with the gismo.
- initOptions: RendererInititializationOptions
  
  Initialization options for the gismo.
Returns TransformationGizmo
- Defined in elements/gismo.ts:154

Accessors

boundingBoxVisible

get boundingBoxVisible(): boolean
Returns boolean
- Defined in elements/gismo.ts:177
set boundingBoxVisible(bBoxVisible: boolean): void
Parameters
- bBoxVisible: boolean
Returns void
- Defined in elements/gismo.ts:181

gismoHiddenEvent

get gismoHiddenEvent(): IEvent<BaseRenderer, GismoEvent>
Returns IEvent<BaseRenderer, GismoEvent>
- Defined in elements/gismo.ts:173

gismoShownEvent

get gismoShownEvent(): IEvent<BaseRenderer, GismoEvent>
Returns IEvent<BaseRenderer, GismoEvent>
- Defined in elements/gismo.ts:169

showing

get showing(): boolean
Returns boolean
- Defined in elements/gismo.ts:799

transformationMadeEvent

get transformationMadeEvent(): IEvent<BaseRenderer, TransformationMadeEvent>
Returns IEvent<BaseRenderer, TransformationMadeEvent>
- Defined in elements/gismo.ts:165

transforming

get transforming(): boolean
Returns boolean
- Defined in elements/gismo.ts:803

visibilityState

get visibilityState(): TransformGizmoVisibilityState
Returns TransformGizmoVisibilityState
- Defined in elements/gismo.ts:189
set visibilityState(state: TransformGizmoVisibilityState): void
Parameters
- state: TransformGizmoVisibilityState
Returns void
- Defined in elements/gismo.ts:193

Methods

cancelTransformation

cancelTransformation(): Promise<boolean>
Cancels the current transformation.

Returns
A promise that resolves to a boolean indicating success or failure.

Returns Promise<boolean>
- Defined in elements/gismo.ts:383

hide

hide(): Promise<void>
Hides the gismo.

Returns Promise<void>
- Defined in elements/gismo.ts:782

isRotating

isRotating(): boolean
Checks if the gismo is currently rotating.

Returns
Whether the gismo is rotating.

Returns boolean
- Defined in elements/gismo.ts:259

isScaling

isScaling(): boolean
Checks if the gismo is currently scaling.

Returns
Whether the gismo is scaling.

Returns boolean
- Defined in elements/gismo.ts:267

isTransforming

isTransforming(): boolean
Checks if the gismo is currently transforming.

Returns
Whether the gismo is transforming.

Returns boolean
- Defined in elements/gismo.ts:243

isTranslating

isTranslating(): boolean
Checks if the gismo is currently translating.

Returns
Whether the gismo is translating.

Returns boolean
- Defined in elements/gismo.ts:251

resetTransformation

resetTransformation(): Promise<boolean>
Resets the transformation.

Returns
A promise that resolves to a boolean indicating success or failure.

Returns Promise<boolean>
- Defined in elements/gismo.ts:466

setFixedTransformation

setFixedTransformation(value: number): Promise<boolean>
Sets a fixed transformation value.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- value: number
  
  The transformation value.
Returns Promise<boolean>
- Defined in elements/gismo.ts:289

setLabelOverridenValue

setLabelOverridenValue(value: string): Promise<boolean>
Parameters
- value: string
Returns Promise<boolean>
- Defined in elements/gismo.ts:271

setPivotPoint

setPivotPoint(pivot: Vector3D): Promise<boolean>
Sets the pivot point for the gismo.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- pivot: Vector3D
  
  The pivot point.
Returns Promise<boolean>
- Defined in elements/gismo.ts:758

show

show(internalIds: Int64[]): Promise<void>
Shows the gismo for the specified internal IDs.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
Returns Promise<void>
- Defined in elements/gismo.ts:727

showForCuttingPlane

showForCuttingPlane(planeIndex: number, reverted: boolean): Promise<void>
Shows the gismo for a cutting plane.
Parameters
- planeIndex: number
  
  The index of the cutting plane.
- reverted: boolean
  
  Whether the gismo is reverted.
Returns Promise<void>
- Defined in elements/gismo.ts:679

startTransformation

startTransformation(event: MouseButtonBimEvent): Promise<void>
Starts the transformation process.
Parameters
- event: MouseButtonBimEvent
  
  The mouse button event.
Returns Promise<void>
- Defined in elements/gismo.ts:372

stopTransformation

stopTransformation(event: MouseButtonBimEvent): Promise<boolean>
Stops the transformation process.

Returns
A promise that resolves to a boolean indicating success or failure.
Parameters
- event: MouseButtonBimEvent
  
  The mouse button event.
Returns Promise<boolean>
- Defined in elements/gismo.ts:430

transformingInternalIds

transformingInternalIds(): Int64[]
Returns Int64[]
- Defined in elements/gismo.ts:185