API Reference › Globals › ConfiguratorKernelAccess
# Class: ConfiguratorKernelAccess
# Hierarchy
-
↳ ConfiguratorKernelAccess
# Implements
# Index
# Constructors
# Properties
# Accessors
# 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
- Editor3dRootComponentCreated
- Editor3dRotateAround
- Editor3dRotateBy
- Editor3dSelectObject
- Editor3dSetMaterial
- Editor3dSetPreviewLineAssociations
- Editor3dSetPreviewPointAssociations
- Editor3dTranslateBy
- Editor3dUpdatePlanComponentPosition
- Editor3dUpdatePlanComponentRotation
- Editor3dUpdatePlanComponentTransform
- Editor3dUpdatePlanObjectPosition
- Editor3dUpdatePlanObjectRotation
- Editor3dUpdatePlanObjectTransform
- addConfiguratorListener
- addUiDataAndPriceToPartList
- addUiDataToPartList
- changeCommonComponentParameter
- changeComponentParameter
- changePlanObjectParameter
- changeUseOfHDGeometry
- cleanUpCallbacks
- componentConfigurationUpdated
- componentDefinitionLoaded
- componentDefinitionLoadingError
- componentDeleted
- componentMetaUpdated
- componentParameters
- configurationLoaded
- configurationLoadingError
- destroy
- dockComponent
- dockComponentWithPosition
- getConfigurationData
- getConfigurationHash
- getCurrentConfigurationHash
- getGlobalParameters
- getParameterGroups
- getPartList
- getRuntimeComponentId
- getRuntimeComponentIdOfRootComponent
- getSerializedConfiguration
- init
- isReady
- listOfVariants
- listOfVariantsError
- loadComponent
- loadComponentIntoKernel
- loadConfiguration
- loadSubComponent
- multiSelectionChange
- onLoadComponentError
- pause
- planObjectConfigurationUpdated
- planObjectCreated
- planObjectDeleted
- planObjectUpdated
- previewDockingsWithDrag
- removeConfiguratorListener
- requestComponentDimensions
- requestDeleteComponent
- requestDeleteComponents
- requestExternalMesh
- requestMaterialProperties
- requestMaterialsInGroup
- requestPartListAndUpdatePricesOfParts
- requestPlanComponentConstruction
- requestPlanObjectConstruction
- requestPlanObjectDimensions
- requestSync
- resume
- sceneCleared
- selectedComponent
- selectionChange
- setActiveGroupInView
- uiRequestConfiguration
- updatePlanObjectDependencies
- webGlPreviewDockings
# Constructors
# constructor
+ new ConfiguratorKernelAccess(creator: string): ConfiguratorKernelAccess
Overrides CommonKernelAccess.constructor
Defined in packages/common-core/src/configurator-kernel-access.ts:77
Parameters:
| Name | Type |
|---|---|
creator | string |
Returns: ConfiguratorKernelAccess
# Properties
# creator
• creator: string
_Implementation of Context.creator_
_Inherited from CommonKernelAccess.creator_
Defined in packages/common-core/src/services/common-kernel-access.ts:88
# externalMeshQueue
• externalMeshQueue: PromiseQueue‹void› = new PromiseQueue()
Defined in packages/common-core/src/configurator-kernel-access.ts:75
# muteKernelCallbacks
• muteKernelCallbacks: boolean = false
Defined in packages/common-core/src/configurator-kernel-access.ts:77
# Accessors
# kernelContainer
• get kernelContainer(): any
Inherited from CommonKernelAccess.kernelContainer
Defined in packages/common-core/src/services/common-kernel-access.ts:199
Returns: any
# kernelInstance
• get kernelInstance(): ConfiguratorKernelClass
Inherited from CommonKernelAccess.kernelInstance
Defined in packages/common-core/src/services/common-kernel-access.ts:203
Returns: ConfiguratorKernelClass
# Methods
# Editor3ChangedNamedMesh
▸ Editor3ChangedNamedMesh(runtimeComponentId: number, meshId: string, geometryId: string, materialId: string, transform: Float32Array): void
Inherited from CommonKernelAccess.Editor3ChangedNamedMesh
Defined in packages/common-core/src/services/common-kernel-access.ts:422
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
meshId | string |
geometryId | string |
materialId | string |
transform | Float32Array |
Returns: void
# Editor3dAddBakedMesh
▸ Editor3dAddBakedMesh(runtimeComponentId: number, materialId: string, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, environmentGeometry: boolean): void
Inherited from CommonKernelAccess.Editor3dAddBakedMesh
Defined in packages/common-core/src/services/common-kernel-access.ts:414
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
materialId | string |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
environmentGeometry | boolean |
Returns: void
# Editor3dAddCube
▸ Editor3dAddCube(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:614
Returns: void
# Editor3dAddCubeUVMod
▸ Editor3dAddCubeUVMod(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:618
Returns: void
# Editor3dAddCylinder
▸ Editor3dAddCylinder(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:650
Returns: void
# Editor3dAddCylinderUVMod
▸ Editor3dAddCylinderUVMod(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:654
Returns: void
# Editor3dAddDockPreview
▸ Editor3dAddDockPreview(componentId: number, previewId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:586
Parameters:
| Name | Type |
|---|---|
componentId | number |
previewId | number |
Returns: void
# Editor3dAddFittingLine
▸ Editor3dAddFittingLine(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:670
Returns: void
# Editor3dAddFittingPoint
▸ Editor3dAddFittingPoint(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:666
Returns: void
# Editor3dAddMesh
▸ Editor3dAddMesh(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:638
Returns: void
# Editor3dAddMeshUVCoord
▸ Editor3dAddMeshUVCoord(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:646
Returns: void
# Editor3dAddMeshUVMod
▸ Editor3dAddMeshUVMod(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:642
Returns: void
# Editor3dAddNamedMesh
▸ Editor3dAddNamedMesh(runtimeComponentId: number, meshId: string, geometryId: string, materialId: string, transform: Float32Array, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, environmentGeometry: boolean): void
Inherited from CommonKernelAccess.Editor3dAddNamedMesh
Defined in packages/common-core/src/services/common-kernel-access.ts:418
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
meshId | string |
geometryId | string |
materialId | string |
transform | Float32Array |
vertices | Int32Array |
indices | Int32Array |
uvCoords | Float32Array |
normals | Float32Array |
environmentGeometry | boolean |
Returns: void
# Editor3dAddPrism
▸ Editor3dAddPrism(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:658
Returns: void
# Editor3dAddPrismUVMod
▸ Editor3dAddPrismUVMod(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:662
Returns: void
# Editor3dAddRectangle
▸ Editor3dAddRectangle(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:630
Returns: void
# Editor3dAddRectangleUVMod
▸ Editor3dAddRectangleUVMod(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:634
Returns: void
# Editor3dAddSphere
▸ Editor3dAddSphere(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:622
Returns: void
# Editor3dAddSphereUVMod
▸ Editor3dAddSphereUVMod(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:626
Returns: void
# Editor3dBeginConstruction
▸ Editor3dBeginConstruction(id: number, isDeltaUpdate: boolean): void
Inherited from CommonKernelAccess.Editor3dBeginConstruction
Defined in packages/common-core/src/services/common-kernel-access.ts:430
Parameters:
| Name | Type |
|---|---|
id | number |
isDeltaUpdate | boolean |
Returns: void
# Editor3dBeginGroup
▸ Editor3dBeginGroup(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:570
Returns: void
# Editor3dComponentCreated
▸ Editor3dComponentCreated(id: number, position: KernelVector3, eulerAngles: KernelVector3, parent: number): void
Overrides CommonKernelAccess.Editor3dComponentCreated
Defined in packages/common-core/src/configurator-kernel-access.ts:546
Parameters:
| Name | Type |
|---|---|
id | number |
position | KernelVector3 |
eulerAngles | KernelVector3 |
parent | number |
Returns: void
# Editor3dComponentDocked
▸ Editor3dComponentDocked(componentId: number, parentId: number, componentPosition: KernelVector3, componentRotation: KernelVector3): void
Inherited from CommonKernelAccess.Editor3dComponentDocked
Defined in packages/common-core/src/services/common-kernel-access.ts:442
Parameters:
| Name | Type |
|---|---|
componentId | number |
parentId | number |
componentPosition | KernelVector3 |
componentRotation | KernelVector3 |
Returns: void
# Editor3dCopy
▸ Editor3dCopy(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:678
Returns: void
# Editor3dEndConstruction
▸ Editor3dEndConstruction(id: number): void
Inherited from CommonKernelAccess.Editor3dEndConstruction
Defined in packages/common-core/src/services/common-kernel-access.ts:434
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dEndGroup
▸ Editor3dEndGroup(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:574
Returns: void
# Editor3dGeometryNotReady
▸ Editor3dGeometryNotReady(id: number): void
Inherited from CommonKernelAccess.Editor3dGeometryNotReady
Defined in packages/common-core/src/services/common-kernel-access.ts:451
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dGeometryReady
▸ Editor3dGeometryReady(id: number): void
Inherited from CommonKernelAccess.Editor3dGeometryReady
Defined in packages/common-core/src/services/common-kernel-access.ts:446
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dLoadMaterial
▸ Editor3dLoadMaterial(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:582
Returns: void
# Editor3dPlanObjectConstructionDone
▸ Editor3dPlanObjectConstructionDone(planObjectId: number): Promise‹object›
Defined in packages/common-core/src/configurator-kernel-access.ts:558
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: Promise‹object›
# Editor3dPreviewConstructionDone
▸ Editor3dPreviewConstructionDone(componentId: number, objectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:598
Parameters:
| Name | Type |
|---|---|
componentId | number |
objectId | number |
Returns: void
# Editor3dRemoveNamedMesh
▸ Editor3dRemoveNamedMesh(runtimeComponentId: number, geometryId: string): void
Inherited from CommonKernelAccess.Editor3dRemoveNamedMesh
Defined in packages/common-core/src/services/common-kernel-access.ts:426
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
geometryId | string |
Returns: void
# Editor3dRootComponentCreated
▸ Editor3dRootComponentCreated(id: number, position: KernelVector3, eulerAngles: KernelVector3, parentObjectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:554
Parameters:
| Name | Type |
|---|---|
id | number |
position | KernelVector3 |
eulerAngles | KernelVector3 |
parentObjectId | number |
Returns: void
# Editor3dRotateAround
▸ Editor3dRotateAround(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:610
Returns: void
# Editor3dRotateBy
▸ Editor3dRotateBy(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:606
Returns: void
# Editor3dSelectObject
▸ Editor3dSelectObject(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:674
Returns: void
# Editor3dSetMaterial
▸ Editor3dSetMaterial(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:578
Returns: void
# Editor3dSetPreviewLineAssociations
▸ Editor3dSetPreviewLineAssociations(dockLines: any, previewId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:594
Parameters:
| Name | Type |
|---|---|
dockLines | any |
previewId | number |
Returns: void
# Editor3dSetPreviewPointAssociations
▸ Editor3dSetPreviewPointAssociations(dockPairs: any, previewId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:590
Parameters:
| Name | Type |
|---|---|
dockPairs | any |
previewId | number |
Returns: void
# Editor3dTranslateBy
▸ Editor3dTranslateBy(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:602
Returns: void
# Editor3dUpdatePlanComponentPosition
▸ Editor3dUpdatePlanComponentPosition(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:694
Returns: void
# Editor3dUpdatePlanComponentRotation
▸ Editor3dUpdatePlanComponentRotation(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:698
Returns: void
# Editor3dUpdatePlanComponentTransform
▸ Editor3dUpdatePlanComponentTransform(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:702
Returns: void
# Editor3dUpdatePlanObjectPosition
▸ Editor3dUpdatePlanObjectPosition(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:682
Returns: void
# Editor3dUpdatePlanObjectRotation
▸ Editor3dUpdatePlanObjectRotation(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:686
Returns: void
# Editor3dUpdatePlanObjectTransform
▸ Editor3dUpdatePlanObjectTransform(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:690
Returns: void
# addConfiguratorListener
▸ addConfiguratorListener(listener: ConfiguratorKernelCallbackI): void
Inherited from CommonKernelAccess.addConfiguratorListener
Defined in packages/common-core/src/services/common-kernel-access.ts:511
Parameters:
| Name | Type |
|---|---|
listener | ConfiguratorKernelCallbackI |
Returns: void
# addUiDataAndPriceToPartList
▸ addUiDataAndPriceToPartList(partList: KernelPartList, hash: string): Promise‹KernelPartList›
Inherited from CommonKernelAccess.addUiDataAndPriceToPartList
Defined in packages/common-core/src/services/common-kernel-access.ts:634
Parameters:
| Name | Type |
|---|---|
partList | KernelPartList |
hash | string |
Returns: Promise‹KernelPartList›
# addUiDataToPartList
▸ addUiDataToPartList(partList: KernelPart[], hash: string): KernelPart[]
Inherited from CommonKernelAccess.addUiDataToPartList
Defined in packages/common-core/src/services/common-kernel-access.ts:680
Parameters:
| Name | Type |
|---|---|
partList | KernelPart[] |
hash | string |
Returns: KernelPart[]
# changeCommonComponentParameter
▸ changeCommonComponentParameter(componentIds: number[], parameterKey: string, type: string, value: string, resolve: function, reject: function): void
Defined in packages/common-core/src/configurator-kernel-access.ts:277
Parameters:
▪ componentIds: number[]
▪ parameterKey: string
▪ type: string
▪ value: string
▪ resolve: function
▸ (): void
▪ reject: function
▸ (): void
Returns: void
# changeComponentParameter
▸ changeComponentParameter(componentId: number, parameterKey: string, type: string, value: string, resolve: function, reject: function): void
Defined in packages/common-core/src/configurator-kernel-access.ts:287
Parameters:
▪ componentId: number
▪ parameterKey: string
▪ type: string
▪ value: string
▪ resolve: function
▸ (): void
▪ reject: function
▸ (): void
Returns: void
# changePlanObjectParameter
▸ changePlanObjectParameter(planObjectId: number, parameterKey: string, type: string, value: string, resolve: function, reject: function): void
Defined in packages/common-core/src/configurator-kernel-access.ts:297
Parameters:
▪ planObjectId: number
▪ parameterKey: string
▪ type: string
▪ value: string
▪ resolve: function
▸ (): void
▪ reject: function
▸ (): void
Returns: void
# changeUseOfHDGeometry
▸ changeUseOfHDGeometry(context: ConfiguratorContext, useHDGeometry: boolean): void
Defined in packages/common-core/src/configurator-kernel-access.ts:226
Parameters:
| Name | Type |
|---|---|
context | ConfiguratorContext |
useHDGeometry | boolean |
Returns: void
# cleanUpCallbacks
▸ cleanUpCallbacks(): void
Inherited from CommonKernelAccess.cleanUpCallbacks
Defined in packages/common-core/src/services/common-kernel-access.ts:519
Returns: void
# componentConfigurationUpdated
▸ componentConfigurationUpdated(componentId: number, geometryChanged: boolean): void
Defined in packages/common-core/src/configurator-kernel-access.ts:453
Parameters:
| Name | Type |
|---|---|
componentId | number |
geometryChanged | boolean |
Returns: void
# componentDefinitionLoaded
▸ componentDefinitionLoaded(conversationId: number, componentId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:429
Parameters:
| Name | Type |
|---|---|
conversationId | number |
componentId | number |
Returns: void
# componentDefinitionLoadingError
▸ componentDefinitionLoadingError(conversationId: number, errorMessage: string): void
Defined in packages/common-core/src/configurator-kernel-access.ts:433
Parameters:
| Name | Type |
|---|---|
conversationId | number |
errorMessage | string |
Returns: void
# componentDeleted
▸ componentDeleted(componentId: number): void
Inherited from CommonKernelAccess.componentDeleted
Defined in packages/common-core/src/services/common-kernel-access.ts:455
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# componentMetaUpdated
▸ componentMetaUpdated(componentId: number): void
Inherited from CommonKernelAccess.componentMetaUpdated
Defined in packages/common-core/src/services/common-kernel-access.ts:459
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# componentParameters
▸ componentParameters(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:466
Returns: void
# configurationLoaded
▸ configurationLoaded(conversationId: number, objectId: number, componentId: number, hash: string, errors: EmscriptenString[]): void
Defined in packages/common-core/src/configurator-kernel-access.ts:418
Parameters:
| Name | Type |
|---|---|
conversationId | number |
objectId | number |
componentId | number |
hash | string |
errors | EmscriptenString[] |
Returns: void
# configurationLoadingError
▸ configurationLoadingError(_runtimeId: number, errors?: EmscriptenString[]): void
Defined in packages/common-core/src/configurator-kernel-access.ts:438
Parameters:
| Name | Type |
|---|---|
_runtimeId | number |
errors? | EmscriptenString[] |
Returns: void
# destroy
▸ destroy(): void
Inherited from CommonKernelAccess.destroy
Defined in packages/common-core/src/services/common-kernel-access.ts:569
Returns: void
# dockComponent
▸ dockComponent(parentId: number, parentDockId: number, childId: number, childDockId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:219
Parameters:
| Name | Type |
|---|---|
parentId | number |
parentDockId | number |
childId | number |
childDockId | number |
Returns: void
# dockComponentWithPosition
▸ dockComponentWithPosition(parentId: number, parentDockId: number, childId: number, childDockId: number, position: KernelVector3): void
Inherited from CommonKernelAccess.dockComponentWithPosition
Defined in packages/common-core/src/services/common-kernel-access.ts:407
Parameters:
| Name | Type |
|---|---|
parentId | number |
parentDockId | number |
childId | number |
childDockId | number |
position | KernelVector3 |
Returns: void
# getConfigurationData
▸ getConfigurationData(planObjectId: number): Promise‹unknown›
Inherited from CommonKernelAccess.getConfigurationData
Defined in packages/common-core/src/services/common-kernel-access.ts:325
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: Promise‹unknown›
# getConfigurationHash
▸ getConfigurationHash(context: ConfiguratorContext): Promise‹ConfigurationHash›
Defined in packages/common-core/src/configurator-kernel-access.ts:362
Parameters:
| Name | Type |
|---|---|
context | ConfiguratorContext |
Returns: Promise‹ConfigurationHash›
# getCurrentConfigurationHash
▸ getCurrentConfigurationHash(planObjectId: number): ConfigurationHash
Defined in packages/common-core/src/configurator-kernel-access.ts:739
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: ConfigurationHash
# getGlobalParameters
▸ getGlobalParameters(planObjectId: number, rootComponentParametersAsGlobal: boolean): Promise‹KernelParameter[]›
Defined in packages/common-core/src/configurator-kernel-access.ts:342
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
rootComponentParametersAsGlobal | boolean |
Returns: Promise‹KernelParameter[]›
# getParameterGroups
▸ getParameterGroups(): KernelParameterGroup[]
Defined in packages/common-core/src/configurator-kernel-access.ts:718
Returns: KernelParameterGroup[]
# getPartList
▸ getPartList(): Promise‹unknown›
Defined in packages/common-core/src/configurator-kernel-access.ts:355
Returns: Promise‹unknown›
# getRuntimeComponentId
▸ getRuntimeComponentId(runtimeComponentId: number): string
Defined in packages/common-core/src/configurator-kernel-access.ts:714
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
Returns: string
# getRuntimeComponentIdOfRootComponent
▸ getRuntimeComponentIdOfRootComponent(planObjectId: number): number
Defined in packages/common-core/src/configurator-kernel-access.ts:706
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: number
# getSerializedConfiguration
▸ getSerializedConfiguration(objectId: number): string
Defined in packages/common-core/src/configurator-kernel-access.ts:735
Parameters:
| Name | Type |
|---|---|
objectId | number |
Returns: string
# init
▸ init(kernelType: KERNEL_TYPE): void
Defined in packages/common-core/src/configurator-kernel-access.ts:83
Parameters:
| Name | Type |
|---|---|
kernelType | KERNEL_TYPE |
Returns: void
# isReady
▸ isReady(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:370
Returns: void
# listOfVariants
▸ listOfVariants(_componentId: RapiId, _list: VariantsList): void
Defined in packages/common-core/src/configurator-kernel-access.ts:743
Parameters:
| Name | Type |
|---|---|
_componentId | RapiId |
_list | VariantsList |
Returns: void
# listOfVariantsError
▸ listOfVariantsError(dbId: RapiId, error: string): void
Defined in packages/common-core/src/configurator-kernel-access.ts:744
Parameters:
| Name | Type |
|---|---|
dbId | RapiId |
error | string |
Returns: void
# loadComponent
▸ loadComponent(conversationId: number, configuration: ConfigurationObject, parentId: number): void
Inherited from CommonKernelAccess.loadComponent
Defined in packages/common-core/src/services/common-kernel-access.ts:351
Parameters:
| Name | Type |
|---|---|
conversationId | number |
configuration | ConfigurationObject |
parentId | number |
Returns: void
# loadComponentIntoKernel
▸ loadComponentIntoKernel(component: string, componentId: RapiId): void
Defined in packages/common-core/src/configurator-kernel-access.ts:322
Parameters:
| Name | Type |
|---|---|
component | string |
componentId | RapiId |
Returns: void
# loadConfiguration
▸ loadConfiguration(configuration: ConfigurationString): void
Defined in packages/common-core/src/configurator-kernel-access.ts:258
Parameters:
| Name | Type |
|---|---|
configuration | ConfigurationString |
Returns: void
# loadSubComponent
▸ loadSubComponent(parentId: number, partId: number, componentId: string): void
Inherited from CommonKernelAccess.loadSubComponent
Defined in packages/common-core/src/services/common-kernel-access.ts:373
Parameters:
| Name | Type |
|---|---|
parentId | number |
partId | number |
componentId | string |
Returns: void
# multiSelectionChange
▸ multiSelectionChange(runtimeComponentIds: number[], rootComponentId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:140
Parameters:
| Name | Type |
|---|---|
runtimeComponentIds | number[] |
rootComponentId | number |
Returns: void
# onLoadComponentError
▸ onLoadComponentError(error: Error, id: RapiId): void
Defined in packages/common-core/src/configurator-kernel-access.ts:414
Parameters:
| Name | Type |
|---|---|
error | Error |
id | RapiId |
Returns: void
# pause
▸ pause(): void
Inherited from CommonKernelAccess.pause
Defined in packages/common-core/src/services/common-kernel-access.ts:560
Returns: void
# planObjectConfigurationUpdated
▸ planObjectConfigurationUpdated(planObjectId: number, configuration: ConfigurationString, hash: string): Promise‹void›
Defined in packages/common-core/src/configurator-kernel-access.ts:485
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
configuration | ConfigurationString |
hash | string |
Returns: Promise‹void›
# planObjectCreated
▸ planObjectCreated(conversationId: number, planObjectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:474
Parameters:
| Name | Type |
|---|---|
conversationId | number |
planObjectId | number |
Returns: void
# planObjectDeleted
▸ planObjectDeleted(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:512
Returns: void
# planObjectUpdated
▸ planObjectUpdated(planObjectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:478
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: void
# previewDockingsWithDrag
▸ previewDockingsWithDrag(componentId: number, planObjectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:254
Parameters:
| Name | Type |
|---|---|
componentId | number |
planObjectId | number |
Returns: void
# removeConfiguratorListener
▸ removeConfiguratorListener(listener: ConfiguratorKernelCallbackI): void
Inherited from CommonKernelAccess.removeConfiguratorListener
Defined in packages/common-core/src/services/common-kernel-access.ts:515
Parameters:
| Name | Type |
|---|---|
listener | ConfiguratorKernelCallbackI |
Returns: void
# requestComponentDimensions
▸ requestComponentDimensions(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:470
Returns: void
# requestDeleteComponent
▸ requestDeleteComponent(componentId: number): void
Inherited from CommonKernelAccess.requestDeleteComponent
Defined in packages/common-core/src/services/common-kernel-access.ts:399
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# requestDeleteComponents
▸ requestDeleteComponents(componentIds: number[]): void
Defined in packages/common-core/src/configurator-kernel-access.ts:314
Parameters:
| Name | Type |
|---|---|
componentIds | number[] |
Returns: void
# requestExternalMesh
▸ requestExternalMesh(meshId: string, quality: number): Promise‹void›
Defined in packages/common-core/src/configurator-kernel-access.ts:520
Parameters:
| Name | Type |
|---|---|
meshId | string |
quality | number |
Returns: Promise‹void›
# requestMaterialProperties
▸ requestMaterialProperties(materialIds: RapiId[]): Promise‹void›
Inherited from CommonKernelAccess.requestMaterialProperties
Defined in packages/common-core/src/services/common-kernel-access.ts:525
Parameters:
| Name | Type |
|---|---|
materialIds | RapiId[] |
Returns: Promise‹void›
# requestMaterialsInGroup
▸ requestMaterialsInGroup(groupIds: string[]): void
Inherited from CommonKernelAccess.requestMaterialsInGroup
Defined in packages/common-core/src/services/common-kernel-access.ts:468
Parameters:
| Name | Type |
|---|---|
groupIds | string[] |
Returns: void
# requestPartListAndUpdatePricesOfParts
▸ requestPartListAndUpdatePricesOfParts(hash?: ConfigurationHash, _prices?: Map‹ArticleNumber, RapiPrice›): Promise‹void›
Overrides CommonKernelAccess.requestPartListAndUpdatePricesOfParts
Defined in packages/common-core/src/configurator-kernel-access.ts:328
Parameters:
| Name | Type |
|---|---|
hash? | ConfigurationHash |
_prices? | Map‹ArticleNumber, RapiPrice› |
Returns: Promise‹void›
# requestPlanComponentConstruction
▸ requestPlanComponentConstruction(id: number): void
Inherited from CommonKernelAccess.requestPlanComponentConstruction
Defined in packages/common-core/src/services/common-kernel-access.ts:503
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# requestPlanObjectConstruction
▸ requestPlanObjectConstruction(objectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:366
Parameters:
| Name | Type |
|---|---|
objectId | number |
Returns: void
# requestPlanObjectDimensions
▸ requestPlanObjectDimensions(): void
Defined in packages/common-core/src/configurator-kernel-access.ts:516
Returns: void
# requestSync
▸ requestSync(conversationId: number, planObjectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:337
Parameters:
| Name | Type |
|---|---|
conversationId | number |
planObjectId | number |
Returns: void
# resume
▸ resume(): void
Overrides CommonKernelAccess.resume
Defined in packages/common-core/src/configurator-kernel-access.ts:728
Returns: void
# sceneCleared
▸ sceneCleared(): void
Inherited from CommonKernelAccess.sceneCleared
Defined in packages/common-core/src/services/common-kernel-access.ts:464
Returns: void
# selectedComponent
▸ selectedComponent(componentId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:111
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# selectionChange
▸ selectionChange(componentId: number, isRoot: boolean): void
Defined in packages/common-core/src/configurator-kernel-access.ts:126
Parameters:
| Name | Type |
|---|---|
componentId | number |
isRoot | boolean |
Returns: void
# setActiveGroupInView
▸ setActiveGroupInView(group: string): void
Defined in packages/common-core/src/configurator-kernel-access.ts:462
Parameters:
| Name | Type |
|---|---|
group | string |
Returns: void
# uiRequestConfiguration
▸ uiRequestConfiguration(objectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:115
Parameters:
| Name | Type |
|---|---|
objectId | number |
Returns: void
# updatePlanObjectDependencies
▸ updatePlanObjectDependencies(planObjectId: number): void
Defined in packages/common-core/src/configurator-kernel-access.ts:206
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: void
# webGlPreviewDockings
▸ webGlPreviewDockings(context: ConfiguratorContext, dragIn: boolean): void
Defined in packages/common-core/src/configurator-kernel-access.ts:238
Parameters:
| Name | Type |
|---|---|
context | ConfiguratorContext |
dragIn | boolean |
Returns: void