RoomleConfigurator.Internal.default-5

configurator-core/src/roomle-configurator.internal.default

Hierarchy

• default

  ↳ default

Table of contents

Constructors

• constructor

Properties

• _creator_

• externalMeshQueue

• muteKernelCallbacks

Accessors

• callbacks

• configurationExporter

• kernelContainer

• kernelInstance

• planInteractionHandler

• planModelViewHelper

Methods

• Editor3ChangedMesh

• Editor3dAddCube

• Editor3dAddCubeUVMod

• Editor3dAddCylinder

• Editor3dAddCylinderUVMod

• Editor3dAddDockPreview

• Editor3dAddFittingLine

• Editor3dAddFittingPoint

• Editor3dAddMesh

• Editor3dAddMeshUVCoord

• Editor3dAddMeshUVMod

• Editor3dAddPrism

• Editor3dAddPrismUVMod

• Editor3dAddRectangle

• Editor3dAddRectangleUVMod

• Editor3dAddSphere

• Editor3dAddSphereUVMod

• Editor3dBeginConstruction

• Editor3dBeginGroup

• Editor3dComponentCreated

• Editor3dComponentDocked

• Editor3dCopy

• Editor3dEndConstruction

• Editor3dEndGroup

• Editor3dGeometryNotReady

• Editor3dGeometryReady

• Editor3dLoadMaterial

• Editor3dPlanObjectConstructionDone

• Editor3dPreviewConstructionDone

• Editor3dRemoveMesh

• Editor3dRotateAround

• Editor3dRotateBy

• Editor3dSelectObject

• Editor3dSetMaterial

• Editor3dSetPreviewLineAssociations

• Editor3dSetPreviewPointAssociations

• Editor3dTranslateBy

• Editor3dUpdatePlanComponentPosition

• Editor3dUpdatePlanComponentRotation

• Editor3dUpdatePlanComponentTransform

• Editor3dUpdatePlanObjectPosition

• Editor3dUpdatePlanObjectRotation

• Editor3dUpdatePlanObjectTransform

• _externalObjectArrangementChanged

• _externalObjectComponentSplitOff

• _externalObjectConfigurationDuplicated

• _externalObjectConfigurationsMerged

• _externalObjectPlanChanged

• addConfiguratorListener

• addDebugClient

• addLabelToKernelComponent

• addMesh

• addPlanMesh

• addPlanObjectFromItem

• addPlannerListener

• addUiDataAndPriceToPartList

• addUiDataToPartList

• beginConstruction

• beginPlanConstruction

• calcPartsPriceSum

• cancelDocking

• catalogItemLoaded

• changeAnimationValue

• changeCommonComponentParameter

• changeComponentParameter

• changePlanObjectParameter

• changeUseOfHDGeometry

• cleanUpCallbacks

• componentConfigurationUpdated

• componentDefinitionLoaded

• componentDefinitionLoadingError

• componentDeleted

• componentMetaUpdated

• componentParameters

• configurationLoaded

• configurationLoadingError

• configureExternalObjectApi

• coupleReferences

• createNewSerializedConfiguration

• createPlanFromObject

• destroy

• dockComponent

• dockComponentWithPosition

• dockExternalObjectComponent

• duplicateItems

• endConstruction

• endPlanConstruction

• externalObjectArrangementChanged

• externalObjectComponentDeleted

• externalObjectComponentSplitOff

• externalObjectConfigurationChanged

• externalObjectConfigurationDeleted

• externalObjectConfigurationDuplicated

• externalObjectConfigurationLoaded

• externalObjectConfigurationsMerged

• externalObjectPlanChanged

• getComponentParameters

• getConfigurationData

• getConfigurationHash

• getCurrentConfigurationHash

• getGlobalParameters

• getParameterGroups

• getPartList

• getPlanObjectParameters

• getRuntimeComponentId

• getRuntimeComponentIdOfRootComponent

• getSerializedConfiguration

• handlerSwitchedPlans

• init

• insertItems

• isConstructionPlanElement

• isExternalObjectOrComponent

• isReady

• listOfVariants

• listOfVariantsError

• loadComponent

• loadComponentIntoKernel

• loadConfiguration

• loadItemConfigurations

• multiSelectionChange

• onLoadComponentError

• pause

• planBoundsChanged

• planCleared

• planCompletelyLoaded

• planElement3dMeshChanged

• planElementAdded

• planElementChanged

• planElementRemoved

• planHistoryStateChanged

• planObjectConfigurationChanged

• planObjectConfigurationCreated

• planObjectConfigurationLoaded

• planObjectConfigurationUpdated

• planObjectCreated

• planObjectDeleted

• planObjectSelectionChanged

• planObjectUpdated

• planSnapshotCreated

• previewDockingsWithDrag

