API Reference / Modules / typings/kernel / ConfiguratorKernelClass

# Interface: ConfiguratorKernelClass

typings/kernel.ConfiguratorKernelClass

# Table of contents

# Methods

# addMeshCorto

▸ addMeshCorto(meshId, quality, data): void

# Parameters

Name	Type
`meshId`	`string`
`quality`	`number`
`data`	`Uint8Array`

# Returns

void

# Defined in

packages/typings/kernel.ts:603 (opens new window)

# addPriceList

▸ addPriceList(newLocale): void

# Parameters

Name	Type
`newLocale`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:476 (opens new window)

# clearAll

▸ clearAll(): void

# Returns

void

# Defined in

packages/typings/kernel.ts:442 (opens new window)

# clearScene

▸ clearScene(): void

# Returns

void

# Defined in

packages/typings/kernel.ts:440 (opens new window)

# createNewSerializedConfiguration

▸ createNewSerializedConfiguration(configurationRuntimeId): string

# Parameters

Name	Type
`configurationRuntimeId`	`number`

# Returns

string

# Defined in

packages/typings/kernel.ts:582 (opens new window)

# deleteComponent

▸ deleteComponent(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:468 (opens new window)

# deletePlanComponent

▸ deletePlanComponent(componentId): void

# Parameters

Name	Type
`componentId`	`any`

# Returns

void

# Defined in

packages/typings/kernel.ts:470 (opens new window)

# deletePlanComponents

▸ deletePlanComponents(componentIds): void

# Parameters

Name	Type
`componentIds`	`any`

# Returns

void

# Defined in

packages/typings/kernel.ts:472 (opens new window)

# dockComponent

▸ dockComponent(parentId, parentDockId, childId, childDockId): void

# Parameters

Name	Type
`parentId`	`number`
`parentDockId`	`number`
`childId`	`number`
`childDockId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:527 (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

# Defined in

packages/typings/kernel.ts:534 (opens new window)

# getChildrenOfPlanComponent

▸ getChildrenOfPlanComponent(componentId, onlyPossible, onlyVisible): KernelPossibleChild[]

# Parameters

Name	Type
`componentId`	`number`
`onlyPossible`	`boolean`
`onlyVisible`	`boolean`

# Returns

KernelPossibleChild[]

# Defined in

packages/typings/kernel.ts:554 (opens new window)

# getChildrenOfPlanObject

▸ getChildrenOfPlanObject(planObjectId, onlyPossible, onlyVisible): KernelPossibleChild[]

# Parameters

Name	Type
`planObjectId`	`number`
`onlyPossible`	`boolean`
`onlyVisible`	`boolean`

# Returns

KernelPossibleChild[]

# Defined in

packages/typings/kernel.ts:560 (opens new window)

# getCommonPlanComponentParameters

▸ getCommonPlanComponentParameters(componentIds): Object

# Parameters

Name	Type
`componentIds`	`any`

# Returns

Object

Name	Type
`parameterGroups`	`KernelParameterGroup`[]
`parameters`	`KernelParameter`[]

# Defined in

packages/typings/kernel.ts:594 (opens new window)

# getComponent

▸ getComponent(componentId): KernelComponent

# Parameters

Name	Type
`componentId`	`number`

# Returns

KernelComponent

# Defined in

packages/typings/kernel.ts:542 (opens new window)

# getComponentId

▸ getComponentId(componentId): string

# Parameters

Name	Type
`componentId`	`number`

# Returns

string

# Defined in

packages/typings/kernel.ts:544 (opens new window)

# getComponentParameters

▸ getComponentParameters(componentId): KernelParameter[]

# Parameters

Name	Type
`componentId`	`number`

# Returns

KernelParameter[]

# Defined in

packages/typings/kernel.ts:501 (opens new window)

# getFullPartList

▸ getFullPartList(): KernelPartList

# Returns

KernelPartList

# Defined in

packages/typings/kernel.ts:576 (opens new window)

# getHashOfConfiguration

▸ getHashOfConfiguration(aPlanObjectOrComponentId): string

# Parameters

Name	Type
`aPlanObjectOrComponentId`	`number`

# Returns

string

# Defined in

packages/typings/kernel.ts:586 (opens new window)

# getHashOfSerializedConfiguration

▸ getHashOfSerializedConfiguration(serializedConfiguration): string

# Parameters

Name	Type
`serializedConfiguration`	`string`

# Returns

string

# Defined in

packages/typings/kernel.ts:588 (opens new window)

# getPartList

▸ getPartList(getPartList): KernelPartList

# Parameters

Name	Type
`getPartList`	`number`

# Returns

KernelPartList

# Defined in

packages/typings/kernel.ts:592 (opens new window)

# getPlanComponentPossibleChildren

▸ getPlanComponentPossibleChildren(componentId): KernelPossibleChild[]

# Parameters

Name	Type
`componentId`	`number`

# Returns

KernelPossibleChild[]

# Defined in

packages/typings/kernel.ts:552 (opens new window)

# getPlanObject

▸ getPlanObject(planObjectId): PlanObject

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

PlanObject

# Defined in

packages/typings/kernel.ts:548 (opens new window)

# getPlanObjectChildren

▸ getPlanObjectChildren(planObjectId, onlyPossible, onlyVisible): KernelPossibleChild[]

# Parameters

Name	Type
`planObjectId`	`number`
`onlyPossible`	`boolean`
`onlyVisible`	`boolean`

# Returns

KernelPossibleChild[]

# Defined in

packages/typings/kernel.ts:568 (opens new window)

# getPlanObjectFromPlanComponent

▸ getPlanObjectFromPlanComponent(componentId): PlanObject

# Parameters

Name	Type
`componentId`	`number`

# Returns

PlanObject

# Defined in

packages/typings/kernel.ts:550 (opens new window)

# getPlanObjectParameters

▸ getPlanObjectParameters(planObjectId): KernelParameter[]

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

KernelParameter[]

# Defined in

packages/typings/kernel.ts:519 (opens new window)

# getPlanObjectPossibleChildren

▸ getPlanObjectPossibleChildren(componentId): KernelPossibleChild[]

# Parameters

Name	Type
`componentId`	`number`

# Returns

KernelPossibleChild[]

# Defined in

packages/typings/kernel.ts:566 (opens new window)

# getRootPlanComponentIdFromObjectId

▸ getRootPlanComponentIdFromObjectId(planObjectId): number

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

number

# Defined in

packages/typings/kernel.ts:574 (opens new window)

# getSerializedConfiguration

▸ getSerializedConfiguration(planObjectOrComponentId): string

# Parameters

Name	Type
`planObjectOrComponentId`	`number`

# Returns

string

# Defined in

packages/typings/kernel.ts:578 (opens new window)

# isExternalPlanObject

▸ isExternalPlanObject(objectOrPlanComponentId): boolean

# Parameters

Name	Type
`objectOrPlanComponentId`	`number`

# Returns

boolean

# Defined in

packages/typings/kernel.ts:546 (opens new window)

# loadComponent

▸ loadComponent(conversationId, configurationString, configuration, parentId): void

# Parameters

Name	Type
`conversationId`	`number`
`configurationString`	`string`
`configuration`	`ConfigurationObject`
`parentId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:461 (opens new window)

# loadComponentDefinition

▸ loadComponentDefinition(conversationId, component): void

# Parameters

Name	Type
`conversationId`	`number`
`component`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:599 (opens new window)

# loadConfiguration

▸ loadConfiguration(kernelConversationId, configurationObject, position): void

# Parameters

Name	Type
`kernelConversationId`	`number`
`configurationObject`	`string`
`position`	`KernelVector3`

# Returns

void

# Defined in

packages/typings/kernel.ts:444 (opens new window)

# loadExternalAttributeDefinition

▸ loadExternalAttributeDefinition(serializedDefinition): void

# Parameters

Name	Type
`serializedDefinition`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:626 (opens new window)

# loadFreeFlyingConfiguration

▸ loadFreeFlyingConfiguration(conversationId, configuration): void

# Parameters

Name	Type
`conversationId`	`number`
`configuration`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:456 (opens new window)

# loadPlainComponent

▸ loadPlainComponent(conversationId, componentId, configuration): void

# Parameters

Name	Type
`conversationId`	`number`
`componentId`	`string`
`configuration`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:450 (opens new window)

# loadedItemConfiguration

▸ loadedItemConfiguration(conversationId, itemId, serializedItemConfiguration): void

# Parameters

Name	Type
`conversationId`	`number`
`itemId`	`string`
`serializedItemConfiguration`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:485 (opens new window)

# loadedSubComponent

▸ loadedSubComponent(parentId, partId, componentId, configuration): void

# Parameters

Name	Type
`parentId`	`number`
`partId`	`number`
`componentId`	`string`
`configuration`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:478 (opens new window)

# requestDeltaPlanComponentConstruction

▸ requestDeltaPlanComponentConstruction(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:495 (opens new window)

# requestPlanComponentConstruction

▸ requestPlanComponentConstruction(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:493 (opens new window)

# requestPlanComponentConstructionRecursive

▸ requestPlanComponentConstructionRecursive(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:497 (opens new window)

# requestPlanObjectConstruction

▸ requestPlanObjectConstruction(planObjectId): void

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:491 (opens new window)

# requestPreviewGeometry

▸ requestPreviewGeometry(componentId, planObjectId, allowInsertInBetween): void

# Parameters

Name	Type
`componentId`	`number`
`planObjectId`	`number`
`allowInsertInBetween`	`boolean`

# Returns

void

# Defined in

packages/typings/kernel.ts:499 (opens new window)

# resetPriceListIds

▸ resetPriceListIds(): void

# Returns

void

# Defined in

packages/typings/kernel.ts:474 (opens new window)

# setActiveGroupInView

▸ setActiveGroupInView(groupId): void

# Parameters

Name	Type
`groupId`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:611 (opens new window)

# setActiveGroupInViewForPlanObject

▸ setActiveGroupInViewForPlanObject(groupId, runtimeId): void

# Parameters

Name	Type
`groupId`	`string`
`runtimeId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:620 (opens new window)

# setComponentParameter

▸ setComponentParameter(componentId, parameterKey, value): void

# Parameters

Name	Type
`componentId`	`number`
`parameterKey`	`string`
`value`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:503 (opens new window)

# setEnvironmentVariable

▸ setEnvironmentVariable(key, value): void

# Parameters

Name	Type
`key`	`string`
`value`	`any`

# Returns

void

# Defined in

packages/typings/kernel.ts:515 (opens new window)

# setExternalMeshInvalid

▸ setExternalMeshInvalid(meshId, quality): void

# Parameters

Name	Type
`meshId`	`string`
`quality`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:605 (opens new window)

# setLevel

▸ setLevel(restrictionLevel): void

# Parameters

Name	Type
`restrictionLevel`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:517 (opens new window)

# setMaterialProperties

▸ setMaterialProperties(propertiesOfMaterials): void

# Parameters

Name	Type
`propertiesOfMaterials`	{ `id`: `string` ; `properties`: `EmscriptenMap`<`string`, `string`> }[]

# Returns

void

# Defined in

packages/typings/kernel.ts:613 (opens new window)

# setMaterialsInGroup

▸ setMaterialsInGroup(materialGroups): void

# Parameters

Name	Type
`materialGroups`	{ `group`: `string` ; `materials`: `string`[] }[]

# Returns

void

# Defined in

packages/typings/kernel.ts:607 (opens new window)

# setPlanComponentParameters

▸ setPlanComponentParameters(componentIds, parameterKey, value): void

# Parameters

Name	Type
`componentIds`	`any`
`parameterKey`	`string`
`value`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:509 (opens new window)

# setPlanObjectParameter

▸ setPlanObjectParameter(planObjectId, parameterKey, value): void

# Parameters

Name	Type
`planObjectId`	`number`
`parameterKey`	`string`
`value`	`string`

# Returns

void

# Defined in

packages/typings/kernel.ts:521 (opens new window)

# setUpdateCallbacksOnlyIfGeometryIsReady

▸ setUpdateCallbacksOnlyIfGeometryIsReady(onlyUpdateIfReady): void

# Parameters

Name	Type
`onlyUpdateIfReady`	`boolean`

# Returns

void

# Defined in

packages/typings/kernel.ts:434 (opens new window)

▸ setUpdateCallbacksOnlyIfGeometryIsReady(updateCallbacksOnlyIfGeometryIsReady): void

# Parameters

Name	Type
`updateCallbacksOnlyIfGeometryIsReady`	`boolean`

# Returns

void

# Defined in

packages/typings/kernel.ts:622 (opens new window)

# syncPlanObjectToView

▸ syncPlanObjectToView(conversationId, planObjectId): void

# Parameters

Name	Type
`conversationId`	`number`
`planObjectId`	`number`

# Returns

void

# Defined in

packages/typings/kernel.ts:601 (opens new window)

# useEnvironmentGeometry

▸ useEnvironmentGeometry(requestEnvironmentGeometry): void

# Parameters

Name	Type
`requestEnvironmentGeometry`	`boolean`

# Returns

void

# Defined in

packages/typings/kernel.ts:438 (opens new window)

# useHDGeometry

▸ useHDGeometry(requestUseHDGeometry): void

# Parameters

Name	Type
`requestUseHDGeometry`	`boolean`

# Returns

void

# Defined in

packages/typings/kernel.ts:436 (opens new window)