Documentation

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

# Hierarchy

default

↳ default

↳↳ default

# Table of contents

# Constructors

constructor

# Properties

# Accessors

# Methods

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

# muteKernelCallbacks

• muteKernelCallbacks: boolean = false

# Accessors

# configurationExporter

• get configurationExporter(): ConfigurationExporter

# Returns

ConfigurationExporter

# Inherited from

CommonKernelAccess.configurationExporter

# kernelContainer

• get kernelContainer(): any

# Returns

any

# Inherited from

CommonKernelAccess.kernelContainer

# kernelInstance

• get kernelInstance(): ConfiguratorKernelClass

# Returns

ConfiguratorKernelClass

# Inherited from

CommonKernelAccess.kernelInstance

# 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

# Editor3dAddCubeUVMod

▸ Editor3dAddCubeUVMod(): void

# Returns

void

# Editor3dAddCylinder

▸ Editor3dAddCylinder(): void

# Returns

void

# Editor3dAddCylinderUVMod

▸ Editor3dAddCylinderUVMod(): void

# Returns

void

# Editor3dAddDockPreview

▸ Editor3dAddDockPreview(componentId, previewId): void

# Parameters

Name	Type
`componentId`	`number`
`previewId`	`number`

# Returns

void

# Editor3dAddFittingLine

▸ Editor3dAddFittingLine(): void

# Returns

void

# Editor3dAddFittingPoint

▸ Editor3dAddFittingPoint(): void

# Returns

void

# 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

# Editor3dAddMeshUVMod

▸ Editor3dAddMeshUVMod(): void

# Returns

void

# Editor3dAddPrism

▸ Editor3dAddPrism(): void

# Returns

void

# Editor3dAddPrismUVMod

▸ Editor3dAddPrismUVMod(): void

# Returns

void

# Editor3dAddRectangle

▸ Editor3dAddRectangle(): void

# Returns

void

# Editor3dAddRectangleUVMod

▸ Editor3dAddRectangleUVMod(): void

# Returns

void

# Editor3dAddSphere

▸ Editor3dAddSphere(): void

# Returns

void

# Editor3dAddSphereUVMod

▸ Editor3dAddSphereUVMod(): void

# Returns

void

# Editor3dBeginConstruction

▸ Editor3dBeginConstruction(id, isDeltaUpdate): void

# Parameters

Name	Type
`id`	`number`
`isDeltaUpdate`	`boolean`

# Returns

void

# Inherited from

default.Editor3dBeginConstruction

# Editor3dBeginGroup

▸ Editor3dBeginGroup(): void

# Returns

void

# Editor3dComponentCreated

▸ Editor3dComponentCreated(id, position, eulerAngles, isRootComponent, parentId): void

# Parameters

Name	Type
`id`	`number`
`position`	`KernelVector3`
`eulerAngles`	`KernelVector3`
`isRootComponent`	`boolean`
`parentId`	`number`

# Returns

void

# Overrides

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

# Editor3dEndConstruction

▸ Editor3dEndConstruction(id): void

# Parameters

Name	Type
`id`	`number`

# Returns

void

# Inherited from

default.Editor3dEndConstruction

# Editor3dEndGroup

▸ Editor3dEndGroup(): void

# Returns

void

# 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

# Editor3dPlanObjectConstructionDone

▸ Editor3dPlanObjectConstructionDone(planObjectId): void

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

void

# Editor3dPreviewConstructionDone

▸ Editor3dPreviewConstructionDone(componentId, objectId): void

# Parameters

Name	Type
`componentId`	`number`
`objectId`	`number`

# Returns

void

# Editor3dRemoveMesh

▸ Editor3dRemoveMesh(runtimeComponentId, meshId): void

# Parameters

Name	Type
`runtimeComponentId`	`number`
`meshId`	`number`

# Returns

void

# Inherited from

default.Editor3dRemoveMesh

# Editor3dRotateAround

▸ Editor3dRotateAround(): void

# Returns

void

# Editor3dRotateBy

▸ Editor3dRotateBy(): void

# Returns

void

# Editor3dSelectObject

▸ Editor3dSelectObject(): void

# Returns

void

# Editor3dSetMaterial

▸ Editor3dSetMaterial(): void

# Returns

void

# Editor3dSetPreviewLineAssociations

▸ Editor3dSetPreviewLineAssociations(dockLines, previewId): void

