API ReferenceGlobalsConfiguratorKernelClass

# Interface: ConfiguratorKernelClass

# Hierarchy

  • ConfiguratorKernelClass

# Index

# Methods

# Methods

# addMeshCorto

addMeshCorto(meshId: string, quality: number, data: Uint8Array): void

Defined in packages/typings/kernel.ts:450

Parameters:

Name Type
meshId string
quality number
data Uint8Array

Returns: void


# addPriceList

addPriceList(newLocale: string): void

Defined in packages/typings/kernel.ts:386

Parameters:

Name Type
newLocale string

Returns: void


# clearAll

clearAll(): void

Defined in packages/typings/kernel.ts:370

Returns: void


# clearScene

clearScene(): void

Defined in packages/typings/kernel.ts:368

Returns: void


# deleteComponent

deleteComponent(componentId: number): void

Defined in packages/typings/kernel.ts:380

Parameters:

Name Type
componentId number

Returns: void


# deletePlanComponents

deletePlanComponents(componentIds: any): void

Defined in packages/typings/kernel.ts:382

Parameters:

Name Type
componentIds any

Returns: void


# dockComponent

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

Defined in packages/typings/kernel.ts:412

Parameters:

Name Type
parentId number
parentDockId number
childId number
childDockId number

Returns: void


# dockComponentWithPosition

dockComponentWithPosition(parentId: number, parentDockId: number, childId: number, childDockId: number, position: KernelVector3): void

Defined in packages/typings/kernel.ts:414

Parameters:

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

Returns: void


# getChildrenOfPlanComponent

getChildrenOfPlanComponent(componentId: number, onlyPossible: boolean, onlyVisible: boolean): KernelPossibleChild[]

Defined in packages/typings/kernel.ts:424

Parameters:

Name Type
componentId number
onlyPossible boolean
onlyVisible boolean

Returns: KernelPossibleChild[]


# getChildrenOfPlanObject

getChildrenOfPlanObject(planObjectId: number, onlyPossible: boolean, onlyVisible: boolean): KernelPossibleChild[]

Defined in packages/typings/kernel.ts:426

Parameters:

Name Type
planObjectId number
onlyPossible boolean
onlyVisible boolean

Returns: KernelPossibleChild[]


# getCommonPlanComponentParameters

getCommonPlanComponentParameters(componentIds: any): object

Defined in packages/typings/kernel.ts:444

Parameters:

Name Type
componentIds any

Returns: object


# getComponent

getComponent(componentId: number): KernelComponent

Defined in packages/typings/kernel.ts:416

Parameters:

Name Type
componentId number

Returns: KernelComponent


# getComponentId

getComponentId(componentId: number): RapiId

Defined in packages/typings/kernel.ts:418

Parameters:

Name Type
componentId number

Returns: RapiId


# getComponentParameters

getComponentParameters(componentId: number): KernelParameter[]

Defined in packages/typings/kernel.ts:400

Parameters:

Name Type
componentId number

Returns: KernelParameter[]


# getFullPartList

getFullPartList(): KernelPartList

Defined in packages/typings/kernel.ts:434

Returns: KernelPartList


# getHashOfConfiguration

getHashOfConfiguration(aPlanObjectOrComponentId: number): ConfigurationHash

Defined in packages/typings/kernel.ts:438

Parameters:

Name Type
aPlanObjectOrComponentId number

Returns: ConfigurationHash


# getHashOfSerializedConfiguration

getHashOfSerializedConfiguration(serializedConfiguration: string): ConfigurationHash

Defined in packages/typings/kernel.ts:440

Parameters:

Name Type
serializedConfiguration string

Returns: ConfigurationHash


# getPartList

getPartList(getPartList: number): KernelPartList

Defined in packages/typings/kernel.ts:442

Parameters:

Name Type
getPartList number

Returns: KernelPartList


# getPlanComponentPossibleChildren

getPlanComponentPossibleChildren(componentId: number): KernelPossibleChild[]

Defined in packages/typings/kernel.ts:422

Parameters:

Name Type
componentId number

Returns: KernelPossibleChild[]


# getPlanObject

getPlanObject(planObjectId: number): PlanObject

Defined in packages/typings/kernel.ts:420

Parameters:

Name Type
planObjectId number

Returns: PlanObject


# getPlanObjectChildren

getPlanObjectChildren(planObjectId: number, onlyPossible: boolean, onlyVisible: boolean): KernelPossibleChild[]

Defined in packages/typings/kernel.ts:430

Parameters:

Name Type
planObjectId number
onlyPossible boolean
onlyVisible boolean

Returns: KernelPossibleChild[]


# getPlanObjectParameters

getPlanObjectParameters(planObjectId: number): KernelParameter[]

Defined in packages/typings/kernel.ts:408

Parameters:

Name Type
planObjectId number

Returns: KernelParameter[]


# getPlanObjectPossibleChildren

getPlanObjectPossibleChildren(componentId: number): KernelPossibleChild[]

Defined in packages/typings/kernel.ts:428

Parameters:

Name Type
componentId number

Returns: KernelPossibleChild[]


# getRootPlanComponentIdFromObjectId

getRootPlanComponentIdFromObjectId(planObjectId: number): number

Defined in packages/typings/kernel.ts:432

Parameters:

