RoomleConfigurator.Internal.default-12

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

Hierarchy

Table of contents

Constructors

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

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

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

eulerAngles

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

componentRotation

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

Returns

void

Inherited from

default.addConfiguratorListener


addDebugClient

â–¸ addDebugClient(debugClient): void

Parameters

Name
Type

debugClient

Returns

void


addLabelToKernelComponent

â–¸ addLabelToKernelComponent(kernelComponent): void

Parameters

Name
Type

kernelComponent

Returns

void

Inherited from

default.addLabelToKernelComponent


addUiDataAndPriceToPartList

â–¸ addUiDataAndPriceToPartList(partList, hash): Promise<KernelPartList>

Parameters

Name
Type

hash

string

Returns

Promise<KernelPartList>

Inherited from

default.addUiDataAndPriceToPartList


addUiDataToPartList

â–¸ addUiDataToPartList(partList, hash): KernelPart[]

Parameters

Name
Type

partList

hash

string

Returns

KernelPart[]

Inherited from

default.addUiDataToPartList


calcPartsPriceSum

â–¸ calcPartsPriceSum(partList): Promise<KernelPartListPrice>

Parameters

Name
Type

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

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


configureExternalObjectApi

â–¸ configureExternalObjectApi(_externalObjectSetting?): void

Parameters

Name
Type

_externalObjectSetting?

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

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


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

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

Returns

void

Overrides

CommonKernelAccess.init


isExternalObjectOrComponent

â–¸ isExternalObjectOrComponent(planObjectOrComponentId): boolean

Parameters

Name
Type

planObjectOrComponentId

number

Returns

boolean


isReady

â–¸ isReady(): void

Returns

void

Overrides

CommonKernelAccess.isReady


listOfVariants

â–¸ listOfVariants(_componentId, _list): void

Parameters

Name
Type

_componentId

string

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

Returns

void

Inherited from

default.removeConfiguratorListener


requestAssets

â–¸ requestAssets(requestedAssets): void

Parameters

Name
Type

requestedAssets

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

Returns

void


updatePlanObjectDependencies

â–¸ updatePlanObjectDependencies(planObjectId): void

Parameters

Name
Type

planObjectId

number

Returns

void


webGlPreviewDockings

â–¸ webGlPreviewDockings(context, dragIn): void

Parameters

Name
Type

context

dragIn

boolean

Returns

void


webGlPreviewDockingsForExternalObjects

â–¸ webGlPreviewDockingsForExternalObjects(context, _dragIn): void

Parameters

Name
Type

context

_dragIn

boolean

Returns

void


webGlPreviewDockingsForKernelObjects

â–¸ webGlPreviewDockingsForKernelObjects(context, dragIn): void

Parameters

Name
Type

context

dragIn

boolean

Returns

void

Last updated