API ReferenceGlobalsPlannerKernelAccessMock

# Class: PlannerKernelAccessMock

# Hierarchy

PlannerKernelAccess

PlannerKernelAccessMock

# Implements

# Index

# Constructors

# Properties

# Accessors

# Methods

# Object literals

# Constructors

# constructor

+ new PlannerKernelAccessMock(creator: string): PlannerKernelAccessMock

Inherited from PlannerKernelAccess.constructor

Overrides ConfiguratorKernelAccess.constructor

Defined in packages/planner-core/src/services/planner-kernel-access.ts:62

Parameters:

Name Type
creator string

Returns: PlannerKernelAccessMock

# 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()

Inherited from ConfiguratorKernelAccess.externalMeshQueue

Defined in packages/common-core/src/configurator-kernel-access.ts:75


# muteKernelCallbacks

muteKernelCallbacks: boolean = false

Inherited from ConfiguratorKernelAccess.muteKernelCallbacks

Defined in packages/common-core/src/configurator-kernel-access.ts:77

# Accessors

# callbacks

get callbacks(): RoomlePlannerUiCallback‹›

Inherited from PlannerKernelAccess.callbacks

Defined in packages/planner-core/src/services/planner-kernel-access.ts:113

Returns: RoomlePlannerUiCallback‹›


# kernelContainer

get kernelContainer(): any

Inherited from PlannerKernelAccess.kernelContainer

Overrides CommonKernelAccess.kernelContainer

Defined in packages/planner-core/src/services/planner-kernel-access.ts:60

Returns: any


# kernelInstance

get kernelInstance(): ConfiguratorKernelClass

Inherited from CommonKernelAccess.kernelInstance

Defined in packages/common-core/src/services/common-kernel-access.ts:203

Returns: ConfiguratorKernelClass


# planInteractionHandler

get planInteractionHandler(): PlanInteractionHandler

Overrides PlannerKernelAccess.planInteractionHandler

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:18

Returns: PlanInteractionHandler


# planModelViewHelper

get planModelViewHelper(): any

Inherited from PlannerKernelAccess.planModelViewHelper

Defined in packages/planner-core/src/services/planner-kernel-access.ts:121

Returns: any

# 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

Inherited from ConfiguratorKernelAccess.Editor3dAddCube

Defined in packages/common-core/src/configurator-kernel-access.ts:614

Returns: void


# Editor3dAddCubeUVMod