• registerCallbacks

• removeConfiguratorListener

• removePlannerListener

• requestAssets

• requestCatalogItem

• requestComponentDimensions

• requestDeleteComponent

• requestDeleteComponents

• requestDeletePlanComponent

• requestExternalMesh

• requestMaterialProperties

• requestMaterialsInGroup

• requestPartListAndUpdatePricesOfParts

• requestPlanComponentConstruction

• requestPlanObjectConstruction

• requestPlanObjectDimensions

• requestSync

• resume

• sceneCleared

• selectedComponent

• selectionChange

• setActiveGroupInView

• setActiveGroupInViewForPlanObject

• startedDrawing

• stoppedDrawing

• uiRequestConfiguration

• updateAnimationParameters

• updateMesh2d

• updatePlanObjectDependencies

• webGlPreviewDockings

• webGlPreviewDockingsForExternalObjects

• webGlPreviewDockingsForKernelObjects

Constructors

constructor

• new default(creator)

Parameters

Name	Type
creator	string

Overrides

default.constructor

Properties

_creator_

• _creator_: string

Inherited from

default.creator

---

externalMeshQueue

• externalMeshQueue: PromiseQueue<void>

Inherited from

default.externalMeshQueue

---

muteKernelCallbacks

• muteKernelCallbacks: boolean = false

Inherited from

default.muteKernelCallbacks

Accessors

callbacks

• get callbacks(): default

Returns

default

---

configurationExporter

• get configurationExporter(): ConfigurationExporter

Returns

ConfigurationExporter

Inherited from

ConfiguratorKernelAccess.configurationExporter

---

kernelContainer

• get kernelContainer(): any

Returns

any

Overrides

ConfiguratorKernelAccess.kernelContainer

---

kernelInstance

• get kernelInstance(): ConfiguratorKernelClass

Returns

ConfiguratorKernelClass

Inherited from

ConfiguratorKernelAccess.kernelInstance

---

planInteractionHandler

• get planInteractionHandler(): PlanInteractionHandler

Returns

PlanInteractionHandler

---

planModelViewHelper

• get planModelViewHelper(): PlanModelViewHelper

Returns

PlanModelViewHelper

Methods

Editor3ChangedMesh

▸ Editor3ChangedMesh(runtimeComponentId, meshId, geometryName, meshAttributes): void

Parameters

Name	Type
runtimeComponentId	number
meshId	number
geometryName	string
meshAttributes	KernelMeshAttributes

Returns

void

Inherited from

default.Editor3ChangedMesh

---

Editor3dAddCube

▸ Editor3dAddCube(): void

Returns

void

Inherited from

default.Editor3dAddCube

---

Editor3dAddCubeUVMod

▸ Editor3dAddCubeUVMod(): void

Returns

void

Inherited from

default.Editor3dAddCubeUVMod

---

Editor3dAddCylinder

▸ Editor3dAddCylinder(): void

Returns

void

Inherited from

default.Editor3dAddCylinder

---

Editor3dAddCylinderUVMod

▸ Editor3dAddCylinderUVMod(): void

Returns

void

Inherited from

default.Editor3dAddCylinderUVMod

---

Editor3dAddDockPreview

▸ Editor3dAddDockPreview(componentId, previewId): void

Parameters

Name	Type
componentId	number
previewId	number

Returns

void

Inherited from

default.Editor3dAddDockPreview

---

Editor3dAddFittingLine

▸ Editor3dAddFittingLine(): void

Returns

void

Inherited from

default.Editor3dAddFittingLine

---

Editor3dAddFittingPoint

▸ Editor3dAddFittingPoint(): void

Returns

void

Inherited from

default.Editor3dAddFittingPoint

---

Editor3dAddMesh

▸ Editor3dAddMesh(runtimeComponentId, meshId, geometryName, environmentGeometry, meshAttributes, meshBuffer): void

Parameters

Name	Type
runtimeComponentId	number
meshId	number
geometryName	string
environmentGeometry	boolean
meshAttributes	KernelMeshAttributes
meshBuffer	KernelMeshBuffer

Returns

void

Inherited from

default.Editor3dAddMesh

---

Editor3dAddMeshUVCoord

▸ Editor3dAddMeshUVCoord(): void

Returns

void

Inherited from

default.Editor3dAddMeshUVCoord

---

Editor3dAddMeshUVMod

▸ Editor3dAddMeshUVMod(): void

Returns

void

Inherited from

default.Editor3dAddMeshUVMod

---

Editor3dAddPrism

▸ Editor3dAddPrism(): void

Returns

void

Inherited from

default.Editor3dAddPrism

---

Editor3dAddPrismUVMod

▸ Editor3dAddPrismUVMod(): void

Returns

void

Inherited from

default.Editor3dAddPrismUVMod

