API Reference › Globals › CommonKernelAccess
# Class: CommonKernelAccess
# Hierarchy
CommonKernelAccess
# Implements
# Index
# Constructors
# Properties
# Accessors
# Methods
- Editor3ChangedNamedMesh
- Editor3dAddBakedMesh
- Editor3dAddNamedMesh
- Editor3dBeginConstruction
- Editor3dComponentCreated
- Editor3dComponentDocked
- Editor3dEndConstruction
- Editor3dGeometryNotReady
- Editor3dGeometryReady
- Editor3dRemoveNamedMesh
- addConfiguratorListener
- addUiDataAndPriceToPartList
- addUiDataToPartList
- cleanUpCallbacks
- componentDeleted
- componentMetaUpdated
- destroy
- dockComponentWithPosition
- getConfigurationData
- loadComponent
- loadSubComponent
- pause
- removeConfiguratorListener
- requestDeleteComponent
- requestMaterialProperties
- requestMaterialsInGroup
- requestPartListAndUpdatePricesOfParts
- requestPlanComponentConstruction
- resume
- sceneCleared
# Constructors
# constructor
+ new CommonKernelAccess(creator: string): CommonKernelAccess
Defined in packages/common-core/src/services/common-kernel-access.ts:167
Parameters:
| Name | Type |
|---|---|
creator | string |
Returns: CommonKernelAccess
# Properties
# creator
• creator: string
_Implementation of Context.creator_
Defined in packages/common-core/src/services/common-kernel-access.ts:88
# Accessors
# kernelContainer
• get kernelContainer(): any
Defined in packages/common-core/src/services/common-kernel-access.ts:199
Returns: any
# kernelInstance
• get kernelInstance(): ConfiguratorKernelClass
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
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
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
# Editor3dAddNamedMesh
▸ Editor3dAddNamedMesh(runtimeComponentId: number, meshId: string, geometryId: string, materialId: string, transform: Float32Array, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, environmentGeometry: boolean): void
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
# Editor3dBeginConstruction
▸ Editor3dBeginConstruction(id: number, isDeltaUpdate: boolean): void
Defined in packages/common-core/src/services/common-kernel-access.ts:430
Parameters:
| Name | Type |
|---|---|
id | number |
isDeltaUpdate | boolean |
Returns: void
# Editor3dComponentCreated
▸ Editor3dComponentCreated(id: number, position: KernelVector3, eulerAngles: KernelVector3, parentObjectRuntimeId: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:438
Parameters:
| Name | Type |
|---|---|
id | number |
position | KernelVector3 |
eulerAngles | KernelVector3 |
parentObjectRuntimeId | number |
Returns: void
# Editor3dComponentDocked
▸ Editor3dComponentDocked(componentId: number, parentId: number, componentPosition: KernelVector3, componentRotation: KernelVector3): void
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
# Editor3dEndConstruction
▸ Editor3dEndConstruction(id: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:434
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dGeometryNotReady
▸ Editor3dGeometryNotReady(id: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:451
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dGeometryReady
▸ Editor3dGeometryReady(id: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:446
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# Editor3dRemoveNamedMesh
▸ Editor3dRemoveNamedMesh(runtimeComponentId: number, geometryId: string): void
Defined in packages/common-core/src/services/common-kernel-access.ts:426
Parameters:
| Name | Type |
|---|---|
runtimeComponentId | number |
geometryId | string |
Returns: void
# addConfiguratorListener
▸ addConfiguratorListener(listener: ConfiguratorKernelCallbackI): void
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›
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[]
Defined in packages/common-core/src/services/common-kernel-access.ts:680
Parameters:
| Name | Type |
|---|---|
partList | KernelPart[] |
hash | string |
Returns: KernelPart[]
# cleanUpCallbacks
▸ cleanUpCallbacks(): void
Defined in packages/common-core/src/services/common-kernel-access.ts:519
Returns: void
# componentDeleted
▸ componentDeleted(componentId: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:455
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# componentMetaUpdated
▸ componentMetaUpdated(componentId: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:459
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# destroy
▸ destroy(): void
Defined in packages/common-core/src/services/common-kernel-access.ts:569
Returns: void
# dockComponentWithPosition
▸ dockComponentWithPosition(parentId: number, parentDockId: number, childId: number, childDockId: number, position: KernelVector3): void
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›
Defined in packages/common-core/src/services/common-kernel-access.ts:325
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: Promise‹unknown›
# loadComponent
▸ loadComponent(conversationId: number, configuration: ConfigurationObject, parentId: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:351
Parameters:
| Name | Type |
|---|---|
conversationId | number |
configuration | ConfigurationObject |
parentId | number |
Returns: void
# loadSubComponent
▸ loadSubComponent(parentId: number, partId: number, componentId: string): void
Defined in packages/common-core/src/services/common-kernel-access.ts:373
Parameters:
| Name | Type |
|---|---|
parentId | number |
partId | number |
componentId | string |
Returns: void
# pause
▸ pause(): void
Defined in packages/common-core/src/services/common-kernel-access.ts:560
Returns: void
# removeConfiguratorListener
▸ removeConfiguratorListener(listener: ConfiguratorKernelCallbackI): void
Defined in packages/common-core/src/services/common-kernel-access.ts:515
Parameters:
| Name | Type |
|---|---|
listener | ConfiguratorKernelCallbackI |
Returns: void
# requestDeleteComponent
▸ requestDeleteComponent(componentId: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:399
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# requestMaterialProperties
▸ requestMaterialProperties(materialIds: RapiId[]): Promise‹void›
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
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›
Defined in packages/common-core/src/services/common-kernel-access.ts:714
Parameters:
| Name | Type |
|---|---|
hash? | ConfigurationHash |
_prices? | Map‹ArticleNumber, RapiPrice› |
Returns: Promise‹void›
# requestPlanComponentConstruction
▸ requestPlanComponentConstruction(id: number): void
Defined in packages/common-core/src/services/common-kernel-access.ts:503
Parameters:
| Name | Type |
|---|---|
id | number |
Returns: void
# resume
▸ resume(): void
Defined in packages/common-core/src/services/common-kernel-access.ts:564
Returns: void
# sceneCleared
▸ sceneCleared(): void
Defined in packages/common-core/src/services/common-kernel-access.ts:464
Returns: void