# Parameters

Name	Type
`dockLines`	`any`
`previewId`	`number`

# Returns

void

# Editor3dSetPreviewPointAssociations

▸ Editor3dSetPreviewPointAssociations(dockPairs, previewId): void

# Parameters

Name	Type
`dockPairs`	`any`
`previewId`	`number`

# Returns

void

# Editor3dTranslateBy

▸ Editor3dTranslateBy(): void

# Returns

void

# Editor3dUpdatePlanComponentPosition

▸ Editor3dUpdatePlanComponentPosition(): void

# Returns

void

# Editor3dUpdatePlanComponentRotation

▸ Editor3dUpdatePlanComponentRotation(): void

# Returns

void

# Editor3dUpdatePlanComponentTransform

▸ Editor3dUpdatePlanComponentTransform(): void

# Returns

void

# Editor3dUpdatePlanObjectPosition

▸ Editor3dUpdatePlanObjectPosition(): void

# Returns

void

# Editor3dUpdatePlanObjectRotation

▸ Editor3dUpdatePlanObjectRotation(): void

# Returns

void

# Editor3dUpdatePlanObjectTransform

▸ Editor3dUpdatePlanObjectTransform(): void

# Returns

void

# addConfiguratorListener

▸ addConfiguratorListener(listener): void

# Parameters

Name	Type
`listener`	`ConfiguratorKernelCallbackI`

# Returns

void

# Inherited from

default.addConfiguratorListener

# 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

# 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

# changeAnimationValue

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

# Parameters

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

# Returns

void

# 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

# 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

# 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

# changeUseOfHDGeometry

▸ changeUseOfHDGeometry(context, useHDGeometry): void

# Parameters

Name	Type
`context`	`default`
`useHDGeometry`	`boolean`

# Returns

void

# cleanUpCallbacks

▸ cleanUpCallbacks(): void

# Returns

void

# Inherited from

default.cleanUpCallbacks

# componentConfigurationUpdated

▸ componentConfigurationUpdated(componentId, geometryChanged): void

# Parameters

Name	Type
`componentId`	`number`
`geometryChanged`	`boolean`

# Returns

void

# componentDefinitionLoaded

▸ componentDefinitionLoaded(conversationId, componentId): void

# Parameters

Name	Type
`conversationId`	`number`
`componentId`	`number`

# Returns

void

# componentDefinitionLoadingError

▸ componentDefinitionLoadingError(conversationId, errorMessage): void

# Parameters

Name	Type
`conversationId`	`number`
`errorMessage`	`string`

# Returns

void

# 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

# 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

# configurationLoadingError

▸ configurationLoadingError(_runtimeId, errors?): void

# Parameters

Name	Type
`_runtimeId`	`number`
`errors?`	`any`[]

# Returns

void

# createNewSerializedConfiguration

▸ createNewSerializedConfiguration(configurationRuntimeId): string

# Parameters

Name	Type
`configurationRuntimeId`	`number`

# Returns

string

# 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

# 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

# getComponentParameters

▸ getComponentParameters(componentId): KernelParameter[]

# Parameters

Name	Type
`componentId`	`number`

# Returns

KernelParameter[]

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

# getCurrentConfigurationHash

▸ getCurrentConfigurationHash(planObjectId): string

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

string

# getGlobalParameters

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

# Parameters

Name	Type
`planObjectId`	`number`
`rootComponentParametersAsGlobal`	`boolean`

# Returns

Promise<KernelParameter[]>

# getParameterGroups

▸ getParameterGroups(): KernelParameterGroup[]

# Returns

KernelParameterGroup[]

# getPartList

▸ getPartList(): Promise<unknown>

# Returns

Promise<unknown>

# getPlanObjectParameters

▸ getPlanObjectParameters(objectId): KernelParameter[]

# Parameters

Name	Type
`objectId`	`number`

# Returns

KernelParameter[]

# getRuntimeComponentId

▸ getRuntimeComponentId(runtimeComponentId): string

# Parameters

Name	Type
`runtimeComponentId`	`number`

# Returns

string

# getRuntimeComponentIdOfRootComponent

▸ getRuntimeComponentIdOfRootComponent(planObjectId): number

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

number

# getSerializedConfiguration

▸ getSerializedConfiguration(objectId): string

# Parameters

Name	Type
`objectId`	`number`

