Documentation

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

# Hierarchy

default

↳ default

# Implements

# Table of contents

# Methods

# Constructors

# constructor

• new default(creator)

# Parameters

Name	Type
`creator`	`string`

# Properties

# _creator_

• _creator_: string

# Implementation of

Context.creator

# Accessors

# materialQueue

• get materialQueue(): PromiseQueue<void>

# Returns

PromiseQueue<void>

# Methods

# Editor3ChangedMesh

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

# Parameters

Name	Type
`runtimeComponentId`	`number`
`meshId`	`number`
`geometryName`	`string`
`meshAttributes`	`KernelMeshAttributes`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3ChangedMesh

# Editor3dAddDockPreview

▸ Editor3dAddDockPreview(componentId, previewId): void

# Parameters

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

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dAddDockPreview

# 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

# Implementation of

ConfiguratorKernelCallbackI.Editor3dAddMesh

# Editor3dBeginConstruction

▸ Editor3dBeginConstruction(componentId, isDeltaUpdate): void

# Parameters

Name	Type
`componentId`	`number`
`isDeltaUpdate`	`boolean`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dBeginConstruction

# Editor3dComponentCreated

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

# Parameters

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

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dComponentCreated

# Editor3dComponentDocked

▸ Editor3dComponentDocked(componentId, isRootComponent, parentId, componentPosition, componentRotation): void

# Parameters

Name	Type
`componentId`	`number`
`isRootComponent`	`boolean`
`parentId`	`number`
`componentPosition`	`KernelVector3`
`componentRotation`	`KernelVector3`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dComponentDocked

# Editor3dEndConstruction

▸ Editor3dEndConstruction(id): void

# Parameters

Name	Type
`id`	`number`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dEndConstruction

# Editor3dGeometryNotReady

▸ Editor3dGeometryNotReady(id): void

# Parameters

Name	Type
`id`	`number`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dGeometryNotReady

# Editor3dGeometryReady

▸ Editor3dGeometryReady(id): void

# Parameters

Name	Type
`id`	`number`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dGeometryReady

# Editor3dPlanObjectConstructionDone

▸ Editor3dPlanObjectConstructionDone(planObjectId): void

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dPlanObjectConstructionDone

# Editor3dPreviewConstructionDone

▸ Editor3dPreviewConstructionDone(componentId, _objectId): void

# Parameters

Name	Type
`componentId`	`number`
`_objectId`	`number`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dPreviewConstructionDone

# Editor3dRemoveMesh

▸ Editor3dRemoveMesh(runtimeComponentId, meshId): void

# Parameters

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

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dRemoveMesh

# Editor3dSetPreviewLineAssociations

▸ Editor3dSetPreviewLineAssociations(dockLines, previewId): void

# Parameters

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

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dSetPreviewLineAssociations

# Editor3dSetPreviewPointAssociations

▸ Editor3dSetPreviewPointAssociations(dockPairs, previewId): void

# Parameters

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

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.Editor3dSetPreviewPointAssociations

# _changeAnimationValue

▸ _changeAnimationValue(component, parameterKey, value, animate): void

# Parameters

Name	Type
`component`	`RoomleComponent`
`parameterKey`	`string`
`value`	`string`
`animate`	`boolean`

# 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

# Implementation of

ConfiguratorKernelCallbackI.changeAnimationValue

# clearRootComponent

▸ clearRootComponent(): void

# Returns

void

# componentConfigurationUpdated

▸ componentConfigurationUpdated(runtimeComponentId, geometryChanged): void

# Parameters

Name	Type
`runtimeComponentId`	`number`
`geometryChanged`	`boolean`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.componentConfigurationUpdated

# componentDeleted

