TypingsKernel.ConfiguratorKernelClass
typings/kernel.ConfiguratorKernelClass
Table of contents
Methods
Methods
addPriceList
▸ addPriceList(newLocale
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
assetsLoaded
▸ assetsLoaded(assets
): void
Parameters
Name | Type |
---|---|
|
Returns
void
cancelDocking
▸ cancelDocking(componentId
, undoDrag
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
clearAll
▸ clearAll(): void
Returns
void
clearScene
▸ clearScene(): void
Returns
void
createNewSerializedConfiguration
▸ createNewSerializedConfiguration(configurationRuntimeId
): string
Parameters
Name | Type |
---|---|
|
|
Returns
string
deleteComponent
▸ deleteComponent(componentId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
deletePlanComponent
▸ deletePlanComponent(componentId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
deletePlanComponents
▸ deletePlanComponents(componentIds
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
dockComponent
▸ dockComponent(childId
, childDockId
, parentId
, parentDockId
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
|
|
Returns
void
dockComponentWithPosition
▸ dockComponentWithPosition(childId
, childDockId
, parentId
, parentDockId
, position
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
|
|
|
Returns
void
getChildrenOfPlanComponent
▸ getChildrenOfPlanComponent(componentId
, onlyPossible
, onlyVisible
): KernelPossibleChild
[]
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
getChildrenOfPlanObject
▸ getChildrenOfPlanObject(planObjectId
, onlyPossible
, onlyVisible
): KernelPossibleChild
[]
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
getCommonPlanComponentParameters
▸ getCommonPlanComponentParameters(componentIds
): Object
Parameters
Name | Type |
---|---|
|
|
Returns
Object
Name | Type |
---|---|
| |
| |
|
getComponent
▸ getComponent(componentId
): KernelComponent
Parameters
Name | Type |
---|---|
|
|
Returns
getComponentId
▸ getComponentId(componentId
): string
Parameters
Name | Type |
---|---|
|
|
Returns
string
getComponentParameters
▸ getComponentParameters(componentId
): KernelParameter
[]
Parameters
Name | Type |
---|---|
|
|
Returns
getExternalObjectDocking
▸ getExternalObjectDocking(childId
, childDockId
, parentId
, parentDockId
): KernelExternalObjectDocking
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
|
|
Returns
getFullPartList
▸ getFullPartList(): KernelPartList
Returns
getHashOfConfiguration
▸ getHashOfConfiguration(aPlanObjectOrComponentId
): string
Parameters
Name | Type |
---|---|
|
|
Returns
string
getHashOfSerializedConfiguration
▸ getHashOfSerializedConfiguration(serializedConfiguration
): string
Parameters
Name | Type |
---|---|
|
|
Returns
string
getPartList
▸ getPartList(getPartList
): KernelPartList
Parameters
Name | Type |
---|---|
|
|
Returns
getPlanComponentAnimations
▸ getPlanComponentAnimations(planComponentId
): KernelAnimation
[]
Parameters
Name | Type |
---|---|
|
|
Returns
getPlanComponentPossibleChildren
▸ getPlanComponentPossibleChildren(componentId
): KernelPossibleChild
[]
Parameters
Name | Type |
---|---|
|
|
Returns
getPlanObject
▸ getPlanObject(planObjectId
): PlanObject
Parameters
Name | Type |
---|---|
|
|
Returns
getPlanObjectAnimations
▸ getPlanObjectAnimations(planObjectId
): KernelAnimation
[]
Parameters
Name | Type |
---|---|
|
|
Returns
getPlanObjectChildren
▸ getPlanObjectChildren(planObjectId
, onlyPossible
, onlyVisible
): KernelPossibleChild
[]
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
getPlanObjectFromPlanComponent
▸ getPlanObjectFromPlanComponent(componentId
): PlanObject
Parameters
Name | Type |
---|---|
|
|
Returns
getPlanObjectParameters
▸ getPlanObjectParameters(planObjectId
): KernelParameter
[]
Parameters
Name | Type |
---|---|
|
|
Returns
getPlanObjectPossibleChildren
▸ getPlanObjectPossibleChildren(componentId
): KernelPossibleChild
[]
Parameters
Name | Type |
---|---|
|
|
Returns
getRootPlanComponentIdFromObjectId
▸ getRootPlanComponentIdFromObjectId(planObjectId
): number
Parameters
Name | Type |
---|---|
|
|
Returns
number
getSerializedConfiguration
▸ getSerializedConfiguration(planObjectOrComponentId
): string
Parameters
Name | Type |
---|---|
|
|
Returns
string
isExternalPlanObject
▸ isExternalPlanObject(objectOrPlanComponentId
): boolean
Parameters
Name | Type |
---|---|
|
|
Returns
boolean
loadComponentDefinition
▸ loadComponentDefinition(conversationId
, component
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
loadConfiguration
▸ loadConfiguration(kernelConversationId
, configurationObject
, position
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
Returns
void
loadExternalAttributeDefinition
▸ loadExternalAttributeDefinition(serializedDefinition
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
loadFreeFlyingConfiguration
▸ loadFreeFlyingConfiguration(conversationId
, configuration
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
loadPlainComponent
▸ loadPlainComponent(conversationId
, componentId
, configuration
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
requestDeltaPlanComponentConstruction
▸ requestDeltaPlanComponentConstruction(componentId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
requestPlanComponentConstruction
▸ requestPlanComponentConstruction(componentId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
requestPlanComponentConstructionRecursive
▸ requestPlanComponentConstructionRecursive(componentId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
requestPlanObjectConstruction
▸ requestPlanObjectConstruction(planObjectId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
requestPreviewGeometry
▸ requestPreviewGeometry(componentId
, planObjectId
, allowInsertInBetween
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
requestPreviewGeometryForExternalObject
▸ requestPreviewGeometryForExternalObject(componentId
, planObjectId
, allowInsertInBetween
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
resetPriceListIds
▸ resetPriceListIds(): void
Returns
void
setActiveGroupInView
▸ setActiveGroupInView(groupId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
setActiveGroupInViewForPlanObject
▸ setActiveGroupInViewForPlanObject(groupId
, runtimeId
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
setComponentParameter
▸ setComponentParameter(componentId
, parameterKey
, value
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
setDockInsertPreviewBoxParameters
▸ setDockInsertPreviewBoxParameters(thickness
, protruding
, intruding
, bevelSize
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
|
|
Returns
void
setEnvironmentVariable
▸ setEnvironmentVariable(key
, value
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
setExternalMeshInvalid
▸ setExternalMeshInvalid(meshId
, quality
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
setExternalObjectConstructionProperties
▸ setExternalObjectConstructionProperties(serializedProperties
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
setLevel
▸ setLevel(restrictionLevel
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
setPlanComponentParameters
▸ setPlanComponentParameters(componentIds
, parameterKey
, value
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
setPlanObjectParameter
▸ setPlanObjectParameter(planObjectId
, parameterKey
, value
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
setUpdateCallbacksOnlyIfGeometryIsReady
▸ setUpdateCallbacksOnlyIfGeometryIsReady(onlyUpdateIfReady
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
▸ setUpdateCallbacksOnlyIfGeometryIsReady(updateCallbacksOnlyIfGeometryIsReady
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
syncPlanObjectToView
▸ syncPlanObjectToView(conversationId
, planObjectId
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
useEnvironmentGeometry
▸ useEnvironmentGeometry(requestEnvironmentGeometry
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
useHDGeometry
▸ useHDGeometry(requestUseHDGeometry
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Last updated