API Reference › Globals › DimensioningHelper
# Class: DimensioningHelper
# Hierarchy
- DimensioningHelper
# Implements
# Index
# Constructors
# Properties
# Methods
- _clear
- addToScene
- areDimensionsEnabled
- clearScene
- disableDimensions
- disableTopDimensions
- enableDimensions
- enableTopDimensions
- getBoundingBox
- isInitialized
- moveCameraEnd
- moveCameraStart
- needsUiScene
- onDimensionsVisibilityChanged
- removeFromScene
- setScene
- setUiScene
- update
- updateBounds
# Constructors
# constructor
+ new DimensioningHelper(creator: string): DimensioningHelper
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:43
Parameters:
| Name | Type |
|---|---|
creator | string |
Returns: DimensioningHelper
# Properties
# creator
• creator: string
_Implementation of ScenePlugin.creator_
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:15
# Methods
# _clear
▸ _clear(): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:268
Returns: void
# addToScene
▸ addToScene(scene: Scene, uiScene: Scene): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:173
Parameters:
| Name | Type |
|---|---|
scene | Scene |
uiScene | Scene |
Returns: void
# areDimensionsEnabled
▸ areDimensionsEnabled(): boolean
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:337
Returns: boolean
# clearScene
▸ clearScene(_scene: Scene): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:317
Parameters:
| Name | Type |
|---|---|
_scene | Scene |
Returns: void
# disableDimensions
▸ disableDimensions(): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:253
Returns: void
# disableTopDimensions
▸ disableTopDimensions(): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:240
Returns: void
# enableDimensions
▸ enableDimensions(): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:247
Returns: void
# enableTopDimensions
▸ enableTopDimensions(): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:232
Returns: void
# getBoundingBox
▸ getBoundingBox(): Box3
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:281
Returns: Box3
# isInitialized
▸ isInitialized(): Promise‹void›
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:333
Returns: Promise‹void›
# moveCameraEnd
▸ moveCameraEnd(position: Vector3): void
Implementation of ScenePlugin
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:311
Parameters:
| Name | Type |
|---|---|
position | Vector3 |
Returns: void
# moveCameraStart
▸ moveCameraStart(position: Vector3): void
Implementation of ScenePlugin
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:305
Parameters:
| Name | Type |
|---|---|
position | Vector3 |
Returns: void
# needsUiScene
▸ needsUiScene(): boolean
Implementation of ScenePlugin
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:329
Returns: boolean
# onDimensionsVisibilityChanged
▸ onDimensionsVisibilityChanged(handler: function): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:228
Parameters:
▪ handler: function
▸ (visible: boolean): void
Parameters:
| Name | Type |
|---|---|
visible | boolean |
Returns: void
# removeFromScene
▸ removeFromScene(scene: Scene, uiScene: Scene): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:187
Parameters:
| Name | Type |
|---|---|
scene | Scene |
uiScene | Scene |
Returns: void
# setScene
▸ setScene(scene: Scene): void
Implementation of ScenePlugin
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:321
Parameters:
| Name | Type |
|---|---|
scene | Scene |
Returns: void
# setUiScene
▸ setUiScene(uiScene: Scene): void
Implementation of ScenePlugin
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:325
Parameters:
| Name | Type |
|---|---|
uiScene | Scene |
Returns: void
# update
▸ update(force: boolean): void
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:165
Parameters:
| Name | Type | Default |
|---|---|---|
force | boolean | false |
Returns: void
# updateBounds
▸ updateBounds(boxForMeasurements: Box3): void
Implementation of ScenePlugin
Defined in packages/configurator-core/src/utils/dimensioning-helper.ts:154
Parameters:
| Name | Type |
|---|---|
boxForMeasurements | Box3 |
Returns: void