---

Editor3dAddRectangle

▸ Editor3dAddRectangle(): void

Returns

void

Inherited from

default.Editor3dAddRectangle

---

Editor3dAddRectangleUVMod

▸ Editor3dAddRectangleUVMod(): void

Returns

void

Inherited from

default.Editor3dAddRectangleUVMod

---

Editor3dAddSphere

▸ Editor3dAddSphere(): void

Returns

void

Inherited from

default.Editor3dAddSphere

---

Editor3dAddSphereUVMod

▸ Editor3dAddSphereUVMod(): void

Returns

void

Inherited from

default.Editor3dAddSphereUVMod

---

Editor3dBeginConstruction

▸ Editor3dBeginConstruction(id, isDeltaUpdate): void

Parameters

Name	Type
id	number
isDeltaUpdate	boolean

Returns

void

Inherited from

default.Editor3dBeginConstruction

---

Editor3dBeginGroup

▸ Editor3dBeginGroup(): void

Returns

void

Inherited from

default.Editor3dBeginGroup

---

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

---

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

---

Editor3dCopy

▸ Editor3dCopy(): void

Returns

void

Inherited from

default.Editor3dCopy

---

Editor3dEndConstruction

▸ Editor3dEndConstruction(id): void

Parameters

Name	Type
id	number

Returns

void

Inherited from

default.Editor3dEndConstruction

---

Editor3dEndGroup

▸ Editor3dEndGroup(): void

Returns

void

Inherited from

default.Editor3dEndGroup

---

Editor3dGeometryNotReady

▸ Editor3dGeometryNotReady(id): void

Parameters

Name	Type
id	number

Returns

void

Inherited from

default.Editor3dGeometryNotReady

---

Editor3dGeometryReady

▸ Editor3dGeometryReady(id): void

Parameters

Name	Type
id	number

Returns

void

Inherited from

default.Editor3dGeometryReady

---

Editor3dLoadMaterial

▸ Editor3dLoadMaterial(): void

Returns

void

Inherited from

default.Editor3dLoadMaterial

---

Editor3dPlanObjectConstructionDone

▸ Editor3dPlanObjectConstructionDone(planObjectId): void

Parameters

Name	Type
planObjectId	number

Returns

void

Inherited from

default.Editor3dPlanObjectConstructionDone

---

Editor3dPreviewConstructionDone

▸ Editor3dPreviewConstructionDone(componentId, objectId): void

Parameters

Name	Type
componentId	number
objectId	number

Returns

void

Inherited from

default.Editor3dPreviewConstructionDone

---

Editor3dRemoveMesh

▸ Editor3dRemoveMesh(runtimeComponentId, meshId): void

Parameters

Name	Type
runtimeComponentId	number
meshId	number

Returns

void

Inherited from

default.Editor3dRemoveMesh

---

Editor3dRotateAround

▸ Editor3dRotateAround(): void

Returns

void

Inherited from

default.Editor3dRotateAround

---

Editor3dRotateBy

▸ Editor3dRotateBy(): void

Returns

void

Inherited from

default.Editor3dRotateBy

---

Editor3dSelectObject

▸ Editor3dSelectObject(): void

Returns

void

Inherited from

default.Editor3dSelectObject

---

Editor3dSetMaterial

▸ Editor3dSetMaterial(): void

Returns

void

Inherited from

default.Editor3dSetMaterial

---

Editor3dSetPreviewLineAssociations

▸ Editor3dSetPreviewLineAssociations(dockLines, previewId): void

Parameters

Name	Type
dockLines	any
previewId	number

Returns

void

Inherited from

default.Editor3dSetPreviewLineAssociations

---

Editor3dSetPreviewPointAssociations

▸ Editor3dSetPreviewPointAssociations(dockPairs, previewId): void

Parameters

Name	Type
dockPairs	any
previewId	number

Returns

void

Inherited from

default.Editor3dSetPreviewPointAssociations

---

Editor3dTranslateBy

▸ Editor3dTranslateBy(): void

Returns

void

Inherited from

default.Editor3dTranslateBy

---

Editor3dUpdatePlanComponentPosition

▸ Editor3dUpdatePlanComponentPosition(): void

Returns

void

Inherited from

default.Editor3dUpdatePlanComponentPosition

---

Editor3dUpdatePlanComponentRotation

▸ Editor3dUpdatePlanComponentRotation(): void

Returns

void

Inherited from

default.Editor3dUpdatePlanComponentRotation

---

Editor3dUpdatePlanComponentTransform

▸ Editor3dUpdatePlanComponentTransform(): void

Returns

void

Inherited from

default.Editor3dUpdatePlanComponentTransform

---

Editor3dUpdatePlanObjectPosition

▸ Editor3dUpdatePlanObjectPosition(): void

Returns