▸ componentDeleted(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.componentDeleted

# componentMetaUpdated

▸ componentMetaUpdated(kernelComponent): void

# Parameters

Name	Type
`kernelComponent`	`KernelComponent`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.componentMetaUpdated

# configurationLoaded

▸ configurationLoaded(conversationId, objectId, componentId, _hash, _errors): void

# Parameters

Name	Type
`conversationId`	`number`
`objectId`	`number`
`componentId`	`number`
`_hash`	`string`
`_errors`	`any`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.configurationLoaded

# constructComponents

▸ constructComponents(planObjectId): void

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

void

# debugSceneGraph

▸ debugSceneGraph(id?): void

# Parameters

Name	Type
`id?`	`number`

# Returns

void

# dockComponentWithPosition

▸ dockComponentWithPosition(previewComponent, component?): void

# Parameters

Name	Type
`previewComponent`	`PreviewLineComponent`
`component?`	`RoomleComponent`

# Returns

void

# finishParameterChange

▸ finishParameterChange(resolve, _reject): void

# Parameters

Name	Type
`resolve`	() => `void`
`_reject`	() => `void`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.finishParameterChange

# getBoundingBox

▸ getBoundingBox(): Box3

# Returns

Box3

# getBoundingBoxOfGeometry

▸ getBoundingBoxOfGeometry(): Box3

# Returns

Box3

# getBoundingBoxWithPreviews

▸ getBoundingBoxWithPreviews(): Box3

# Returns

Box3

# getComponent

▸ getComponent(componentId): RoomleComponent

# Parameters

Name	Type
`componentId`	`number`

# Returns

RoomleComponent

# getComponents

▸ getComponents(): RoomleComponent[]

# Returns

RoomleComponent[]

# getComponentsForIds

▸ getComponentsForIds(ids): RoomleComponent[]

# Parameters

Name	Type
`ids`	`number`[]

# Returns

RoomleComponent[]

# getNumberOfPossibleChildrenForComponent

▸ getNumberOfPossibleChildrenForComponent(componentId): number

# Parameters

Name	Type
`componentId`	`number`

# Returns

number

# getPreviews

▸ getPreviews(): PreviewComponent[]

# Returns

PreviewComponent[]

# hasPreviewLines

▸ hasPreviewLines(): boolean

# Returns

boolean

# hasPreviews

▸ hasPreviews(): boolean

# Returns

boolean

# isPreview

▸ isPreview(obj): boolean

# Parameters

Name	Type
`obj`	`RoomleComponent`

# Returns

boolean

# isPreviewLine

▸ isPreviewLine(obj): boolean

# Parameters

Name	Type
`obj`	`RoomleComponent`

# Returns

boolean

# planObjectConfigurationUpdated

▸ planObjectConfigurationUpdated(planObjectId, _configuration, _hash, pendingDocking): void

# Parameters

Name	Type
`planObjectId`	`number`
`_configuration`	`string`
`_hash`	`string`
`pendingDocking`	`boolean`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.planObjectConfigurationUpdated

# planObjectCreated

▸ planObjectCreated(conversationId, planObjectId): void

# Parameters

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

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.planObjectCreated

# planObjectUpdated

▸ planObjectUpdated(planObject, pendingDocking): void

# Parameters

Name	Type
`planObject`	`PlanObject`
`pendingDocking`	`boolean`

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.planObjectUpdated

# removeDockingComponent

▸ removeDockingComponent(): void

# Returns

void

# removeGeometriesMergedListener

▸ removeGeometriesMergedListener(): void

# Returns

void

# removePreviews

▸ removePreviews(): void

# Returns

void

# requestSubPartConstruction

▸ requestSubPartConstruction(partId): Promise<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>

# Parameters

Name	Type
`partId`	`number`

# Returns

Promise<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>

# sceneCleared

▸ sceneCleared(): void

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.sceneCleared

# setGeometriesMergedListener

▸ setGeometriesMergedListener(fun): void

# Parameters

Name	Type
`fun`	() => `void`

# Returns

void

# setInvalidateRenderCallback

▸ setInvalidateRenderCallback(invalidateRenderCallback): void

# Parameters

Name	Type
`invalidateRenderCallback`	() => `void`

# Returns

void

# setListener

▸ setListener(listener): void

# Parameters

Name	Type
`listener`	`ConfiguratorViewModelCallbackI`

# Returns

void

# setMergeThreshold

▸ setMergeThreshold(threshold): void

# Parameters

Name	Type
`threshold`	`number`

# Returns

void

# setRequestRenderCallback

▸ setRequestRenderCallback(requestRenderCallback): void

# Parameters

Name	Type
`requestRenderCallback`	() => `void`

# Returns

void

# setRequestRenderSceneUpdateCallback

▸ setRequestRenderSceneUpdateCallback(requestRenderSceneUpdateCallback): void

# Parameters

Name	Type
`requestRenderSceneUpdateCallback`	() => `void`

# Returns

void

# tryToMergeComponents

▸ tryToMergeComponents(): void

# Returns

void

# updateAnimationParameters

▸ updateAnimationParameters(elementId, parameters): void

# Parameters

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

# Returns

void

# Implementation of

ConfiguratorKernelCallbackI.updateAnimationParameters