Documentation

typings/kernel.ConfiguratorKernelClass

# Table of contents

# Methods

# Methods

# addPriceList

▸ addPriceList(newLocale): void

# Parameters

Name Type
newLocale string

# Returns

void

# assetsLoaded

▸ assetsLoaded(assets): void

# Parameters

Name Type
assets AssetResponse | AssetResponse[]

# Returns

void

# cancelDocking

▸ cancelDocking(componentId, undoDrag): void

# Parameters

Name Type
componentId number
undoDrag boolean

# Returns

void

# clearAll

▸ clearAll(): void

# Returns

void

# clearScene

▸ clearScene(): void

# Returns

void

# createNewSerializedConfiguration

▸ createNewSerializedConfiguration(configurationRuntimeId): string

# Parameters

Name Type
configurationRuntimeId number

# Returns

string

# deleteComponent

▸ deleteComponent(componentId): void

# Parameters

Name Type
componentId number

# Returns

void

# deletePlanComponent

▸ deletePlanComponent(componentId): void

# Parameters

Name Type
componentId any

# Returns

void

# deletePlanComponents

▸ deletePlanComponents(componentIds): void

# Parameters

Name Type
componentIds any

# Returns

void

# dockComponent

▸ dockComponent(childId, childDockId, parentId, parentDockId): void

# Parameters

Name Type
childId number
childDockId number
parentId number
parentDockId number

# Returns

void

# dockComponentWithPosition

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

# Parameters

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

# Returns

void

# getChildrenOfPlanComponent

▸ getChildrenOfPlanComponent(componentId, onlyPossible, onlyVisible): KernelPossibleChild[]

# Parameters

Name Type
componentId number
onlyPossible boolean
onlyVisible boolean

# Returns

KernelPossibleChild[]

# getChildrenOfPlanObject

▸ getChildrenOfPlanObject(planObjectId, onlyPossible, onlyVisible): KernelPossibleChild[]

# Parameters

Name Type
planObjectId number
onlyPossible boolean
onlyVisible boolean

# Returns

KernelPossibleChild[]

# getCommonPlanComponentParameters

▸ getCommonPlanComponentParameters(componentIds): Object

# Parameters

Name Type
componentIds any

# Returns

Object

Name Type
animations KernelAnimation[]
parameterGroups KernelParameterGroup[]
parameters KernelParameter[]

# getComponent

▸ getComponent(componentId): KernelComponent

# Parameters

Name Type
componentId number

# Returns

KernelComponent

# getComponentId

▸ getComponentId(componentId): string

# Parameters

Name Type
componentId number

# Returns

string

# getComponentParameters

▸ getComponentParameters(componentId): KernelParameter[]

# Parameters

Name Type
componentId number

# Returns

KernelParameter[]

# getExternalObjectDocking

▸ getExternalObjectDocking(childId, childDockId, parentId, parentDockId): KernelExternalObjectDocking

# Parameters

Name Type
childId number
childDockId number
parentId number
parentDockId number

# Returns

KernelExternalObjectDocking

# getFullPartList

▸ getFullPartList(): KernelPartList

# Returns

KernelPartList

# getHashOfConfiguration

▸ getHashOfConfiguration(aPlanObjectOrComponentId): string

# Parameters

Name Type
aPlanObjectOrComponentId number

# Returns

string

# getHashOfSerializedConfiguration

▸ getHashOfSerializedConfiguration(serializedConfiguration): string

# Parameters

Name Type
serializedConfiguration string

# Returns

string

# getPartList

▸ getPartList(getPartList): KernelPartList

# Parameters

Name Type
getPartList number

# Returns

KernelPartList

# getPlanComponentAnimations

▸ getPlanComponentAnimations(planComponentId): KernelAnimation[]

# Parameters

Name Type
planComponentId number

# Returns

KernelAnimation[]

# getPlanComponentPossibleChildren

▸ getPlanComponentPossibleChildren(componentId): KernelPossibleChild[]

# Parameters

Name Type
componentId number

# Returns

KernelPossibleChild[]

# getPlanObject

▸ getPlanObject(planObjectId): PlanObject

# Parameters

Name Type
planObjectId number

# Returns

PlanObject

# getPlanObjectAnimations

▸ getPlanObjectAnimations(planObjectId): KernelAnimation[]

# Parameters

Name Type
planObjectId number

# Returns

KernelAnimation[]

# getPlanObjectChildren

▸ getPlanObjectChildren(planObjectId, onlyPossible, onlyVisible): KernelPossibleChild[]

# Parameters

Name Type
planObjectId number
onlyPossible boolean
onlyVisible boolean

# Returns

KernelPossibleChild[]

# getPlanObjectFromPlanComponent

▸ getPlanObjectFromPlanComponent(componentId): PlanObject

# Parameters

Name Type
componentId number

# Returns

PlanObject

# getPlanObjectParameters

▸ getPlanObjectParameters(planObjectId): KernelParameter[]

# Parameters

Name Type
planObjectId number

# Returns

KernelParameter[]

# getPlanObjectPossibleChildren

▸ getPlanObjectPossibleChildren(componentId): KernelPossibleChild[]

# Parameters

Name Type
componentId number