void

Inherited from

default.Editor3dUpdatePlanObjectPosition

---

Editor3dUpdatePlanObjectRotation

▸ Editor3dUpdatePlanObjectRotation(): void

Returns

void

Inherited from

default.Editor3dUpdatePlanObjectRotation

---

Editor3dUpdatePlanObjectTransform

▸ Editor3dUpdatePlanObjectTransform(): void

Returns

void

Inherited from

default.Editor3dUpdatePlanObjectTransform

---

_externalObjectArrangementChanged

▸ _externalObjectArrangementChanged(changedGroup): void

Parameters

Name	Type
changedGroup	ExternalObjectGroup

Returns

void

---

_externalObjectComponentSplitOff

▸ _externalObjectComponentSplitOff(splitGroups): void

Parameters

Name	Type
splitGroups	ExternalObjectGroup[]

Returns

void

---

_externalObjectConfigurationDuplicated

▸ _externalObjectConfigurationDuplicated(sourceGroupId, newGroupPosition): void

Parameters

Name	Type
sourceGroupId	string
newGroupPosition	ExternalObjectGroupPosition

Returns

void

---

_externalObjectConfigurationsMerged

▸ _externalObjectConfigurationsMerged(mergedGroup, idsOfGroupsMerged, targetRootModuleId): void

Parameters

Name	Type
mergedGroup	ExternalObjectGroup
idsOfGroupsMerged	string | string[]
targetRootModuleId	string

Returns

void

---

_externalObjectPlanChanged

▸ _externalObjectPlanChanged(movedGroup): void

Parameters

Name	Type
movedGroup	ExternalObjectGroup

Returns

void

---

addConfiguratorListener

▸ addConfiguratorListener(listener): void

Parameters

Name	Type
listener	ConfiguratorKernelCallbackI

Returns

void

Inherited from

default.addConfiguratorListener

---

addDebugClient

▸ addDebugClient(debugClient): void

Parameters

Name	Type
debugClient	DebugClient

Returns

void

Inherited from

default.addDebugClient

---

addLabelToKernelComponent

▸ addLabelToKernelComponent(kernelComponent): void

Parameters

Name	Type
kernelComponent	KernelComponent

Returns

void

Inherited from

default.addLabelToKernelComponent

---

addMesh

▸ addMesh(planElement, material, vertices, indices, uvCoords, normals): void

Parameters

Name	Type
planElement	PlanElement
material	any
vertices	Float32Array
indices	Int32Array
uvCoords	Float32Array
normals	Float32Array

Returns

void

---

addPlanMesh

▸ addPlanMesh(plan, material, vertices, indices, uvCoords, normals, type): void

Parameters

Name	Type
plan	Plan
material	any
vertices	Float32Array
indices	Int32Array
uvCoords	Float32Array
normals	Float32Array
type	KernelEnum

Returns

void

---

addPlanObjectFromItem

▸ addPlanObjectFromItem(rapiElement, position?, rotation?): Promise<number>

Parameters

Name	Type
rapiElement	RapiItem | RapiConfiguration
position?	Position3
rotation?	number

Returns

Promise<number>

---

addPlannerListener

▸ addPlannerListener(listener): void

Parameters

Name	Type
listener	PlannerKernelCallbackI

Returns

void

---

addUiDataAndPriceToPartList

▸ addUiDataAndPriceToPartList(partList, hash): Promise<KernelPartList>

Parameters

Name	Type
partList	KernelPartList
hash	string

Returns

Promise<KernelPartList>

Inherited from

default.addUiDataAndPriceToPartList

---

addUiDataToPartList

▸ addUiDataToPartList(partList, hash): KernelPart[]

Parameters

Name	Type
partList	KernelPart[]
hash	string

Returns

KernelPart[]

Inherited from

default.addUiDataToPartList

---

beginConstruction

▸ beginConstruction(): void

Returns

void

---

beginPlanConstruction

▸ beginPlanConstruction(plan): void

Parameters

Name	Type
plan	Plan

Returns

void

---

calcPartsPriceSum

▸ calcPartsPriceSum(partList): Promise<KernelPartListPrice>

Parameters

Name	Type
partList	KernelPartList

Returns

Promise<KernelPartListPrice>

Inherited from

default.calcPartsPriceSum

---

cancelDocking

▸ cancelDocking(componentId): void

Parameters

Name	Type
componentId	number

Returns

void

Inherited from

default.cancelDocking

---

catalogItemLoaded

▸ catalogItemLoaded(catalogItem): void

Parameters

Name	Type
catalogItem	RapiItem

Returns

void

---

changeAnimationValue

▸ changeAnimationValue(elementId, parameterKey, value, applyToChildren, animate): void

Parameters

Name	Type
elementId	number
parameterKey	string
value	string
applyToChildren	boolean
animate	boolean