# Returns

string

# init

▸ init(kernelType): void

# Parameters

Name	Type
`kernelType`	`KERNEL_TYPE`

# Returns

void

# Overrides

CommonKernelAccess.init

# isReady

▸ isReady(): void

# Returns

void

# Overrides

CommonKernelAccess.isReady

# listOfVariants

▸ listOfVariants(_componentId, _list): void

# Parameters

Name	Type
`_componentId`	`string`
`_list`	`VariantsList`

# Returns

void

# listOfVariantsError

▸ listOfVariantsError(dbId, error): void

# Parameters

Name	Type
`dbId`	`string`
`error`	`string`

# Returns

void

# 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

# loadConfiguration

▸ loadConfiguration(configuration): void

# Parameters

Name	Type
`configuration`	`string`

# Returns

void

# 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

# onLoadComponentError

▸ onLoadComponentError(error, id): void

# Parameters

Name	Type
`error`	`Error`
`id`	`string`

# Returns

void

# Overrides

CommonKernelAccess.onLoadComponentError

# pause

▸ pause(): void

# Returns

void

# Inherited from

default.pause

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

# planObjectCreated

▸ planObjectCreated(conversationId, planObjectId): void

# Parameters

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

# Returns

void

# planObjectDeleted

▸ planObjectDeleted(): void

# Returns

void

# planObjectUpdated

▸ planObjectUpdated(planObjectId, pendingDocking): void

# Parameters

Name	Type
`planObjectId`	`number`
`pendingDocking`	`boolean`

# Returns

void

# previewDockingsWithDrag

▸ previewDockingsWithDrag(componentId, planObjectId): void

# Parameters

Name	Type
`componentId`	`number`
`planObjectId`	`number`

# Returns

void

# removeConfiguratorListener

▸ removeConfiguratorListener(listener): void

# Parameters

Name	Type
`listener`	`ConfiguratorKernelCallbackI`

# Returns

void

# Inherited from

default.removeConfiguratorListener

# requestAssets

▸ requestAssets(requestedAssets): void

# Parameters

Name	Type
`requestedAssets`	`AssetRequest`[]

# Returns

void

# Inherited from

default.requestAssets

# requestComponentDimensions

▸ requestComponentDimensions(): void

# Returns

void

# requestDeleteComponent

▸ requestDeleteComponent(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# Inherited from

default.requestDeleteComponent

# requestDeleteComponents

▸ requestDeleteComponents(componentIds): void

# Parameters

Name	Type
`componentIds`	`number`[]

# Returns

void

# requestDeletePlanComponent

▸ requestDeletePlanComponent(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# requestExternalMesh

▸ requestExternalMesh(requestedMeshes): Promise<void>

# Parameters

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

# Returns

Promise<void>

# Overrides

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>

# Overrides

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

# requestPlanObjectDimensions

▸ requestPlanObjectDimensions(): void

# Returns

void

# requestSync

▸ requestSync(conversationId, planObjectId): void

# Parameters

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

# Returns

void

# resume

▸ resume(): void

# Returns

void

# Overrides

default.resume

# sceneCleared

▸ sceneCleared(): void

# Returns

void

# Inherited from

default.sceneCleared

# selectedComponent

▸ selectedComponent(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# selectionChange

▸ selectionChange(componentId, isRoot): void

# Parameters

Name	Type
`componentId`	`number`
`isRoot`	`boolean`

# Returns

void

# setActiveGroupInView

▸ setActiveGroupInView(group): void

# Parameters

Name	Type
`group`	`string`

# Returns

void

# setActiveGroupInViewForPlanObject

▸ setActiveGroupInViewForPlanObject(group, runtimeId?): void

# Parameters

Name	Type
`group`	`string`
`runtimeId?`	`number`

# Returns

void

# uiRequestConfiguration

▸ uiRequestConfiguration(objectId): void

# Parameters

Name	Type
`objectId`	`number`

# Returns

void

# updateAnimationParameters

▸ updateAnimationParameters(elementId, parameters): void

# Parameters

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

# Returns

void

# updatePlanObjectDependencies

▸ updatePlanObjectDependencies(planObjectId): void

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

void

# webGlPreviewDockings

▸ webGlPreviewDockings(context, dragIn): void

# Parameters

Name	Type
`context`	`default`
`dragIn`	`boolean`

# Returns

void