Documentation

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

# Hierarchy

# Implements

# Table of contents

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new default(creator)

# Parameters

Name Type
creator string

# Properties

# _creator_

• _creator_: string

# Implementation of

Context.creator

# Accessors

# configurationExporter

• get configurationExporter(): ConfigurationExporter

# Returns

ConfigurationExporter

# kernelContainer

• get kernelContainer(): any

# Returns

any

# kernelInstance

• get kernelInstance(): ConfiguratorKernelClass

# Returns

ConfiguratorKernelClass

# Methods

# Editor3ChangedMesh

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

# Parameters

Name Type
runtimeComponentId number
meshId number
geometryName string
meshAttributes KernelMeshAttributes

# 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

# Editor3dBeginConstruction

▸ Editor3dBeginConstruction(id, isDeltaUpdate): void

# Parameters

Name Type
id number
isDeltaUpdate boolean

# Returns

void

# Editor3dComponentCreated

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

# Parameters

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

# Returns

void

# Editor3dComponentDocked

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

# Parameters

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

# Returns

void

# Editor3dEndConstruction

▸ Editor3dEndConstruction(id): void

# Parameters

Name Type
id number

# Returns

void

# Editor3dGeometryNotReady

▸ Editor3dGeometryNotReady(id): void

# Parameters

Name Type
id number

# Returns

void

# Editor3dGeometryReady

▸ Editor3dGeometryReady(id): void

# Parameters

Name Type
id number

# Returns

void

# Editor3dRemoveMesh

▸ Editor3dRemoveMesh(runtimeComponentId, meshId): void

# Parameters

Name Type
runtimeComponentId number
meshId number

# Returns

void

# addConfiguratorListener

▸ addConfiguratorListener(listener): void

# Parameters

Name Type
listener ConfiguratorKernelCallbackI

# Returns

void

# addUiDataAndPriceToPartList

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

# Parameters

Name Type
partList KernelPartList
hash string

# Returns

Promise<KernelPartList>

# addUiDataToPartList

▸ addUiDataToPartList(partList, hash): KernelPart[]

# Parameters

Name Type
partList KernelPart[]
hash string

# Returns

KernelPart[]

# calcPartsPriceSum

▸ calcPartsPriceSum(partList): Promise<KernelPartListPrice>

# Parameters

Name Type
partList KernelPartList

# Returns

Promise<KernelPartListPrice>

# cleanUpCallbacks

▸ cleanUpCallbacks(): void

# Returns

void

# componentDeleted

▸ componentDeleted(componentId): void

# Parameters

Name Type
componentId number

# Returns

void

# componentMetaUpdated

▸ componentMetaUpdated(componentId): void

# Parameters

Name Type
componentId number

# Returns

void

# destroy

▸ destroy(): void

# Returns

void

# Implementation of

LifeCycleCallbacks.destroy

# dockComponentWithPosition

▸ dockComponentWithPosition(parentId, parentDockId, childId, childDockId, position): void

# Parameters

Name Type
parentId number
parentDockId number
childId number
childDockId number
position KernelVector3

# Returns

void

# getConfigurationData

▸ getConfigurationData(planObjectId): Promise<RapiConfiguration>

# Parameters

Name Type
planObjectId number

# Returns

Promise<RapiConfiguration>

# loadComponent

▸ loadComponent(componentIds): void

# Parameters

Name Type
componentIds string[]

# Returns

void

# loadItemConfigurations

▸ loadItemConfigurations(itemIds): Promise<void>

# Parameters

Name Type
itemIds string[]

# Returns

Promise<void>

# pause

▸ pause(): void

# Returns

void

# Implementation of

LifeCycleCallbacks.pause

# removeConfiguratorListener

▸ removeConfiguratorListener(listener): void

# Parameters

Name Type
listener ConfiguratorKernelCallbackI

# Returns

void

# requestAssets

▸ requestAssets(requestedAssets): void

# Parameters

Name Type
requestedAssets AssetRequest[]

# Returns

void

# requestDeleteComponent

▸ requestDeleteComponent(componentId): void

# Parameters

Name Type
componentId number

# Returns

void

# requestExternalMesh

▸ requestExternalMesh(_requestedMeshes): void

# Parameters

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

# Returns

void

# requestMaterialProperties

▸ requestMaterialProperties(materialIds): Promise<void>

# Parameters

Name Type
materialIds string[]

# Returns

Promise<void>

# requestMaterialsInGroup

▸ requestMaterialsInGroup(groupIds): void

# Parameters

Name Type
groupIds string[]

# Returns

void

# requestPartListAndUpdatePricesOfParts

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

# Parameters

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

# Returns

Promise<void>

# requestPlanComponentConstruction

▸ requestPlanComponentConstruction(id, useDeltaUpdates?): void

# Parameters

Name Type Default value
id number undefined
useDeltaUpdates boolean USE_DELTA_COMPONENT_UPDATES

# Returns

void

# resume

▸ resume(): void

# Returns

void

# Implementation of

LifeCycleCallbacks.resume

# sceneCleared

▸ sceneCleared(): void

# Returns

void