Returns

void

Inherited from

default.changeAnimationValue

---

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

---

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

---

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

---

changeUseOfHDGeometry

▸ changeUseOfHDGeometry(context, useHDGeometry): void

Parameters

Name	Type
context	default
useHDGeometry	boolean

Returns

void

Inherited from

default.changeUseOfHDGeometry

---

cleanUpCallbacks

▸ cleanUpCallbacks(): void

Returns

void

Overrides

default.cleanUpCallbacks

---

componentConfigurationUpdated

▸ componentConfigurationUpdated(componentId, geometryChanged): void

Parameters

Name	Type
componentId	number
geometryChanged	boolean

Returns

void

Inherited from

default.componentConfigurationUpdated

---

componentDefinitionLoaded

▸ componentDefinitionLoaded(conversationId, componentId): void

Parameters

Name	Type
conversationId	number
componentId	number

Returns

void

Inherited from

default.componentDefinitionLoaded

---

componentDefinitionLoadingError

▸ componentDefinitionLoadingError(conversationId, errorMessage): void

Parameters

Name	Type
conversationId	number
errorMessage	string

Returns

void

Inherited from

default.componentDefinitionLoadingError

---

componentDeleted

▸ componentDeleted(componentId): void

Parameters

Name	Type
componentId	number

Returns

void

Inherited from

default.componentDeleted

---

componentMetaUpdated

▸ componentMetaUpdated(componentId): void

Parameters

Name	Type
componentId	number

Returns

void

Inherited from

default.componentMetaUpdated

---

componentParameters

▸ componentParameters(): void

Returns

void

Inherited from

default.componentParameters

---

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

default.configurationLoaded

---

configurationLoadingError

▸ configurationLoadingError(_runtimeId, errors?): void

Parameters

Name	Type
_runtimeId	number
errors?	any[]

Returns

void

Inherited from

default.configurationLoadingError

---

configureExternalObjectApi

▸ configureExternalObjectApi(externalObjectSettings?): Promise<void>

Parameters

Name	Type
externalObjectSettings?	ExternalObjectApiConfiguration

Returns

Promise<void>

Overrides

default.configureExternalObjectApi

---

coupleReferences

▸ coupleReferences(jsObject, coreReference): void

Parameters

Name	Type
jsObject	any
coreReference	KernelObject

Returns

void

---

createNewSerializedConfiguration

▸ createNewSerializedConfiguration(configurationRuntimeId): string

Parameters

Name	Type
configurationRuntimeId	number

Returns

string

Inherited from

default.createNewSerializedConfiguration

---

createPlanFromObject

▸ createPlanFromObject(rapiElement, position?, rotation?): Plan

Parameters

Name	Type
rapiElement	RapiItem | RapiConfiguration
position?	Position3
rotation?	number

Returns

Plan

---

destroy

▸ destroy(): void

Returns

void

Inherited from

default.destroy

---

dockComponent

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

Parameters

Name	Type
parentId	number
parentDockId	number
childId	number
childDockId	number

Returns

void

Inherited from

default.dockComponent

---

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

---

dockExternalObjectComponent

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

Parameters

Name	Type
parentId	number
parentDockId	number
childId	number
childDockId	number

Returns

void

Overrides

default.dockExternalObjectComponent

---

duplicateItems

▸ duplicateItems(planObjects): PlanObject[]

Parameters

Name	Type
planObjects	PlanObject[]

Returns

PlanObject[]

---

endConstruction

▸ endConstruction(): void

Returns

void

---

endPlanConstruction

▸ endPlanConstruction(plan): void

Parameters

Name	Type
plan	Plan

Returns

void

---

externalObjectArrangementChanged

▸ externalObjectArrangementChanged(plan, planObject, changedGroup): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
changedGroup	ExternalObjectGroup

Returns

void

---

externalObjectComponentDeleted

▸ externalObjectComponentDeleted(plan, planObject, remainingGroupOrGroups, deletedRootModuleId): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
remainingGroupOrGroups	ExternalObjectGroup | ExternalObjectGroup[]
deletedRootModuleId	string

Returns

void

---

externalObjectComponentSplitOff

▸ externalObjectComponentSplitOff(plan, planObject, splitGroups): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
splitGroups	ExternalObjectGroup[]

Returns

void

---

externalObjectConfigurationChanged

▸ externalObjectConfigurationChanged(plan, planObject, configuration): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
configuration	string

Returns

void

---

externalObjectConfigurationDeleted

▸ externalObjectConfigurationDeleted(plan, planObject, uniqueId): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
uniqueId	string

Returns

void

---

externalObjectConfigurationDuplicated

▸ externalObjectConfigurationDuplicated(plan, planObject, sourceGroupId, newGroupPosition): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
sourceGroupId	string
newGroupPosition	ExternalObjectGroupPosition

