API Reference › Globals › ConfiguratorKernelClass
# Interface: ConfiguratorKernelClass
# Hierarchy
- ConfiguratorKernelClass
# Index
# Methods
- addMeshCorto
- addPriceList
- clearAll
- clearScene
- deleteComponent
- deletePlanComponents
- dockComponent
- dockComponentWithPosition
- getCommonPlanComponentParameters
- getComponent
- getComponentId
- getComponentParameters
- getFullPartList
- getHashOfConfiguration
- getHashOfSerializedConfiguration
- getPartList
- getPlanComponentPossibleChildren
- getPlanObject
- getPlanObjectParameters
- getPlanObjectPossibleChildren
- getRootPlanComponentIdFromObjectId
- getSerializedConfiguration
- loadComponent
- loadComponentDefinition
- loadConfiguration
- loadFreeFlyingConfiguration
- loadPlainComponent
- loadedSubComponent
- requestDeltaPlanComponentConstruction
- requestPlanComponentConstruction
- requestPlanComponentConstructionRecursive
- requestPlanObjectConstruction
- requestPreviewGeometry
- resetPriceListIds
- setActiveGroupInView
- setComponentParameter
- setEnvironmentVariable
- setMaterialProperties
- setMaterialsInGroup
- setPlanComponentParameters
- setPlanObjectParameter
- syncPlanObjectToView
- useEnvironmentGeometry
- useHDGeometry
# Methods
# addMeshCorto
▸ addMeshCorto(meshId: string, quality: number, data: Uint8Array): void
Defined in packages/typings/kernel.ts:433
Parameters:
| Name | Type |
|---|---|
meshId | string |
quality | number |
data | Uint8Array |
Returns: void
# addPriceList
▸ addPriceList(newLocale: string): void
Defined in packages/typings/kernel.ts:375
Parameters:
| Name | Type |
|---|---|
newLocale | string |
Returns: void
# clearAll
▸ clearAll(): void
Defined in packages/typings/kernel.ts:359
Returns: void
# clearScene
▸ clearScene(): void
Defined in packages/typings/kernel.ts:357
Returns: void
# deleteComponent
▸ deleteComponent(componentId: number): void
Defined in packages/typings/kernel.ts:369
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# deletePlanComponents
▸ deletePlanComponents(componentIds: any): void
Defined in packages/typings/kernel.ts:371
Parameters:
| Name | Type |
|---|---|
componentIds | any |
Returns: void
# dockComponent
▸ dockComponent(parentId: number, parentDockId: number, childId: number, childDockId: number): void
Defined in packages/typings/kernel.ts:401
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
Defined in packages/typings/kernel.ts:403
Parameters:
| Name | Type |
|---|---|
parentId | number |
parentDockId | number |
childId | number |
childDockId | number |
position | KernelVector3 |
Returns: void
# getCommonPlanComponentParameters
▸ getCommonPlanComponentParameters(componentIds: any): object
Defined in packages/typings/kernel.ts:427
Parameters:
| Name | Type |
|---|---|
componentIds | any |
Returns: object
parameterGroups: KernelParameterGroup[]
parameters: KernelParameter[]
# getComponent
▸ getComponent(componentId: number): KernelComponent
Defined in packages/typings/kernel.ts:405
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: KernelComponent
# getComponentId
▸ getComponentId(componentId: number): RapiId
Defined in packages/typings/kernel.ts:407
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: RapiId
# getComponentParameters
▸ getComponentParameters(componentId: number): KernelParameter[]
Defined in packages/typings/kernel.ts:389
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: KernelParameter[]
# getFullPartList
▸ getFullPartList(): KernelPartList
Defined in packages/typings/kernel.ts:417
Returns: KernelPartList
# getHashOfConfiguration
▸ getHashOfConfiguration(aPlanObjectOrComponentId: number): ConfigurationHash
Defined in packages/typings/kernel.ts:421
Parameters:
| Name | Type |
|---|---|
aPlanObjectOrComponentId | number |
Returns: ConfigurationHash
# getHashOfSerializedConfiguration
▸ getHashOfSerializedConfiguration(serializedConfiguration: string): ConfigurationHash
Defined in packages/typings/kernel.ts:423
Parameters:
| Name | Type |
|---|---|
serializedConfiguration | string |
Returns: ConfigurationHash
# getPartList
▸ getPartList(getPartList: number): KernelPartList
Defined in packages/typings/kernel.ts:425
Parameters:
| Name | Type |
|---|---|
getPartList | number |
Returns: KernelPartList
# getPlanComponentPossibleChildren
▸ getPlanComponentPossibleChildren(componentId: number): KernelPossibleChild[]
Defined in packages/typings/kernel.ts:411
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: KernelPossibleChild[]
# getPlanObject
▸ getPlanObject(planObjectId: number): PlanObject
Defined in packages/typings/kernel.ts:409
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: PlanObject
# getPlanObjectParameters
▸ getPlanObjectParameters(planObjectId: number): KernelParameter[]
Defined in packages/typings/kernel.ts:397
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: KernelParameter[]
# getPlanObjectPossibleChildren
▸ getPlanObjectPossibleChildren(componentId: number): KernelPossibleChild[]
Defined in packages/typings/kernel.ts:413
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: KernelPossibleChild[]
# getRootPlanComponentIdFromObjectId
▸ getRootPlanComponentIdFromObjectId(planObjectId: number): number
Defined in packages/typings/kernel.ts:415
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: number
# getSerializedConfiguration
▸ getSerializedConfiguration(planObjectOrComponentId: number): ConfigurationString
Defined in packages/typings/kernel.ts:419
Parameters:
| Name | Type |
|---|---|
planObjectOrComponentId | number |
Returns: ConfigurationString
# loadComponent
▸ loadComponent(conversationId: number, configurationString: ConfigurationString, configuration: ConfigurationObject, parentId: number): void
Defined in packages/typings/kernel.ts:367
Parameters:
| Name | Type |
|---|---|
conversationId | number |
configurationString | ConfigurationString |
configuration | ConfigurationObject |
parentId | number |
Returns: void
# loadComponentDefinition
▸ loadComponentDefinition(conversationId: number, component: string): void
Defined in packages/typings/kernel.ts:429
Parameters:
| Name | Type |
|---|---|
conversationId | number |
component | string |
Returns: void
# loadConfiguration
▸ loadConfiguration(kernelConversationId: number, configurationObject: ConfigurationString, position: KernelVector3): void
Defined in packages/typings/kernel.ts:361
Parameters:
| Name | Type |
|---|---|
kernelConversationId | number |
configurationObject | ConfigurationString |
position | KernelVector3 |
Returns: void
# loadFreeFlyingConfiguration
▸ loadFreeFlyingConfiguration(conversationId: number, configuration: ConfigurationString): void
Defined in packages/typings/kernel.ts:365
Parameters:
| Name | Type |
|---|---|
conversationId | number |
configuration | ConfigurationString |
Returns: void
# loadPlainComponent
▸ loadPlainComponent(conversationId: number, componentId: RapiId, configuration: ConfigurationString): void
Defined in packages/typings/kernel.ts:363
Parameters:
| Name | Type |
|---|---|
conversationId | number |
componentId | RapiId |
configuration | ConfigurationString |
Returns: void
# loadedSubComponent
▸ loadedSubComponent(parentId: number, partId: number, componentId: string, configuration: ConfigurationString): void
Defined in packages/typings/kernel.ts:377
Parameters:
| Name | Type |
|---|---|
parentId | number |
partId | number |
componentId | string |
configuration | ConfigurationString |
Returns: void
# requestDeltaPlanComponentConstruction
▸ requestDeltaPlanComponentConstruction(componentId: number): void
Defined in packages/typings/kernel.ts:383
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# requestPlanComponentConstruction
▸ requestPlanComponentConstruction(componentId: number): void
Defined in packages/typings/kernel.ts:381
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# requestPlanComponentConstructionRecursive
▸ requestPlanComponentConstructionRecursive(componentId: number): void
Defined in packages/typings/kernel.ts:385
Parameters:
| Name | Type |
|---|---|
componentId | number |
Returns: void
# requestPlanObjectConstruction
▸ requestPlanObjectConstruction(planObjectId: number): void
Defined in packages/typings/kernel.ts:379
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
Returns: void
# requestPreviewGeometry
▸ requestPreviewGeometry(componentId: number, planObjectId: number): void
Defined in packages/typings/kernel.ts:387
Parameters:
| Name | Type |
|---|---|
componentId | number |
planObjectId | number |
Returns: void
# resetPriceListIds
▸ resetPriceListIds(): void
Defined in packages/typings/kernel.ts:373
Returns: void
# setActiveGroupInView
▸ setActiveGroupInView(groupId: string): void
Defined in packages/typings/kernel.ts:437
Parameters:
| Name | Type |
|---|---|
groupId | string |
Returns: void
# setComponentParameter
▸ setComponentParameter(componentId: number, parameterKey: string, value: string): void
Defined in packages/typings/kernel.ts:391
Parameters:
| Name | Type |
|---|---|
componentId | number |
parameterKey | string |
value | string |
Returns: void
# setEnvironmentVariable
▸ setEnvironmentVariable(key: string, value: any): void
Defined in packages/typings/kernel.ts:395
Parameters:
| Name | Type |
|---|---|
key | string |
value | any |
Returns: void
# setMaterialProperties
▸ setMaterialProperties(propertiesOfMaterials: Array‹object›): void
Defined in packages/typings/kernel.ts:439
Parameters:
| Name | Type |
|---|---|
propertiesOfMaterials | Array‹object› |
Returns: void
# setMaterialsInGroup
▸ setMaterialsInGroup(materialGroups: Array‹object›): void
Defined in packages/typings/kernel.ts:435
Parameters:
| Name | Type |
|---|---|
materialGroups | Array‹object› |
Returns: void
# setPlanComponentParameters
▸ setPlanComponentParameters(componentIds: any, parameterKey: string, value: string): void
Defined in packages/typings/kernel.ts:393
Parameters:
| Name | Type |
|---|---|
componentIds | any |
parameterKey | string |
value | string |
Returns: void
# setPlanObjectParameter
▸ setPlanObjectParameter(planObjectId: number, parameterKey: string, value: string): void
Defined in packages/typings/kernel.ts:399
Parameters:
| Name | Type |
|---|---|
planObjectId | number |
parameterKey | string |
value | string |
Returns: void
# syncPlanObjectToView
▸ syncPlanObjectToView(conversationId: number, planObjectId: number): void
Defined in packages/typings/kernel.ts:431
Parameters:
| Name | Type |
|---|---|
conversationId | number |
planObjectId | number |
Returns: void
# useEnvironmentGeometry
▸ useEnvironmentGeometry(requestEnvironmentGeometry: boolean): void
Defined in packages/typings/kernel.ts:355
Parameters:
| Name | Type |
|---|---|
requestEnvironmentGeometry | boolean |
Returns: void
# useHDGeometry
▸ useHDGeometry(requestUseHDGeometry: boolean): void
Defined in packages/typings/kernel.ts:353
Parameters:
| Name | Type |
|---|---|
requestUseHDGeometry | boolean |
Returns: void