Editor3dAddCubeUVMod(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddCubeUVMod

Defined in packages/common-core/src/configurator-kernel-access.ts:618

Returns: void


# Editor3dAddCylinder

Editor3dAddCylinder(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddCylinder

Defined in packages/common-core/src/configurator-kernel-access.ts:650

Returns: void


# Editor3dAddCylinderUVMod

Editor3dAddCylinderUVMod(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddCylinderUVMod

Defined in packages/common-core/src/configurator-kernel-access.ts:654

Returns: void


# Editor3dAddDockPreview

Editor3dAddDockPreview(componentId: number, previewId: number): void

Inherited from ConfiguratorKernelAccess.Editor3dAddDockPreview

Defined in packages/common-core/src/configurator-kernel-access.ts:586

Parameters:

Name Type
componentId number
previewId number

Returns: void


# Editor3dAddFittingLine

Editor3dAddFittingLine(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddFittingLine

Defined in packages/common-core/src/configurator-kernel-access.ts:670

Returns: void


# Editor3dAddFittingPoint

Editor3dAddFittingPoint(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddFittingPoint

Defined in packages/common-core/src/configurator-kernel-access.ts:666

Returns: void


# Editor3dAddMesh

Editor3dAddMesh(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddMesh

Defined in packages/common-core/src/configurator-kernel-access.ts:638

Returns: void


# Editor3dAddMeshUVCoord

Editor3dAddMeshUVCoord(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddMeshUVCoord

Defined in packages/common-core/src/configurator-kernel-access.ts:646

Returns: void


# Editor3dAddMeshUVMod

Editor3dAddMeshUVMod(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddMeshUVMod

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

Inherited from ConfiguratorKernelAccess.Editor3dAddPrism

Defined in packages/common-core/src/configurator-kernel-access.ts:658

Returns: void


# Editor3dAddPrismUVMod

Editor3dAddPrismUVMod(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddPrismUVMod

Defined in packages/common-core/src/configurator-kernel-access.ts:662

Returns: void


# Editor3dAddRectangle

Editor3dAddRectangle(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddRectangle

Defined in packages/common-core/src/configurator-kernel-access.ts:630

Returns: void


# Editor3dAddRectangleUVMod

Editor3dAddRectangleUVMod(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddRectangleUVMod

Defined in packages/common-core/src/configurator-kernel-access.ts:634

Returns: void


# Editor3dAddSphere

Editor3dAddSphere(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddSphere

Defined in packages/common-core/src/configurator-kernel-access.ts:622

Returns: void


# Editor3dAddSphereUVMod

Editor3dAddSphereUVMod(): void

Inherited from ConfiguratorKernelAccess.Editor3dAddSphereUVMod

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

Inherited from ConfiguratorKernelAccess.Editor3dBeginGroup

Defined in packages/common-core/src/configurator-kernel-access.ts:570

Returns: void


# Editor3dComponentCreated

Editor3dComponentCreated(id: number, position: KernelVector3, eulerAngles: KernelVector3, parent: number): void

Inherited from ConfiguratorKernelAccess.Editor3dComponentCreated

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

Inherited from ConfiguratorKernelAccess.Editor3dCopy

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

Inherited from ConfiguratorKernelAccess.Editor3dEndGroup

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

Inherited from ConfiguratorKernelAccess.Editor3dLoadMaterial

Defined in packages/common-core/src/configurator-kernel-access.ts:582

Returns: void


# Editor3dPlanObjectConstructionDone

Editor3dPlanObjectConstructionDone(planObjectId: number): Promise‹object›

Inherited from ConfiguratorKernelAccess.Editor3dPlanObjectConstructionDone

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

Inherited from ConfiguratorKernelAccess.Editor3dPreviewConstructionDone

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

Inherited from ConfiguratorKernelAccess.Editor3dRootComponentCreated

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

Inherited from ConfiguratorKernelAccess.Editor3dRotateAround

Defined in packages/common-core/src/configurator-kernel-access.ts:610

Returns: void


# Editor3dRotateBy

Editor3dRotateBy(): void

Inherited from ConfiguratorKernelAccess.Editor3dRotateBy

Defined in packages/common-core/src/configurator-kernel-access.ts:606

Returns: void


# Editor3dSelectObject

Editor3dSelectObject(): void

Inherited from ConfiguratorKernelAccess.Editor3dSelectObject

Defined in packages/common-core/src/configurator-kernel-access.ts:674

Returns: void


# Editor3dSetMaterial

Editor3dSetMaterial(): void

Inherited from ConfiguratorKernelAccess.Editor3dSetMaterial

Defined in packages/common-core/src/configurator-kernel-access.ts:578

Returns: void


# Editor3dSetPreviewLineAssociations

Editor3dSetPreviewLineAssociations(dockLines: any, previewId: number): void

Inherited from ConfiguratorKernelAccess.Editor3dSetPreviewLineAssociations

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

Inherited from ConfiguratorKernelAccess.Editor3dSetPreviewPointAssociations

Defined in packages/common-core/src/configurator-kernel-access.ts:590

Parameters:

Name Type
dockPairs any
previewId number

Returns: void


# Editor3dTranslateBy

Editor3dTranslateBy(): void

Inherited from ConfiguratorKernelAccess.Editor3dTranslateBy

Defined in packages/common-core/src/configurator-kernel-access.ts:602

Returns: void


# Editor3dUpdatePlanComponentPosition

Editor3dUpdatePlanComponentPosition(): void

Inherited from ConfiguratorKernelAccess.Editor3dUpdatePlanComponentPosition

Defined in packages/common-core/src/configurator-kernel-access.ts:694

Returns: void


# Editor3dUpdatePlanComponentRotation

Editor3dUpdatePlanComponentRotation(): void

Inherited from ConfiguratorKernelAccess.Editor3dUpdatePlanComponentRotation

Defined in packages/common-core/src/configurator-kernel-access.ts:698

Returns: void


# Editor3dUpdatePlanComponentTransform

Editor3dUpdatePlanComponentTransform(): void

Inherited from ConfiguratorKernelAccess.Editor3dUpdatePlanComponentTransform

Defined in packages/common-core/src/configurator-kernel-access.ts:702

Returns: void


# Editor3dUpdatePlanObjectPosition

Editor3dUpdatePlanObjectPosition(): void

Inherited from ConfiguratorKernelAccess.Editor3dUpdatePlanObjectPosition

Defined in packages/common-core/src/configurator-kernel-access.ts:682

Returns: void


# Editor3dUpdatePlanObjectRotation

Editor3dUpdatePlanObjectRotation(): void

Inherited from ConfiguratorKernelAccess.Editor3dUpdatePlanObjectRotation

Defined in packages/common-core/src/configurator-kernel-access.ts:686

Returns: void


# Editor3dUpdatePlanObjectTransform

Editor3dUpdatePlanObjectTransform(): void

Inherited from ConfiguratorKernelAccess.Editor3dUpdatePlanObjectTransform

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


# addMesh

addMesh(planElement: PlanElement, material: any, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array): void

Inherited from PlannerKernelAccess.addMesh

Defined in packages/planner-core/src/services/planner-kernel-access.ts:359

Parameters:

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

Returns: void


# addPlanMesh

addPlanMesh(plan: Plan, material: any, vertices: Int32Array, indices: Int32Array, uvCoords: Float32Array, normals: Float32Array, type: KernelEnum): void

Inherited from PlannerKernelAccess.addPlanMesh

Defined in packages/planner-core/src/services/planner-kernel-access.ts:373

Parameters:

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

Returns: void


# addPlanObjectFromItem

addPlanObjectFromItem(rapiElement: RapiItem | RapiConfiguration, position?: Position3, rotation?: number): KernelObject | Promise‹void›

Inherited from PlannerKernelAccess.addPlanObjectFromItem

Defined in packages/planner-core/src/services/planner-kernel-access.ts:383

Parameters:

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

Returns: KernelObject | Promise‹void›


# addPlannerListener

addPlannerListener(listener: PlannerKernelCallbackI): void

Inherited from PlannerKernelAccess.addPlannerListener

Defined in packages/planner-core/src/services/planner-kernel-access.ts:89

Parameters:

Name Type
listener PlannerKernelCallbackI

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[]


# beginConstruction

beginConstruction(): void

Inherited from PlannerKernelAccess.beginConstruction

Defined in packages/planner-core/src/services/planner-kernel-access.ts:355

Returns: void


# beginPlanConstruction

beginPlanConstruction(plan: Plan): void

Inherited from PlannerKernelAccess.beginPlanConstruction

Defined in packages/planner-core/src/services/planner-kernel-access.ts:368

Parameters:

Name Type
plan Plan

Returns: void


# catalogItemLoaded

catalogItemLoaded(catalogItem: RapiItem): void

Inherited from PlannerKernelAccess.catalogItemLoaded

Defined in packages/planner-core/src/services/planner-kernel-access.ts:125

Parameters:

Name Type
catalogItem RapiItem

Returns: void


# changeCommonComponentParameter

changeCommonComponentParameter(componentIds: number[], parameterKey: string, type: string, value: string, resolve: function, reject: function): void

Inherited from ConfiguratorKernelAccess.changeCommonComponentParameter

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

Inherited from ConfiguratorKernelAccess.changeComponentParameter

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

Inherited from ConfiguratorKernelAccess.changePlanObjectParameter

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

Inherited from ConfiguratorKernelAccess.changeUseOfHDGeometry

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 PlannerKernelAccess.cleanUpCallbacks

Overrides CommonKernelAccess.cleanUpCallbacks

Defined in packages/planner-core/src/services/planner-kernel-access.ts:180

Returns: void


# componentConfigurationUpdated

componentConfigurationUpdated(componentId: number, geometryChanged: boolean): void

Inherited from ConfiguratorKernelAccess.componentConfigurationUpdated

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

Inherited from ConfiguratorKernelAccess.componentDefinitionLoaded

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

Inherited from ConfiguratorKernelAccess.componentDefinitionLoadingError

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

Inherited from ConfiguratorKernelAccess.componentParameters

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

Inherited from ConfiguratorKernelAccess.configurationLoaded

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

Inherited from ConfiguratorKernelAccess.configurationLoadingError

Defined in packages/common-core/src/configurator-kernel-access.ts:438

Parameters:

Name Type
_runtimeId number
errors? EmscriptenString[]

Returns: void


# coupleReferences

coupleReferences(jsObject: any, coreReference: KernelObject): void

Inherited from PlannerKernelAccess.coupleReferences

Defined in packages/planner-core/src/services/planner-kernel-access.ts:393

Parameters:

Name Type
jsObject any
coreReference KernelObject

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

Inherited from ConfiguratorKernelAccess.dockComponent

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


# endConstruction

endConstruction(): void

Inherited from PlannerKernelAccess.endConstruction

Defined in packages/planner-core/src/services/planner-kernel-access.ts:364

Returns: void


# endPlanConstruction

endPlanConstruction(plan: Plan): void

Inherited from PlannerKernelAccess.endPlanConstruction

Defined in packages/planner-core/src/services/planner-kernel-access.ts:378

Parameters:

Name Type
plan Plan

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

Inherited from ConfiguratorKernelAccess.getConfigurationHash

Defined in packages/common-core/src/configurator-kernel-access.ts:362

Parameters:

Name Type
context ConfiguratorContext

Returns: Promise‹ConfigurationHash


# getCurrentConfigurationHash

getCurrentConfigurationHash(planObjectId: number): ConfigurationHash

Inherited from ConfiguratorKernelAccess.getCurrentConfigurationHash

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[]›

Inherited from ConfiguratorKernelAccess.getGlobalParameters

Defined in packages/common-core/src/configurator-kernel-access.ts:342

Parameters:

Name Type
planObjectId number
rootComponentParametersAsGlobal boolean

Returns: Promise‹KernelParameter[]›


# getParameterGroups

getParameterGroups(): KernelParameterGroup[]

Inherited from ConfiguratorKernelAccess.getParameterGroups

Defined in packages/common-core/src/configurator-kernel-access.ts:718

Returns: KernelParameterGroup[]


# getPartList

getPartList(): Promise‹unknown›

Inherited from ConfiguratorKernelAccess.getPartList

Defined in packages/common-core/src/configurator-kernel-access.ts:355

Returns: Promise‹unknown›


# getRuntimeComponentId

getRuntimeComponentId(runtimeComponentId: number): string

Inherited from ConfiguratorKernelAccess.getRuntimeComponentId

Defined in packages/common-core/src/configurator-kernel-access.ts:714

Parameters:

Name Type
runtimeComponentId number

Returns: string


# getRuntimeComponentIdOfRootComponent

getRuntimeComponentIdOfRootComponent(planObjectId: number): number

Inherited from ConfiguratorKernelAccess.getRuntimeComponentIdOfRootComponent

Defined in packages/common-core/src/configurator-kernel-access.ts:706

Parameters:

Name Type
planObjectId number

Returns: number


# getSerializedConfiguration

getSerializedConfiguration(objectId: number): string

Inherited from ConfiguratorKernelAccess.getSerializedConfiguration

Defined in packages/common-core/src/configurator-kernel-access.ts:735

Parameters:

Name Type
objectId number

Returns: string


# handlerSwitchedPlans

handlerSwitchedPlans(fromPlan: Plan, toPlan: Plan): void

Inherited from PlannerKernelAccess.handlerSwitchedPlans

Defined in packages/planner-core/src/services/planner-kernel-access.ts:216

Parameters:

Name Type
fromPlan Plan
toPlan Plan

Returns: void


# init

init(kernelType: KERNEL_TYPE): void

Inherited from ConfiguratorKernelAccess.init

Defined in packages/common-core/src/configurator-kernel-access.ts:83

Parameters:

Name Type
kernelType KERNEL_TYPE

Returns: void


# insertItems

insertItems(itemList: Array‹RapiItem | RapiConfiguration›): Promise‹void›

Inherited from PlannerKernelAccess.insertItems

Defined in packages/planner-core/src/services/planner-kernel-access.ts:130

Parameters:

Name Type
itemList Array‹RapiItem | RapiConfiguration

Returns: Promise‹void›


# isReady

isReady(): void

Inherited from PlannerKernelAccess.isReady

Overrides ConfiguratorKernelAccess.isReady

Defined in packages/planner-core/src/services/planner-kernel-access.ts:97

Returns: void


# listOfVariants

listOfVariants(_componentId: RapiId, _list: VariantsList): void

Inherited from ConfiguratorKernelAccess.listOfVariants

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

Inherited from ConfiguratorKernelAccess.listOfVariantsError

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

Inherited from ConfiguratorKernelAccess.loadComponentIntoKernel

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

Inherited from ConfiguratorKernelAccess.loadConfiguration

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

Inherited from ConfiguratorKernelAccess.multiSelectionChange

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

Inherited from ConfiguratorKernelAccess.onLoadComponentError

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


# planBoundsChanged

planBoundsChanged(): void

Inherited from PlannerKernelAccess.planBoundsChanged

Defined in packages/planner-core/src/services/planner-kernel-access.ts:224

Returns: void


# planCleared

planCleared(): void

Inherited from PlannerKernelAccess.planCleared

Defined in packages/planner-core/src/services/planner-kernel-access.ts:228

Returns: void


# planCompletelyLoaded

planCompletelyLoaded(plan: Plan): void

Inherited from PlannerKernelAccess.planCompletelyLoaded

Defined in packages/planner-core/src/services/planner-kernel-access.ts:232

Parameters:

Name Type
plan Plan

Returns: void


# planElement3dMeshChanged

planElement3dMeshChanged(plan: Plan, element: PlanElement): void

Inherited from PlannerKernelAccess.planElement3dMeshChanged

Defined in packages/planner-core/src/services/planner-kernel-access.ts:237

Parameters:

Name Type
plan Plan
element PlanElement

Returns: void


# planElementAdded

planElementAdded(plan: Plan, element: PlanElement): void

Inherited from PlannerKernelAccess.planElementAdded

Defined in packages/planner-core/src/services/planner-kernel-access.ts:248

Parameters:

Name Type
plan Plan
element PlanElement

Returns: void


# planElementChanged

planElementChanged(plan: Plan, element: KernelObject): void

Inherited from PlannerKernelAccess.planElementChanged

Defined in packages/planner-core/src/services/planner-kernel-access.ts:303

Parameters:

Name Type
plan Plan
element KernelObject

Returns: void


# planElementRemoved

planElementRemoved(element: PlanElement): void

Inherited from PlannerKernelAccess.planElementRemoved

Defined in packages/planner-core/src/services/planner-kernel-access.ts:210

Parameters:

Name Type
element PlanElement

Returns: void


# planHistoryStateChanged

planHistoryStateChanged(): void

Inherited from PlannerKernelAccess.planHistoryStateChanged

Defined in packages/planner-core/src/services/planner-kernel-access.ts:312

Returns: void


# planObjectConfigurationCreated

planObjectConfigurationCreated(_plan: Plan, _element: PlanObject): void

Inherited from PlannerKernelAccess.planObjectConfigurationCreated

Defined in packages/planner-core/src/services/planner-kernel-access.ts:320

Parameters:

Name Type
_plan Plan
_element PlanObject

Returns: void


# planObjectConfigurationLoaded

planObjectConfigurationLoaded(plan: Plan, element: PlanElement, success: boolean): void

Inherited from PlannerKernelAccess.planObjectConfigurationLoaded

Defined in packages/planner-core/src/services/planner-kernel-access.ts:328

Parameters:

Name Type
plan Plan
element PlanElement
success boolean

Returns: void


# planObjectConfigurationUpdated

planObjectConfigurationUpdated(planObjectId: number, configuration: ConfigurationString, hash: string): Promise‹void›

Inherited from ConfiguratorKernelAccess.planObjectConfigurationUpdated

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

Inherited from ConfiguratorKernelAccess.planObjectCreated

Defined in packages/common-core/src/configurator-kernel-access.ts:474

Parameters:

Name Type
conversationId number
planObjectId number

Returns: void


# planObjectDeleted

planObjectDeleted(): void

Inherited from PlannerKernelAccess.planObjectDeleted

Overrides ConfiguratorKernelAccess.planObjectDeleted

Defined in packages/planner-core/src/services/planner-kernel-access.ts:171

Returns: void


# planObjectUpdated

planObjectUpdated(planObjectId: number): void

Inherited from ConfiguratorKernelAccess.planObjectUpdated

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

Inherited from ConfiguratorKernelAccess.previewDockingsWithDrag

Defined in packages/common-core/src/configurator-kernel-access.ts:254

Parameters:

Name Type
componentId number
planObjectId number

Returns: void


# registerCallbacks

registerCallbacks(): void

Inherited from PlannerKernelAccess.registerCallbacks

Defined in packages/planner-core/src/services/planner-kernel-access.ts:187

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


# removePlannerListener

removePlannerListener(listener: PlannerKernelCallbackI): void

Inherited from PlannerKernelAccess.removePlannerListener

Defined in packages/planner-core/src/services/planner-kernel-access.ts:93

Parameters:

Name Type
listener PlannerKernelCallbackI

Returns: void


# requestCatalogItem

requestCatalogItem(_catalogItemId: string): void

Inherited from PlannerKernelAccess.requestCatalogItem

Defined in packages/planner-core/src/services/planner-kernel-access.ts:339

Parameters:

Name Type
_catalogItemId string

Returns: void


# requestComponentDimensions

requestComponentDimensions(): void

Inherited from ConfiguratorKernelAccess.requestComponentDimensions

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

Inherited from ConfiguratorKernelAccess.requestDeleteComponents

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›

Inherited from ConfiguratorKernelAccess.requestExternalMesh

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?: MapArticleNumber, RapiPrice›): Promise‹void›

Inherited from ConfiguratorKernelAccess.requestPartListAndUpdatePricesOfParts

Overrides CommonKernelAccess.requestPartListAndUpdatePricesOfParts

Defined in packages/common-core/src/configurator-kernel-access.ts:328

Parameters:

Name Type
hash? ConfigurationHash
_prices? MapArticleNumber, 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

Inherited from ConfiguratorKernelAccess.requestPlanObjectConstruction

Defined in packages/common-core/src/configurator-kernel-access.ts:366

Parameters:

Name Type
objectId number

Returns: void


# requestPlanObjectDimensions

requestPlanObjectDimensions(): void

Inherited from PlannerKernelAccess.requestPlanObjectDimensions

Overrides ConfiguratorKernelAccess.requestPlanObjectDimensions

Defined in packages/planner-core/src/services/planner-kernel-access.ts:176

Returns: void


# requestSync

requestSync(conversationId: number, planObjectId: number): void

Inherited from ConfiguratorKernelAccess.requestSync

Defined in packages/common-core/src/configurator-kernel-access.ts:337

Parameters:

Name Type
conversationId number
planObjectId number

Returns: void


# resume

resume(): void

Inherited from ConfiguratorKernelAccess.resume

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

Inherited from ConfiguratorKernelAccess.selectedComponent

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

Inherited from ConfiguratorKernelAccess.selectionChange

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

Inherited from ConfiguratorKernelAccess.setActiveGroupInView

Defined in packages/common-core/src/configurator-kernel-access.ts:462

Parameters:

Name Type
group string

Returns: void


# startedDrawing

startedDrawing(): void

Inherited from PlannerKernelAccess.startedDrawing

Defined in packages/planner-core/src/services/planner-kernel-access.ts:343

Returns: void


# stoppedDrawing

stoppedDrawing(): void

Inherited from PlannerKernelAccess.stoppedDrawing

Defined in packages/planner-core/src/services/planner-kernel-access.ts:347

Returns: void


# uiRequestConfiguration

uiRequestConfiguration(objectId: number): void

Inherited from ConfiguratorKernelAccess.uiRequestConfiguration

Defined in packages/common-core/src/configurator-kernel-access.ts:115

Parameters:

Name Type
objectId number

Returns: void


# updateMesh2d

updateMesh2d(): void

Inherited from PlannerKernelAccess.updateMesh2d

Defined in packages/planner-core/src/services/planner-kernel-access.ts:351

Returns: void


# updatePlanObjectDependencies

updatePlanObjectDependencies(planObjectId: number): void

Inherited from ConfiguratorKernelAccess.updatePlanObjectDependencies

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

Inherited from ConfiguratorKernelAccess.webGlPreviewDockings

Defined in packages/common-core/src/configurator-kernel-access.ts:238

Parameters:

Name Type
context ConfiguratorContext
dragIn boolean

Returns: void

# Object literals

# _kernelContainer

#_kernelContainer: object

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:7

# CatalogItem

CatalogItem: CatalogItem = class { }

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:14

# catalogItemLoaded

catalogItemLoaded(catalogItem: KernelCatalogItem): void

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:12

Parameters:

Name Type
catalogItem KernelCatalogItem

Returns: void

# registerConfiguratorCallback

registerConfiguratorCallback(): void

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:9

Returns: void

# registerPlannerCallback

registerPlannerCallback(): void

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:11

Returns: void

# unregisterConfiguratorCallback

unregisterConfiguratorCallback(): void

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:8

Returns: void

# unregisterPlannerCallback

unregisterPlannerCallback(): void

Defined in packages/planner-core/mock/planner-kernel-access-mock.ts:10

Returns: void