Returns

void

---

externalObjectConfigurationLoaded

▸ externalObjectConfigurationLoaded(plan, planObject, configuration): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
configuration	string

Returns

void

---

externalObjectConfigurationsMerged

▸ externalObjectConfigurationsMerged(plan, planObject, mergedGroup, idsOfGroupsMerged, targetRootModuleId): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
mergedGroup	ExternalObjectGroup
idsOfGroupsMerged	string | string[]
targetRootModuleId	string

Returns

void

---

externalObjectPlanChanged

▸ externalObjectPlanChanged(plan, planObject, movedGroup): void

Parameters

Name	Type
plan	Plan
planObject	PlanObject
movedGroup	ExternalObjectGroup

Returns

void

---

getComponentParameters

▸ getComponentParameters(componentId): KernelParameter[]

Parameters

Name	Type
componentId	number

Returns

KernelParameter[]

Inherited from

default.getComponentParameters

---

getConfigurationData

▸ getConfigurationData(planObjectId): Promise<RapiConfiguration>

Parameters

Name	Type
planObjectId	number

Returns

Promise<RapiConfiguration>

Inherited from

default.getConfigurationData

---

getConfigurationHash

▸ getConfigurationHash(context): Promise<string>

Parameters

Name	Type
context	default

Returns

Promise<string>

Inherited from

default.getConfigurationHash

---

getCurrentConfigurationHash

▸ getCurrentConfigurationHash(planObjectId): string

Parameters

Name	Type
planObjectId	number

Returns

string

Inherited from

default.getCurrentConfigurationHash

---

getGlobalParameters

▸ getGlobalParameters(planObjectId, rootComponentParametersAsGlobal): Promise<KernelParameter[]>

Parameters

Name	Type
planObjectId	number
rootComponentParametersAsGlobal	boolean

Returns

Promise<KernelParameter[]>

Inherited from

default.getGlobalParameters

---

getParameterGroups

▸ getParameterGroups(): KernelParameterGroup[]

Returns

KernelParameterGroup[]

Inherited from

default.getParameterGroups

---

getPartList

▸ getPartList(): Promise<unknown>

Returns

Promise<unknown>

Inherited from

default.getPartList

---

getPlanObjectParameters

▸ getPlanObjectParameters(objectId): KernelParameter[]

Parameters

Name	Type
objectId	number

Returns

KernelParameter[]

Inherited from

default.getPlanObjectParameters

---

getRuntimeComponentId

▸ getRuntimeComponentId(runtimeComponentId): string

Parameters

Name	Type
runtimeComponentId	number

Returns

string

Inherited from

default.getRuntimeComponentId

---

getRuntimeComponentIdOfRootComponent

▸ getRuntimeComponentIdOfRootComponent(planObjectId): number

Parameters

Name	Type
planObjectId	number

Returns

number

Inherited from

default.getRuntimeComponentIdOfRootComponent

---

getSerializedConfiguration

▸ getSerializedConfiguration(objectId): string

Parameters

Name	Type
objectId	number

Returns

string

Inherited from

default.getSerializedConfiguration

---

handlerSwitchedPlans

▸ handlerSwitchedPlans(fromPlan, toPlan): void

Parameters

Name	Type
fromPlan	Plan
toPlan	Plan

Returns

void

---

init

▸ init(kernelType): void

Parameters

Name	Type
kernelType	KERNEL_TYPE

Returns

void

Inherited from

default.init

---

insertItems

▸ insertItems(itemList): Promise<number[]>

Parameters

Name	Type
itemList	(RapiItem | RapiConfiguration)[]

Returns

Promise<number[]>

---

isConstructionPlanElement

▸ isConstructionPlanElement(planElement): boolean

Parameters

Name	Type
planElement	PlanElement

Returns

boolean

---

isExternalObjectOrComponent

▸ isExternalObjectOrComponent(planObjectOrComponentId): boolean

Parameters

Name	Type
planObjectOrComponentId	number

Returns

boolean

Inherited from

default.isExternalObjectOrComponent

---

isReady

▸ isReady(): void

Returns

void

Overrides

default.isReady

---

listOfVariants

▸ listOfVariants(_componentId, _list): void

Parameters

Name	Type
_componentId	string
_list	VariantsList

Returns

void

Inherited from

default.listOfVariants

---

listOfVariantsError

▸ listOfVariantsError(dbId, error): void

Parameters

Name	Type
dbId	string
error	string

Returns

void

Inherited from

default.listOfVariantsError

---

loadComponent

▸ loadComponent(componentIds): void

Parameters

Name	Type
componentIds	string[]

Returns

void

Inherited from

default.loadComponent

---

loadComponentIntoKernel

