Documentation

configurator-core/src/roomle-configurator..ConfiguratorKernelCallbackI

# Hierarchy

CommonConfiguratorKernelCallbackI

↳ ConfiguratorKernelCallbackI

# Implemented by

default

# Table of contents

# Methods

# Editor3ChangedMesh

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

# Parameters

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

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3ChangedMesh

# Editor3dAddDockPreview

▸ Editor3dAddDockPreview(componentId, previewId): void

# Parameters

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

# 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

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3dAddMesh

# Editor3dBeginConstruction

▸ Editor3dBeginConstruction(componentId, isDeltaUpdate): void

# Parameters

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

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3dBeginConstruction

# Editor3dComponentCreated

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

# Parameters

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

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3dComponentCreated

# Editor3dComponentDocked

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

# Parameters

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

# Returns

void

# Overrides

CommonConfiguratorKernelCallbackI.Editor3dComponentDocked

# Editor3dEndConstruction

▸ Editor3dEndConstruction(id): void

# Parameters

Name	Type
`id`	`number`

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3dEndConstruction

# Editor3dGeometryNotReady

▸ Editor3dGeometryNotReady(id): void

# Parameters

Name	Type
`id`	`number`

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3dGeometryNotReady

# Editor3dGeometryReady

▸ Editor3dGeometryReady(id): void

# Parameters

Name	Type
`id`	`number`

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3dGeometryReady

# Editor3dPlanObjectConstructionDone

▸ Editor3dPlanObjectConstructionDone(planObjectId): void

# Parameters

Name	Type
`planObjectId`	`number`

# Returns

void

# Editor3dPreviewConstructionDone

▸ Editor3dPreviewConstructionDone(componentId, objectId): void

# Parameters

Name	Type
`componentId`	`number`
`objectId`	`number`

# Returns

void

# Editor3dRemoveMesh

▸ Editor3dRemoveMesh(runtimeComponentId, meshId): void

# Parameters

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

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.Editor3dRemoveMesh

# Editor3dSetPreviewLineAssociations

▸ Editor3dSetPreviewLineAssociations(dockLines, previewId): void

# Parameters

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

# Returns

void

# Editor3dSetPreviewPointAssociations

▸ Editor3dSetPreviewPointAssociations(dockPairs, previewId): void

# Parameters

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

# 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

# componentConfigurationUpdated

▸ componentConfigurationUpdated(runtimeComponentId, geometryChanged): void

# Parameters

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

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.componentConfigurationUpdated

# componentDeleted

▸ componentDeleted(componentId): void

# Parameters

Name	Type
`componentId`	`number`

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.componentDeleted

# componentMetaUpdated

▸ componentMetaUpdated(kernelComponent): void

# Parameters

Name	Type
`kernelComponent`	`KernelComponent`

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.componentMetaUpdated

# configurationLoaded

▸ configurationLoaded(conversationId, objectId, componentId, hash, errors): void

# Parameters

Name	Type
`conversationId`	`number`
`objectId`	`number`
`componentId`	`number`
`hash`	`string`
`errors`	`any`

# Returns

void

# finishParameterChange

▸ finishParameterChange(resolve, reject): void

# Parameters

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

# Returns

void

# planObjectConfigurationUpdated

▸ planObjectConfigurationUpdated(planObjectId, configuration, hash, pendingDocking): void

# Parameters

Name	Type
`planObjectId`	`number`
`configuration`	`string`
`hash`	`string`
`pendingDocking`	`boolean`

# Returns

void

# planObjectCreated

▸ planObjectCreated(conversationId, planObjectId): void

# Parameters

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

# Returns

void

# planObjectUpdated

▸ planObjectUpdated(planObject, pendingDocking): void

# Parameters

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

# Returns

void

# sceneCleared

▸ sceneCleared(): void

# Returns

void

# Inherited from

CommonConfiguratorKernelCallbackI.sceneCleared

# updateAnimationParameters

▸ updateAnimationParameters(elementId, parameters): void

# Parameters

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

# Returns

void