# Class: default
configurator-core/src/roomle-configurator.
# Hierarchy
-
↳
default
# Table of contents
# Constructors
# Properties
# Accessors
- callbacks
- configurationExporter
- kernelContainer
- kernelInstance
- planInteractionHandler
- planModelViewHelper
# Methods
- Editor3ChangedNamedMesh
- Editor3dAddBakedMesh
- Editor3dAddCube
- Editor3dAddCubeUVMod
- Editor3dAddCylinder
- Editor3dAddCylinderUVMod
- Editor3dAddDockPreview
- Editor3dAddFittingLine
- Editor3dAddFittingPoint
- Editor3dAddMesh
- Editor3dAddMeshUVCoord
- Editor3dAddMeshUVMod
- Editor3dAddNamedMesh
- Editor3dAddPrism
- Editor3dAddPrismUVMod
- Editor3dAddRectangle
- Editor3dAddRectangleUVMod
- Editor3dAddSphere
- Editor3dAddSphereUVMod
- Editor3dBeginConstruction
- Editor3dBeginGroup
- Editor3dComponentCreated
- Editor3dComponentDocked
- Editor3dCopy
- Editor3dEndConstruction
- Editor3dEndGroup
- Editor3dGeometryNotReady
- Editor3dGeometryReady
- Editor3dLoadMaterial
- Editor3dPlanObjectConstructionDone
- Editor3dPreviewConstructionDone
- Editor3dRemoveNamedMesh
- Editor3dRotateAround
- Editor3dRotateBy
- Editor3dSelectObject
- Editor3dSetMaterial
- Editor3dSetPreviewLineAssociations
- Editor3dSetPreviewPointAssociations
- Editor3dTranslateBy
- Editor3dUpdatePlanComponentPosition
- Editor3dUpdatePlanComponentRotation
- Editor3dUpdatePlanComponentTransform
- Editor3dUpdatePlanObjectPosition
- Editor3dUpdatePlanObjectRotation
- Editor3dUpdatePlanObjectTransform
- addConfiguratorListener
- addMesh
- addPlanMesh
- addPlanObjectFromItem
- addPlannerListener
- addUiDataAndPriceToPartList
- addUiDataToPartList
- beginConstruction
- beginPlanConstruction
- calcPartsPriceSum
- catalogItemLoaded
- changeCommonComponentParameter
- changeComponentParameter
- changePlanObjectParameter
- changeUseOfHDGeometry
- cleanUpCallbacks
- componentConfigurationUpdated
- componentDefinitionLoaded
- componentDefinitionLoadingError
- componentDeleted
- componentMetaUpdated
- componentParameters
- configurationLoaded
- configurationLoadingError
- coupleReferences
- createNewSerializedConfiguration
- destroy
- dockComponent
- dockComponentWithPosition
- duplicateItems
- endConstruction
- endPlanConstruction
- getConfigurationData
- getConfigurationHash
- getCurrentConfigurationHash
- getGlobalParameters
- getParameterGroups
- getPartList
- getRuntimeComponentId
- getRuntimeComponentIdOfRootComponent
- getSerializedConfiguration
- handlerSwitchedPlans
- init
- insertItems
- isConstructionPlanElement
- isReady
- listOfVariants
- listOfVariantsError
- loadComponent
- loadComponentIntoKernel
- loadConfiguration
- loadItemConfigurations
- loadSubComponent
- multiSelectionChange
- onLoadComponentError
- pause
- planBoundsChanged
- planCleared
- planCompletelyLoaded
- planElement3dMeshChanged
- planElementAdded
- planElementChanged
- planElementRemoved
- planHistoryStateChanged
- planObjectConfigurationCreated
- planObjectConfigurationLoaded
- planObjectConfigurationUpdated
- planObjectCreated
- planObjectDeleted
- planObjectUpdated
- previewDockingsWithDrag
- registerCallbacks
- removeConfiguratorListener
- removePlannerListener
- requestCatalogItem
- requestComponentDimensions
- requestDeleteComponent
- requestDeleteComponents
- requestDeletePlanComponent
- requestExternalMesh
- requestMaterialProperties
- requestMaterialsInGroup
- requestPartListAndUpdatePricesOfParts
- requestPlanComponentConstruction
- requestPlanObjectConstruction
- requestPlanObjectDimensions
- requestSync
- resume
- sceneCleared
- selectedComponent
- selectionChange
- setActiveGroupInView
- setActiveGroupInViewForPlanObject
- startedDrawing
- stoppedDrawing
- uiRequestConfiguration
- updateMesh2d
- updatePlanObjectDependencies
- webGlPreviewDockings
# Constructors
# constructor
• new default(creator)
# Parameters
| Name | Type |
|---|---|
creator | string |
# Overrides
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:108 (opens new window)
# Properties
# _creator_
• _creator_: string
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:95 (opens new window)
# externalMeshQueue
• externalMeshQueue: PromiseQueue<void>
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:106 (opens new window)
# muteKernelCallbacks
• muteKernelCallbacks: boolean = false
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:108 (opens new window)
# Accessors
# callbacks
• get callbacks(): default
# Returns
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:187 (opens new window)
# configurationExporter
• get configurationExporter(): ConfigurationExporter
# Returns
# Inherited from
ConfiguratorKernelAccess.configurationExporter
# Defined in
packages/common-core/src/services/common-kernel-access.ts:231 (opens new window)
# kernelContainer
• get kernelContainer(): any
# Returns
any
# Overrides
ConfiguratorKernelAccess.kernelContainer
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:104 (opens new window)
# kernelInstance
• get kernelInstance(): ConfiguratorKernelClass
# Returns
# Inherited from
ConfiguratorKernelAccess.kernelInstance
# Defined in
packages/common-core/src/services/common-kernel-access.ts:227 (opens new window)
# planInteractionHandler
• get planInteractionHandler(): PlanInteractionHandler
# Returns
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:191 (opens new window)
# planModelViewHelper
• get planModelViewHelper(): PlanModelViewHelper
# Returns
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:195 (opens new window)
# Methods
# Editor3ChangedNamedMesh
▸ Editor3ChangedNamedMesh(runtimeComponentId, meshId, geometryId, materialId, transform, uvTransform, materialAttributes): void
# Parameters
| Name | Type |
|---|---|
runtimeComponentId | number |
meshId | string |
geometryId | string |
materialId | string |
transform | Float32Array |
uvTransform | Float32Array |
materialAttributes | Record<string, string> |
# Returns
void
# Inherited from
default.Editor3ChangedNamedMesh
# Defined in
packages/common-core/src/services/common-kernel-access.ts:629 (opens new window)
# Editor3dAddBakedMesh
▸ Editor3dAddBakedMesh(runtimeComponentId, materialId, vertices, indices, uvCoords, normals, environmentGeometry, materialAttributes): void
# Parameters
| Name | Type |
|---|---|
runtimeComponentId | number |
materialId | string |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
environmentGeometry | boolean |
materialAttributes | Record<string, string> |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:573 (opens new window)
# Editor3dAddCube
▸ Editor3dAddCube(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1008 (opens new window)
# Editor3dAddCubeUVMod
▸ Editor3dAddCubeUVMod(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1012 (opens new window)
# Editor3dAddCylinder
▸ Editor3dAddCylinder(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1044 (opens new window)
# Editor3dAddCylinderUVMod
▸ Editor3dAddCylinderUVMod(): void
# Returns
void
# Inherited from
default.Editor3dAddCylinderUVMod
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1048 (opens new window)
# Editor3dAddDockPreview
▸ Editor3dAddDockPreview(componentId, previewId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
previewId | number |
# Returns
void
# Inherited from
default.Editor3dAddDockPreview
# Defined in
packages/common-core/src/configurator-kernel-access.ts:966 (opens new window)
# Editor3dAddFittingLine
▸ Editor3dAddFittingLine(): void
# Returns
void
# Inherited from
default.Editor3dAddFittingLine
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1064 (opens new window)
# Editor3dAddFittingPoint
▸ Editor3dAddFittingPoint(): void
# Returns
void
# Inherited from
default.Editor3dAddFittingPoint
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1060 (opens new window)
# Editor3dAddMesh
▸ Editor3dAddMesh(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1032 (opens new window)
# Editor3dAddMeshUVCoord
▸ Editor3dAddMeshUVCoord(): void
# Returns
void
# Inherited from
default.Editor3dAddMeshUVCoord
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1040 (opens new window)
# Editor3dAddMeshUVMod
▸ Editor3dAddMeshUVMod(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1036 (opens new window)
# Editor3dAddNamedMesh
▸ Editor3dAddNamedMesh(runtimeComponentId, meshId, geometryId, materialId, transform, vertices, indices, uvCoords, normals, environmentGeometry, uvTransform, materialAttributes): void
# Parameters
| Name | Type |
|---|---|
runtimeComponentId | number |
meshId | string |
geometryId | string |
materialId | string |
transform | Float32Array |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
environmentGeometry | boolean |
uvTransform | Float32Array |
materialAttributes | Record<string, string> |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:597 (opens new window)
# Editor3dAddPrism
▸ Editor3dAddPrism(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1052 (opens new window)
# Editor3dAddPrismUVMod
▸ Editor3dAddPrismUVMod(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1056 (opens new window)
# Editor3dAddRectangle
▸ Editor3dAddRectangle(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1024 (opens new window)
# Editor3dAddRectangleUVMod
▸ Editor3dAddRectangleUVMod(): void
# Returns
void
# Inherited from
default.Editor3dAddRectangleUVMod
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1028 (opens new window)
# Editor3dAddSphere
▸ Editor3dAddSphere(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1016 (opens new window)
# Editor3dAddSphereUVMod
▸ Editor3dAddSphereUVMod(): void
# Returns
void
# Inherited from
default.Editor3dAddSphereUVMod
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1020 (opens new window)
# Editor3dBeginConstruction
▸ Editor3dBeginConstruction(id, isDeltaUpdate): void
# Parameters
| Name | Type |
|---|---|
id | number |
isDeltaUpdate | boolean |
# Returns
void
# Inherited from
default.Editor3dBeginConstruction
# Defined in
packages/common-core/src/services/common-kernel-access.ts:660 (opens new window)
# Editor3dBeginGroup
▸ Editor3dBeginGroup(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:950 (opens new window)
# Editor3dComponentCreated
▸ Editor3dComponentCreated(id, position, eulerAngles, isRootComponent, parentId): void
# Parameters
| Name | Type |
|---|---|
id | number |
position | KernelVector3 |
eulerAngles | KernelVector3 |
isRootComponent | boolean |
parentId | number |
# Returns
void
# Inherited from
default.Editor3dComponentCreated
# Defined in
packages/common-core/src/configurator-kernel-access.ts:902 (opens new window)
# Editor3dComponentDocked
▸ Editor3dComponentDocked(componentId, isRootComponent, parentId, componentPosition, componentRotation): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
isRootComponent | boolean |
parentId | number |
componentPosition | KernelVector3 |
componentRotation | KernelVector3 |
# Returns
void
# Inherited from
default.Editor3dComponentDocked
# Defined in
packages/common-core/src/services/common-kernel-access.ts:690 (opens new window)
# Editor3dCopy
▸ Editor3dCopy(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1072 (opens new window)
# Editor3dEndConstruction
▸ Editor3dEndConstruction(id): void
# Parameters
| Name | Type |
|---|---|
id | number |
# Returns
void
# Inherited from
default.Editor3dEndConstruction
# Defined in
packages/common-core/src/services/common-kernel-access.ts:666 (opens new window)
# Editor3dEndGroup
▸ Editor3dEndGroup(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:954 (opens new window)
# Editor3dGeometryNotReady
▸ Editor3dGeometryNotReady(id): void
# Parameters
| Name | Type |
|---|---|
id | number |
# Returns
void
# Inherited from
default.Editor3dGeometryNotReady
# Defined in
packages/common-core/src/services/common-kernel-access.ts:716 (opens new window)
# Editor3dGeometryReady
▸ Editor3dGeometryReady(id): void
# Parameters
| Name | Type |
|---|---|
id | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:708 (opens new window)
# Editor3dLoadMaterial
▸ Editor3dLoadMaterial(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:962 (opens new window)
# Editor3dPlanObjectConstructionDone
▸ Editor3dPlanObjectConstructionDone(planObjectId): void
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
# Returns
void
# Inherited from
default.Editor3dPlanObjectConstructionDone
# Defined in
packages/common-core/src/configurator-kernel-access.ts:932 (opens new window)
# Editor3dPreviewConstructionDone
▸ Editor3dPreviewConstructionDone(componentId, objectId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
objectId | number |
# Returns
void
# Inherited from
default.Editor3dPreviewConstructionDone
# Defined in
packages/common-core/src/configurator-kernel-access.ts:987 (opens new window)
# Editor3dRemoveNamedMesh
▸ Editor3dRemoveNamedMesh(runtimeComponentId, geometryId): void
# Parameters
| Name | Type |
|---|---|
runtimeComponentId | number |
geometryId | string |
# Returns
void
# Inherited from
default.Editor3dRemoveNamedMesh
# Defined in
packages/common-core/src/services/common-kernel-access.ts:651 (opens new window)
# Editor3dRotateAround
▸ Editor3dRotateAround(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1004 (opens new window)
# Editor3dRotateBy
▸ Editor3dRotateBy(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1000 (opens new window)
# Editor3dSelectObject
▸ Editor3dSelectObject(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1068 (opens new window)
# Editor3dSetMaterial
▸ Editor3dSetMaterial(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:958 (opens new window)
# Editor3dSetPreviewLineAssociations
▸ Editor3dSetPreviewLineAssociations(dockLines, previewId): void
# Parameters
| Name | Type |
|---|---|
dockLines | any |
previewId | number |
# Returns
void
# Inherited from
default.Editor3dSetPreviewLineAssociations
# Defined in
packages/common-core/src/configurator-kernel-access.ts:981 (opens new window)
# Editor3dSetPreviewPointAssociations
▸ Editor3dSetPreviewPointAssociations(dockPairs, previewId): void
# Parameters
| Name | Type |
|---|---|
dockPairs | any |
previewId | number |
# Returns
void
# Inherited from
default.Editor3dSetPreviewPointAssociations
# Defined in
packages/common-core/src/configurator-kernel-access.ts:972 (opens new window)
# Editor3dTranslateBy
▸ Editor3dTranslateBy(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:996 (opens new window)
# Editor3dUpdatePlanComponentPosition
▸ Editor3dUpdatePlanComponentPosition(): void
# Returns
void
# Inherited from
default.Editor3dUpdatePlanComponentPosition
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1088 (opens new window)
# Editor3dUpdatePlanComponentRotation
▸ Editor3dUpdatePlanComponentRotation(): void
# Returns
void
# Inherited from
default.Editor3dUpdatePlanComponentRotation
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1092 (opens new window)
# Editor3dUpdatePlanComponentTransform
▸ Editor3dUpdatePlanComponentTransform(): void
# Returns
void
# Inherited from
default.Editor3dUpdatePlanComponentTransform
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1096 (opens new window)
# Editor3dUpdatePlanObjectPosition
▸ Editor3dUpdatePlanObjectPosition(): void
# Returns
void
# Inherited from
default.Editor3dUpdatePlanObjectPosition
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1076 (opens new window)
# Editor3dUpdatePlanObjectRotation
▸ Editor3dUpdatePlanObjectRotation(): void
# Returns
void
# Inherited from
default.Editor3dUpdatePlanObjectRotation
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1080 (opens new window)
# Editor3dUpdatePlanObjectTransform
▸ Editor3dUpdatePlanObjectTransform(): void
# Returns
void
# Inherited from
default.Editor3dUpdatePlanObjectTransform
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1084 (opens new window)
# addConfiguratorListener
▸ addConfiguratorListener(listener): void
# Parameters
| Name | Type |
|---|---|
listener | ConfiguratorKernelCallbackI |
# Returns
void
# Inherited from
default.addConfiguratorListener
# Defined in
packages/common-core/src/services/common-kernel-access.ts:811 (opens new window)
# addMesh
▸ addMesh(planElement, material, vertices, indices, uvCoords, normals): void
# Parameters
| Name | Type |
|---|---|
planElement | PlanElement |
material | any |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:570 (opens new window)
# addPlanMesh
▸ addPlanMesh(plan, material, vertices, indices, uvCoords, normals, type): void
# Parameters
| Name | Type |
|---|---|
plan | Plan |
material | any |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
type | KernelEnum |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:602 (opens new window)
# addPlanObjectFromItem
▸ addPlanObjectFromItem(rapiElement, position?, rotation?): Promise<number>
# Parameters
| Name | Type |
|---|---|
rapiElement | RapiItem | RapiConfiguration |
position? | Position3 |
rotation? | number |
# Returns
Promise<number>
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:632 (opens new window)
# addPlannerListener
▸ addPlannerListener(listener): void
# Parameters
| Name | Type |
|---|---|
listener | PlannerKernelCallbackI |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:151 (opens new window)
# addUiDataAndPriceToPartList
▸ addUiDataAndPriceToPartList(partList, hash): Promise<KernelPartList>
# Parameters
| Name | Type |
|---|---|
partList | KernelPartList |
hash | string |
# Returns
Promise<KernelPartList>
# Inherited from
default.addUiDataAndPriceToPartList
# Defined in
packages/common-core/src/services/common-kernel-access.ts:999 (opens new window)
# addUiDataToPartList
▸ addUiDataToPartList(partList, hash): KernelPart[]
# Parameters
| Name | Type |
|---|---|
partList | KernelPart[] |
hash | string |
# Returns
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:1053 (opens new window)
# beginConstruction
▸ beginConstruction(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:566 (opens new window)
# beginPlanConstruction
▸ beginPlanConstruction(plan): void
# Parameters
| Name | Type |
|---|---|
plan | Plan |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:595 (opens new window)
# calcPartsPriceSum
▸ calcPartsPriceSum(partList): Promise<KernelPartListPrice>
# Parameters
| Name | Type |
|---|---|
partList | KernelPartList |
# Returns
Promise<KernelPartListPrice>
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:911 (opens new window)
# catalogItemLoaded
▸ catalogItemLoaded(catalogItem): void
# Parameters
| Name | Type |
|---|---|
catalogItem | RapiItem |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:199 (opens new window)
# changeCommonComponentParameter
▸ changeCommonComponentParameter(componentIds, parameterKey, type, value, resolve, reject): void
# Parameters
| Name | Type |
|---|---|
componentIds | number[] |
parameterKey | string |
type | string |
value | string |
resolve | () => void |
reject | () => void |
# Returns
void
# Inherited from
default.changeCommonComponentParameter
# Defined in
packages/common-core/src/configurator-kernel-access.ts:436 (opens new window)
# changeComponentParameter
▸ changeComponentParameter(componentId, parameterKey, type, value, resolve, reject): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
parameterKey | string |
type | string |
value | string |
resolve | () => void |
reject | () => void |
# Returns
void
# Inherited from
default.changeComponentParameter
# Defined in
packages/common-core/src/configurator-kernel-access.ts:469 (opens new window)
# changePlanObjectParameter
▸ changePlanObjectParameter(planObjectId, parameterKey, type, value, resolve, reject): void
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
parameterKey | string |
type | string |
value | string |
resolve | () => void |
reject | () => void |
# Returns
void
# Inherited from
default.changePlanObjectParameter
# Defined in
packages/common-core/src/configurator-kernel-access.ts:494 (opens new window)
# changeUseOfHDGeometry
▸ changeUseOfHDGeometry(context, useHDGeometry): void
# Parameters
| Name | Type |
|---|---|
context | default |
useHDGeometry | boolean |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:353 (opens new window)
# cleanUpCallbacks
▸ cleanUpCallbacks(): void
# Returns
void
# Overrides
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:296 (opens new window)
# componentConfigurationUpdated
▸ componentConfigurationUpdated(componentId, geometryChanged): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
geometryChanged | boolean |
# Returns
void
# Inherited from
default.componentConfigurationUpdated
# Defined in
packages/common-core/src/configurator-kernel-access.ts:750 (opens new window)
# componentDefinitionLoaded
▸ componentDefinitionLoaded(conversationId, componentId): void
# Parameters
| Name | Type |
|---|---|
conversationId | number |
componentId | number |
# Returns
void
# Inherited from
default.componentDefinitionLoaded
# Defined in
packages/common-core/src/configurator-kernel-access.ts:705 (opens new window)
# componentDefinitionLoadingError
▸ componentDefinitionLoadingError(conversationId, errorMessage): void
# Parameters
| Name | Type |
|---|---|
conversationId | number |
errorMessage | string |
# Returns
void
# Inherited from
default.componentDefinitionLoadingError
# Defined in
packages/common-core/src/configurator-kernel-access.ts:715 (opens new window)
# componentDeleted
▸ componentDeleted(componentId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:723 (opens new window)
# componentMetaUpdated
▸ componentMetaUpdated(componentId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:729 (opens new window)
# componentParameters
▸ componentParameters(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:775 (opens new window)
# configurationLoaded
▸ configurationLoaded(conversationId, objectId, componentId, hash, errors, _valid): void
# Parameters
| Name | Type |
|---|---|
conversationId | number |
objectId | number |
componentId | number |
hash | string |
errors | any[] |
_valid | boolean |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:679 (opens new window)
# configurationLoadingError
▸ configurationLoadingError(_runtimeId, errors?): void
# Parameters
| Name | Type |
|---|---|
_runtimeId | number |
errors? | any[] |
# Returns
void
# Inherited from
default.configurationLoadingError
# Defined in
packages/common-core/src/configurator-kernel-access.ts:726 (opens new window)
# coupleReferences
▸ coupleReferences(jsObject, coreReference): void
# Parameters
| Name | Type |
|---|---|
jsObject | any |
coreReference | KernelObject |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:678 (opens new window)
# createNewSerializedConfiguration
▸ createNewSerializedConfiguration(configurationRuntimeId): string
# Parameters
| Name | Type |
|---|---|
configurationRuntimeId | number |
# Returns
string
# Inherited from
default.createNewSerializedConfiguration
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1138 (opens new window)
# destroy
▸ destroy(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:881 (opens new window)
# dockComponent
▸ dockComponent(parentId, parentDockId, childId, childDockId): void
# Parameters
| Name | Type |
|---|---|
parentId | number |
parentDockId | number |
childId | number |
childDockId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:330 (opens new window)
# dockComponentWithPosition
▸ dockComponentWithPosition(parentId, parentDockId, childId, childDockId, position): void
# Parameters
| Name | Type |
|---|---|
parentId | number |
parentDockId | number |
childId | number |
childDockId | number |
position | KernelVector3 |
# Returns
void
# Inherited from
default.dockComponentWithPosition
# Defined in
packages/common-core/src/services/common-kernel-access.ts:548 (opens new window)
# duplicateItems
▸ duplicateItems(planObjects): PlanObject[]
# Parameters
| Name | Type |
|---|---|
planObjects | PlanObject[] |
# Returns
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:259 (opens new window)
# endConstruction
▸ endConstruction(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:591 (opens new window)
# endPlanConstruction
▸ endPlanConstruction(plan): void
# Parameters
| Name | Type |
|---|---|
plan | Plan |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:625 (opens new window)
# getConfigurationData
▸ getConfigurationData(planObjectId): Promise<RapiConfiguration>
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
# Returns
Promise<RapiConfiguration>
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:402 (opens new window)
# getConfigurationHash
▸ getConfigurationHash(context): Promise<string>
# Parameters
| Name | Type |
|---|---|
context | default |
# Returns
Promise<string>
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:610 (opens new window)
# getCurrentConfigurationHash
▸ getCurrentConfigurationHash(planObjectId): string
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
# Returns
string
# Inherited from
default.getCurrentConfigurationHash
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1144 (opens new window)
# getGlobalParameters
▸ getGlobalParameters(planObjectId, rootComponentParametersAsGlobal): Promise<KernelParameter[]>
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
rootComponentParametersAsGlobal | boolean |
# Returns
Promise<KernelParameter[]>
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:584 (opens new window)
# getParameterGroups
▸ getParameterGroups(): KernelParameterGroup[]
# Returns
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1114 (opens new window)
# getPartList
▸ getPartList(): Promise<unknown>
# Returns
Promise<unknown>
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:603 (opens new window)
# getRuntimeComponentId
▸ getRuntimeComponentId(runtimeComponentId): string
# Parameters
| Name | Type |
|---|---|
runtimeComponentId | number |
# Returns
string
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1110 (opens new window)
# getRuntimeComponentIdOfRootComponent
▸ getRuntimeComponentIdOfRootComponent(planObjectId): number
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
# Returns
number
# Inherited from
default.getRuntimeComponentIdOfRootComponent
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1100 (opens new window)
# getSerializedConfiguration
▸ getSerializedConfiguration(objectId): string
# Parameters
| Name | Type |
|---|---|
objectId | number |
# Returns
string
# Inherited from
default.getSerializedConfiguration
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1134 (opens new window)
# handlerSwitchedPlans
▸ handlerSwitchedPlans(fromPlan, toPlan): void
# Parameters
| Name | Type |
|---|---|
fromPlan | Plan |
toPlan | Plan |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:336 (opens new window)
# init
▸ init(kernelType): void
# Parameters
| Name | Type |
|---|---|
kernelType | KERNEL_TYPE |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:114 (opens new window)
# insertItems
▸ insertItems(itemList): Promise<number[]>
# Parameters
| Name | Type |
|---|---|
itemList | (RapiItem | RapiConfiguration)[] |
# Returns
Promise<number[]>
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:204 (opens new window)
# isConstructionPlanElement
▸ isConstructionPlanElement(planElement): boolean
# Parameters
| Name | Type |
|---|---|
planElement | PlanElement |
# Returns
boolean
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:693 (opens new window)
# isReady
▸ isReady(): void
# Returns
void
# Overrides
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:159 (opens new window)
# listOfVariants
▸ listOfVariants(_componentId, _list): void
# Parameters
| Name | Type |
|---|---|
_componentId | string |
_list | VariantsList |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1148 (opens new window)
# listOfVariantsError
▸ listOfVariantsError(dbId, error): void
# Parameters
| Name | Type |
|---|---|
dbId | string |
error | string |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1150 (opens new window)
# loadComponent
▸ loadComponent(conversationId, configuration, parentId): void
# Parameters
| Name | Type |
|---|---|
conversationId | number |
configuration | ConfigurationObject |
parentId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:434 (opens new window)
# loadComponentIntoKernel
▸ loadComponentIntoKernel(component, componentId): void
# Parameters
| Name | Type |
|---|---|
component | string |
componentId | string |
# Returns
void
# Inherited from
default.loadComponentIntoKernel
# Defined in
packages/common-core/src/configurator-kernel-access.ts:550 (opens new window)
# loadConfiguration
▸ loadConfiguration(configuration): void
# Parameters
| Name | Type |
|---|---|
configuration | string |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:413 (opens new window)
# loadItemConfigurations
▸ loadItemConfigurations(conversationId, itemIds): Promise<void>
# Parameters
| Name | Type |
|---|---|
conversationId | number |
itemIds | string[] |
# Returns
Promise<void>
# Inherited from
default.loadItemConfigurations
# Defined in
packages/common-core/src/services/common-kernel-access.ts:514 (opens new window)
# loadSubComponent
▸ loadSubComponent(parentId, partId, componentId): void
# Parameters
| Name | Type |
|---|---|
parentId | number |
partId | number |
componentId | string |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:477 (opens new window)
# multiSelectionChange
▸ multiSelectionChange(runtimeComponentIds, rootComponentId): void
# Parameters
| Name | Type |
|---|---|
runtimeComponentIds | number[] |
rootComponentId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:209 (opens new window)
# onLoadComponentError
▸ onLoadComponentError(error, id): void
# Parameters
| Name | Type |
|---|---|
error | Error |
id | string |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:675 (opens new window)
# pause
▸ pause(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:872 (opens new window)
# planBoundsChanged
▸ planBoundsChanged(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:346 (opens new window)
# planCleared
▸ planCleared(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:352 (opens new window)
# planCompletelyLoaded
▸ planCompletelyLoaded(plan): void
# Parameters
| Name | Type |
|---|---|
plan | Plan |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:359 (opens new window)
# planElement3dMeshChanged
▸ planElement3dMeshChanged(plan, element): void
# Parameters
| Name | Type |
|---|---|
plan | Plan |
element | PlanElement |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:366 (opens new window)
# planElementAdded
▸ planElementAdded(plan, element): Promise<void>
# Parameters
| Name | Type |
|---|---|
plan | Plan |
element | PlanElement |
# Returns
Promise<void>
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:435 (opens new window)
# planElementChanged
▸ planElementChanged(plan, element): void
# Parameters
| Name | Type |
|---|---|
plan | Plan |
element | KernelObject |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:494 (opens new window)
# planElementRemoved
▸ planElementRemoved(element): void
# Parameters
| Name | Type |
|---|---|
element | PlanElement |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:326 (opens new window)
# planHistoryStateChanged
▸ planHistoryStateChanged(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:505 (opens new window)
# planObjectConfigurationCreated
▸ planObjectConfigurationCreated(_plan, _element): void
# Parameters
| Name | Type |
|---|---|
_plan | Plan |
_element | PlanObject |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:519 (opens new window)
# planObjectConfigurationLoaded
▸ planObjectConfigurationLoaded(plan, element, success): void
# Parameters
| Name | Type |
|---|---|
plan | Plan |
element | PlanElement |
success | boolean |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:527 (opens new window)
# planObjectConfigurationUpdated
▸ planObjectConfigurationUpdated(planObjectId, configuration, hash, _rootPlanComponentId, _valid, pendingDocking): Promise<void>
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
configuration | string |
hash | string |
_rootPlanComponentId | number |
_valid | boolean |
pendingDocking | boolean |
# Returns
Promise<void>
# Inherited from
default.planObjectConfigurationUpdated
# Defined in
packages/common-core/src/configurator-kernel-access.ts:799 (opens new window)
# planObjectCreated
▸ planObjectCreated(conversationId, planObjectId): void
# Parameters
| Name | Type |
|---|---|
conversationId | number |
planObjectId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:784 (opens new window)
# planObjectDeleted
▸ planObjectDeleted(): void
# Returns
void
# Overrides
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:288 (opens new window)
# planObjectUpdated
▸ planObjectUpdated(planObjectId, pendingDocking): void
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
pendingDocking | boolean |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:790 (opens new window)
# previewDockingsWithDrag
▸ previewDockingsWithDrag(componentId, planObjectId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
planObjectId | number |
# Returns
void
# Inherited from
default.previewDockingsWithDrag
# Defined in
packages/common-core/src/configurator-kernel-access.ts:405 (opens new window)
# registerCallbacks
▸ registerCallbacks(): void
# Returns
void
# Overrides
ConfiguratorKernelAccess.registerCallbacks
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:303 (opens new window)
# removeConfiguratorListener
▸ removeConfiguratorListener(listener): void
# Parameters
| Name | Type |
|---|---|
listener | ConfiguratorKernelCallbackI |
# Returns
void
# Inherited from
default.removeConfiguratorListener
# Defined in
packages/common-core/src/services/common-kernel-access.ts:815 (opens new window)
# removePlannerListener
▸ removePlannerListener(listener): void
# Parameters
| Name | Type |
|---|---|
listener | PlannerKernelCallbackI |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:155 (opens new window)
# requestCatalogItem
▸ requestCatalogItem(_catalogItemId): void
# Parameters
| Name | Type |
|---|---|
_catalogItemId | string |
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:546 (opens new window)
# requestComponentDimensions
▸ requestComponentDimensions(): void
# Returns
void
# Inherited from
default.requestComponentDimensions
# Defined in
packages/common-core/src/configurator-kernel-access.ts:780 (opens new window)
# requestDeleteComponent
▸ requestDeleteComponent(componentId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
# Returns
void
# Inherited from
default.requestDeleteComponent
# Defined in
packages/common-core/src/services/common-kernel-access.ts:537 (opens new window)
# requestDeleteComponents
▸ requestDeleteComponents(componentIds): void
# Parameters
| Name | Type |
|---|---|
componentIds | number[] |
# Returns
void
# Inherited from
default.requestDeleteComponents
# Defined in
packages/common-core/src/configurator-kernel-access.ts:532 (opens new window)
# requestDeletePlanComponent
▸ requestDeletePlanComponent(componentId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
# Returns
void
# Inherited from
default.requestDeletePlanComponent
# Defined in
packages/common-core/src/configurator-kernel-access.ts:542 (opens new window)
# requestExternalMesh
▸ requestExternalMesh(meshId, quality): Promise<void>
# Parameters
| Name | Type |
|---|---|
meshId | string |
quality | number |
# Returns
Promise<void>
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:858 (opens new window)
# requestMaterialProperties
▸ requestMaterialProperties(materialIds): Promise<void>
# Parameters
| Name | Type |
|---|---|
materialIds | string[] |
# Returns
Promise<void>
# Inherited from
default.requestMaterialProperties
# Defined in
packages/common-core/src/services/common-kernel-access.ts:827 (opens new window)
# requestMaterialsInGroup
▸ requestMaterialsInGroup(groupIds): void
# Parameters
| Name | Type |
|---|---|
groupIds | string[] |
# Returns
void
# Inherited from
default.requestMaterialsInGroup
# Defined in
packages/common-core/src/services/common-kernel-access.ts:742 (opens new window)
# requestPartListAndUpdatePricesOfParts
▸ requestPartListAndUpdatePricesOfParts(hash?, _prices?): Promise<void>
# Parameters
| Name | Type |
|---|---|
hash? | string |
_prices? | Map<string, RapiPrice> |
# Returns
Promise<void>
# Inherited from
default.requestPartListAndUpdatePricesOfParts
# Defined in
packages/common-core/src/configurator-kernel-access.ts:559 (opens new window)
# requestPlanComponentConstruction
▸ requestPlanComponentConstruction(id, useDeltaUpdates?): void
# Parameters
| Name | Type | Default value |
|---|---|---|
id | number | undefined |
useDeltaUpdates | boolean | USE_DELTA_COMPONENT_UPDATES |
# Returns
void
# Inherited from
default.requestPlanComponentConstruction
# Defined in
packages/common-core/src/services/common-kernel-access.ts:800 (opens new window)
# requestPlanObjectConstruction
▸ requestPlanObjectConstruction(objectId): void
# Parameters
| Name | Type |
|---|---|
objectId | number |
# Returns
void
# Inherited from
default.requestPlanObjectConstruction
# Defined in
packages/common-core/src/configurator-kernel-access.ts:618 (opens new window)
# requestPlanObjectDimensions
▸ requestPlanObjectDimensions(): void
# Returns
void
# Overrides
default.requestPlanObjectDimensions
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:292 (opens new window)
# requestSync
▸ requestSync(conversationId, planObjectId): void
# Parameters
| Name | Type |
|---|---|
conversationId | number |
planObjectId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:579 (opens new window)
# resume
▸ resume(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:1127 (opens new window)
# sceneCleared
▸ sceneCleared(): void
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/services/common-kernel-access.ts:736 (opens new window)
# selectedComponent
▸ selectedComponent(componentId): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:144 (opens new window)
# selectionChange
▸ selectionChange(componentId, isRoot): void
# Parameters
| Name | Type |
|---|---|
componentId | number |
isRoot | boolean |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:170 (opens new window)
# setActiveGroupInView
▸ setActiveGroupInView(group): void
# Parameters
| Name | Type |
|---|---|
group | string |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:764 (opens new window)
# setActiveGroupInViewForPlanObject
▸ setActiveGroupInViewForPlanObject(group, runtimeId?): void
# Parameters
| Name | Type |
|---|---|
group | string |
runtimeId? | number |
# Returns
void
# Inherited from
default.setActiveGroupInViewForPlanObject
# Defined in
packages/common-core/src/configurator-kernel-access.ts:768 (opens new window)
# startedDrawing
▸ startedDrawing(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:550 (opens new window)
# stoppedDrawing
▸ stoppedDrawing(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:556 (opens new window)
# uiRequestConfiguration
▸ uiRequestConfiguration(objectId): void
# Parameters
| Name | Type |
|---|---|
objectId | number |
# Returns
void
# Inherited from
default.uiRequestConfiguration
# Defined in
packages/common-core/src/configurator-kernel-access.ts:148 (opens new window)
# updateMesh2d
▸ updateMesh2d(): void
# Returns
void
# Defined in
packages/planner-core/src/services/planner-kernel-access.ts:562 (opens new window)
# updatePlanObjectDependencies
▸ updatePlanObjectDependencies(planObjectId): void
# Parameters
| Name | Type |
|---|---|
planObjectId | number |
# Returns
void
# Inherited from
default.updatePlanObjectDependencies
# Defined in
packages/common-core/src/configurator-kernel-access.ts:310 (opens new window)
# webGlPreviewDockings
▸ webGlPreviewDockings(context, dragIn): void
# Parameters
| Name | Type |
|---|---|
context | default |
dragIn | boolean |
# Returns
void
# Inherited from
# Defined in
packages/common-core/src/configurator-kernel-access.ts:374 (opens new window)