▸ loadComponentIntoKernel(component, componentId): void

Parameters

Name	Type
component	string
componentId	string

Returns

void

Inherited from

default.loadComponentIntoKernel

---

loadConfiguration

▸ loadConfiguration(configuration): void

Parameters

Name	Type
configuration	string

Returns

void

Inherited from

default.loadConfiguration

---

loadItemConfigurations

▸ loadItemConfigurations(itemIds): Promise<void>

Parameters

Name	Type
itemIds	string[]

Returns

Promise<void>

Inherited from

default.loadItemConfigurations

---

multiSelectionChange

▸ multiSelectionChange(runtimeComponentIds, rootComponentId): void

Parameters

Name	Type
runtimeComponentIds	number[]
rootComponentId	number

Returns

void

Inherited from

default.multiSelectionChange

---

onLoadComponentError

▸ onLoadComponentError(error, id): void

Parameters

Name	Type
error	Error
id	string

Returns

void

Inherited from

default.onLoadComponentError

---

pause

▸ pause(): void

Returns

void

Inherited from

default.pause

---

planBoundsChanged

▸ planBoundsChanged(): void

Returns

void

---

planCleared

▸ planCleared(): void

Returns

void

---

planCompletelyLoaded

▸ planCompletelyLoaded(plan): void

Parameters

Name	Type
plan	Plan

Returns

void

---

planElement3dMeshChanged

▸ planElement3dMeshChanged(plan, element): void

Parameters

Name	Type
plan	Plan
element	PlanElement

Returns

void

---

planElementAdded

▸ planElementAdded(plan, element): Promise<void>

Parameters

Name	Type
plan	Plan
element	PlanElement

Returns

Promise<void>

---

planElementChanged

▸ planElementChanged(plan, element): void

Parameters

Name	Type
plan	Plan
element	PlanElement

Returns

void

---

planElementRemoved

▸ planElementRemoved(element): void

Parameters

Name	Type
element	PlanElement

Returns

void

---

planHistoryStateChanged

▸ planHistoryStateChanged(): void

Returns

void

---

planObjectConfigurationChanged

▸ planObjectConfigurationChanged(plan, object): void

Parameters

Name	Type
plan	Plan
object	PlanObject

Returns

void

---

planObjectConfigurationCreated

▸ planObjectConfigurationCreated(_plan, _element): void

Parameters

Name	Type
_plan	Plan
_element	PlanObject

Returns

void

---

planObjectConfigurationLoaded

▸ planObjectConfigurationLoaded(plan, element, success): Promise<void>

Parameters

Name	Type
plan	Plan
element	PlanElement
success	boolean

Returns

Promise<void>

---

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

---

planObjectCreated

▸ planObjectCreated(conversationId, planObjectId): void

Parameters

Name	Type
conversationId	number
planObjectId	number

Returns

void

Inherited from

default.planObjectCreated

---

planObjectDeleted

▸ planObjectDeleted(): void

Returns

void

Overrides

default.planObjectDeleted

---

planObjectSelectionChanged

▸ planObjectSelectionChanged(configurationRuntimeId, elementRuntimeId): void

Parameters

Name	Type
configurationRuntimeId	number
elementRuntimeId	number

Returns

void

---

planObjectUpdated

▸ planObjectUpdated(planObjectId, pendingDocking): void

Parameters

Name	Type
planObjectId	number
pendingDocking	boolean

Returns

void

Inherited from

default.planObjectUpdated

---

planSnapshotCreated

▸ planSnapshotCreated(planSnapshot): void

Parameters

Name	Type
planSnapshot	RapiPlanSnapshotPostData

Returns

void

---

previewDockingsWithDrag

▸ previewDockingsWithDrag(componentId, planObjectId): void

Parameters

Name	Type
componentId	number
planObjectId	number

Returns

void

Inherited from

default.previewDockingsWithDrag

---

registerCallbacks

▸ registerCallbacks(): void

Returns

void

Overrides

ConfiguratorKernelAccess.registerCallbacks

---

removeConfiguratorListener

▸ removeConfiguratorListener(listener): void

Parameters

Name	Type
listener	ConfiguratorKernelCallbackI

Returns

void

Inherited from

default.removeConfiguratorListener

---

removePlannerListener

▸ removePlannerListener(listener): void

Parameters

Name	Type
listener	PlannerKernelCallbackI

Returns

void

---

requestAssets

▸ requestAssets(requestedAssets): void

Parameters

Name	Type
requestedAssets	AssetRequest[]

Returns

void

Inherited from

default.requestAssets

---

requestCatalogItem

▸ requestCatalogItem(catalogItemId): void

Parameters

Name	Type
catalogItemId	string

Returns

void

---

requestComponentDimensions

▸ requestComponentDimensions(): void

Returns