Name Type
planObjectId number

Returns: number


# getSerializedConfiguration

getSerializedConfiguration(planObjectOrComponentId: number): ConfigurationString

Defined in packages/typings/kernel.ts:436

Parameters:

Name Type
planObjectOrComponentId number

Returns: ConfigurationString


# loadComponent

loadComponent(conversationId: number, configurationString: ConfigurationString, configuration: ConfigurationObject, parentId: number): void

Defined in packages/typings/kernel.ts:378

Parameters:

Name Type
conversationId number
configurationString ConfigurationString
configuration ConfigurationObject
parentId number

Returns: void


# loadComponentDefinition

loadComponentDefinition(conversationId: number, component: string): void

Defined in packages/typings/kernel.ts:446

Parameters:

Name Type
conversationId number
component string

Returns: void


# loadConfiguration

loadConfiguration(kernelConversationId: number, configurationObject: ConfigurationString, position: KernelVector3): void

Defined in packages/typings/kernel.ts:372

Parameters:

Name Type
kernelConversationId number
configurationObject ConfigurationString
position KernelVector3

Returns: void


# loadFreeFlyingConfiguration

loadFreeFlyingConfiguration(conversationId: number, configuration: ConfigurationString): void

Defined in packages/typings/kernel.ts:376

Parameters:

Name Type
conversationId number
configuration ConfigurationString

Returns: void


# loadPlainComponent

loadPlainComponent(conversationId: number, componentId: RapiId, configuration: ConfigurationString): void

Defined in packages/typings/kernel.ts:374

Parameters:

Name Type
conversationId number
componentId RapiId
configuration ConfigurationString

Returns: void


# loadedSubComponent

loadedSubComponent(parentId: number, partId: number, componentId: string, configuration: ConfigurationString): void

Defined in packages/typings/kernel.ts:388

Parameters:

Name Type
parentId number
partId number
componentId string
configuration ConfigurationString

Returns: void


# requestDeltaPlanComponentConstruction

requestDeltaPlanComponentConstruction(componentId: number): void

Defined in packages/typings/kernel.ts:394

Parameters:

Name Type
componentId number

Returns: void


# requestPlanComponentConstruction

requestPlanComponentConstruction(componentId: number): void

Defined in packages/typings/kernel.ts:392

Parameters:

Name Type
componentId number

Returns: void


# requestPlanComponentConstructionRecursive

requestPlanComponentConstructionRecursive(componentId: number): void

Defined in packages/typings/kernel.ts:396

Parameters:

Name Type
componentId number

Returns: void


# requestPlanObjectConstruction

requestPlanObjectConstruction(planObjectId: number): void

Defined in packages/typings/kernel.ts:390

Parameters:

Name Type
planObjectId number

Returns: void


# requestPreviewGeometry

requestPreviewGeometry(componentId: number, planObjectId: number): void

Defined in packages/typings/kernel.ts:398

Parameters:

Name Type
componentId number
planObjectId number

Returns: void


# resetPriceListIds

resetPriceListIds(): void

Defined in packages/typings/kernel.ts:384

Returns: void


# setActiveGroupInView

setActiveGroupInView(groupId: string): void

Defined in packages/typings/kernel.ts:454

Parameters:

Name Type
groupId string

Returns: void


# setComponentParameter

setComponentParameter(componentId: number, parameterKey: string, value: string): void

Defined in packages/typings/kernel.ts:402

Parameters:

Name Type
componentId number
parameterKey string
value string

Returns: void


# setEnvironmentVariable

setEnvironmentVariable(key: string, value: any): void

Defined in packages/typings/kernel.ts:406

Parameters:

Name Type
key string
value any

Returns: void


# setMaterialProperties

setMaterialProperties(propertiesOfMaterials: Array‹object›): void

Defined in packages/typings/kernel.ts:456

Parameters:

Name Type
propertiesOfMaterials Array‹object›

Returns: void


# setMaterialsInGroup

setMaterialsInGroup(materialGroups: Array‹object›): void

Defined in packages/typings/kernel.ts:452

Parameters:

Name Type
materialGroups Array‹object›

Returns: void


# setPlanComponentParameters

setPlanComponentParameters(componentIds: any, parameterKey: string, value: string): void

Defined in packages/typings/kernel.ts:404

Parameters:

Name Type
componentIds any
parameterKey string
value string

Returns: void


# setPlanObjectParameter

setPlanObjectParameter(planObjectId: number, parameterKey: string, value: string): void

Defined in packages/typings/kernel.ts:410

Parameters:

Name Type
planObjectId number
parameterKey string
value string

Returns: void


# syncPlanObjectToView

syncPlanObjectToView(conversationId: number, planObjectId: number): void

Defined in packages/typings/kernel.ts:448

Parameters:

Name Type
conversationId number
planObjectId number

Returns: void


# useEnvironmentGeometry

useEnvironmentGeometry(requestEnvironmentGeometry: boolean): void

Defined in packages/typings/kernel.ts:366

Parameters:

Name Type
requestEnvironmentGeometry boolean

Returns: void


# useHDGeometry

useHDGeometry(requestUseHDGeometry: boolean): void

Defined in packages/typings/kernel.ts:364

Parameters:

Name Type
requestUseHDGeometry boolean

Returns: void