# Returns

KernelPossibleChild[]

# getRootPlanComponentIdFromObjectId

▸ getRootPlanComponentIdFromObjectId(planObjectId): number

# Parameters

Name Type
planObjectId number

# Returns

number

# getSerializedConfiguration

▸ getSerializedConfiguration(planObjectOrComponentId): string

# Parameters

Name Type
planObjectOrComponentId number

# Returns

string

# isExternalPlanObject

▸ isExternalPlanObject(objectOrPlanComponentId): boolean

# Parameters

Name Type
objectOrPlanComponentId number

# Returns

boolean

# loadComponentDefinition

▸ loadComponentDefinition(conversationId, component): void

# Parameters

Name Type
conversationId number
component string

# Returns

void

# loadConfiguration

▸ loadConfiguration(kernelConversationId, configurationObject, position): void

# Parameters

Name Type
kernelConversationId number
configurationObject string
position KernelVector3

# Returns

void

# loadExternalAttributeDefinition

▸ loadExternalAttributeDefinition(serializedDefinition): void

# Parameters

Name Type
serializedDefinition string

# Returns

void

# loadFreeFlyingConfiguration

▸ loadFreeFlyingConfiguration(conversationId, configuration): void

# Parameters

Name Type
conversationId number
configuration string

# Returns

void

# loadPlainComponent

▸ loadPlainComponent(conversationId, componentId, configuration): void

# Parameters

Name Type
conversationId number
componentId string
configuration string

# Returns

void

# requestDeltaPlanComponentConstruction

▸ requestDeltaPlanComponentConstruction(componentId): void

# Parameters

Name Type
componentId number

# Returns

void

# requestPlanComponentConstruction

▸ requestPlanComponentConstruction(componentId): void

# Parameters

Name Type
componentId number

# Returns

void

# requestPlanComponentConstructionRecursive

▸ requestPlanComponentConstructionRecursive(componentId): void

# Parameters

Name Type
componentId number

# Returns

void

# requestPlanObjectConstruction

▸ requestPlanObjectConstruction(planObjectId): void

# Parameters

Name Type
planObjectId number

# Returns

void

# requestPreviewGeometry

▸ requestPreviewGeometry(componentId, planObjectId, allowInsertInBetween): void

# Parameters

Name Type
componentId number
planObjectId number
allowInsertInBetween boolean

# Returns

void

# requestPreviewGeometryForExternalObject

▸ requestPreviewGeometryForExternalObject(componentId, planObjectId, allowInsertInBetween): void

# Parameters

Name Type
componentId string
planObjectId number
allowInsertInBetween boolean

# Returns

void

# resetPriceListIds

▸ resetPriceListIds(): void

# Returns

void

# setActiveGroupInView

▸ setActiveGroupInView(groupId): void

# Parameters

Name Type
groupId string

# Returns

void

# setActiveGroupInViewForPlanObject

▸ setActiveGroupInViewForPlanObject(groupId, runtimeId): void

# Parameters

Name Type
groupId string
runtimeId number

# Returns

void

# setComponentParameter

▸ setComponentParameter(componentId, parameterKey, value): void

# Parameters

Name Type
componentId number
parameterKey string
value string

# Returns

void

# setEnvironmentVariable

▸ setEnvironmentVariable(key, value): void

# Parameters

Name Type
key string
value any

# Returns

void

# setExternalMeshInvalid

▸ setExternalMeshInvalid(meshId, quality): void

# Parameters

Name Type
meshId string
quality number

# Returns

void

# setExternalObjectConstructionProperties

▸ setExternalObjectConstructionProperties(serializedProperties): void

# Parameters

Name Type
serializedProperties string

# Returns

void

# setLevel

▸ setLevel(restrictionLevel): void

# Parameters

Name Type
restrictionLevel number

# Returns

void

# setPlanComponentParameters

▸ setPlanComponentParameters(componentIds, parameterKey, value): void

# Parameters

Name Type
componentIds any
parameterKey string
value string

# Returns

void

# setPlanObjectParameter

▸ setPlanObjectParameter(planObjectId, parameterKey, value): void

# Parameters

Name Type
planObjectId number
parameterKey string
value string

# Returns

void

# setUpdateCallbacksOnlyIfGeometryIsReady

▸ setUpdateCallbacksOnlyIfGeometryIsReady(onlyUpdateIfReady): void

# Parameters

Name Type
onlyUpdateIfReady boolean

# Returns

void

▸ setUpdateCallbacksOnlyIfGeometryIsReady(updateCallbacksOnlyIfGeometryIsReady): void

# Parameters

Name Type
updateCallbacksOnlyIfGeometryIsReady boolean

# Returns

void

# syncPlanObjectToView

▸ syncPlanObjectToView(conversationId, planObjectId): void

# Parameters

Name Type
conversationId number
planObjectId number

# Returns

void

# useEnvironmentGeometry

▸ useEnvironmentGeometry(requestEnvironmentGeometry): void

# Parameters

Name Type
requestEnvironmentGeometry boolean

# Returns

void

# useHDGeometry

▸ useHDGeometry(requestUseHDGeometry): void

# Parameters

Name Type
requestUseHDGeometry boolean

# Returns

void