void

Inherited from

default.requestComponentDimensions

---

requestDeleteComponent

▸ requestDeleteComponent(componentId): void

Parameters

Name	Type
componentId	number

Returns

void

Overrides

default.requestDeleteComponent

---

requestDeleteComponents

▸ requestDeleteComponents(componentIds): void

Parameters

Name	Type
componentIds	number[]

Returns

void

Overrides

default.requestDeleteComponents

---

requestDeletePlanComponent

▸ requestDeletePlanComponent(componentId): void

Parameters

Name	Type
componentId	number

Returns

void

Overrides

default.requestDeletePlanComponent

---

requestExternalMesh

▸ requestExternalMesh(requestedMeshes): Promise<void>

Parameters

Name	Type
requestedMeshes	{ meshId: string ; quality: number }[]

Returns

Promise<void>

Inherited from

default.requestExternalMesh

---

requestMaterialProperties

▸ requestMaterialProperties(materialIds): Promise<void>

Parameters

Name	Type
materialIds	string[]

Returns

Promise<void>

Inherited from

default.requestMaterialProperties

---

requestMaterialsInGroup

▸ requestMaterialsInGroup(groupIds): void

Parameters

Name	Type
groupIds	string[]

Returns

void

Inherited from

default.requestMaterialsInGroup

---

requestPartListAndUpdatePricesOfParts

▸ requestPartListAndUpdatePricesOfParts(hash?, _prices?): Promise<void>

Parameters

Name	Type
hash?	string
_prices?	Map<string, RapiPrice>

Returns

Promise<void>

Inherited from

default.requestPartListAndUpdatePricesOfParts

---

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

---

requestPlanObjectConstruction

▸ requestPlanObjectConstruction(objectId): void

Parameters

Name	Type
objectId	number

Returns

void

Inherited from

default.requestPlanObjectConstruction

---

requestPlanObjectDimensions

▸ requestPlanObjectDimensions(): void

Returns

void

Overrides

default.requestPlanObjectDimensions

---

requestSync

▸ requestSync(conversationId, planObjectId): void

Parameters

Name	Type
conversationId	number
planObjectId	number

Returns

void

Inherited from

default.requestSync

---

resume

▸ resume(): void

Returns

void

Inherited from

default.resume

---

sceneCleared

▸ sceneCleared(): void

Returns

void

Inherited from

default.sceneCleared

---

selectedComponent

▸ selectedComponent(componentId): void

Parameters

Name	Type
componentId	number

Returns

void

Inherited from

default.selectedComponent

---

selectionChange

▸ selectionChange(componentId, isRoot): void

Parameters

Name	Type
componentId	number
isRoot	boolean

Returns

void

Inherited from

default.selectionChange

---

setActiveGroupInView

▸ setActiveGroupInView(group): void

Parameters

Name	Type
group	string

Returns

void

Inherited from

default.setActiveGroupInView

---

setActiveGroupInViewForPlanObject

▸ setActiveGroupInViewForPlanObject(group, runtimeId?): void

Parameters

Name	Type
group	string
runtimeId?	number

Returns

void

Inherited from

default.setActiveGroupInViewForPlanObject

---

startedDrawing

▸ startedDrawing(): void

Returns

void

---

stoppedDrawing

▸ stoppedDrawing(): void

Returns

void

---

uiRequestConfiguration

▸ uiRequestConfiguration(objectId): void

Parameters

Name	Type
objectId	number

Returns

void

Inherited from

default.uiRequestConfiguration

---

updateAnimationParameters

▸ updateAnimationParameters(elementId, parameters): void

Parameters

Name	Type
elementId	number | number[]
parameters	KernelParameter[]

Returns

void

Inherited from

default.updateAnimationParameters

---

updateMesh2d

▸ updateMesh2d(): void

Returns

void

---

updatePlanObjectDependencies

▸ updatePlanObjectDependencies(planObjectId): void

Parameters

Name	Type
planObjectId	number

Returns

void

Inherited from

default.updatePlanObjectDependencies

---

webGlPreviewDockings

▸ webGlPreviewDockings(context, dragIn): void

Parameters

Name	Type
context	default
dragIn	boolean

Returns

void

Inherited from

default.webGlPreviewDockings

---

webGlPreviewDockingsForExternalObjects

▸ webGlPreviewDockingsForExternalObjects(context, _dragIn): void

Parameters

Name	Type
context	default
_dragIn	boolean

Returns

void

Inherited from

default.webGlPreviewDockingsForExternalObjects

---

webGlPreviewDockingsForKernelObjects

▸ webGlPreviewDockingsForKernelObjects(context, dragIn): void

Parameters

Name	Type
context	default
dragIn	boolean

Returns

void

Inherited from

default.webGlPreviewDockingsForKernelObjects