configurator-core/src/services/configurator-ui-callback.default
Table of contents
• new default(creator)
UiCallback.constructor
• _creator_: string
UiCallback.creator
onComponentPositionsUpdated
• onComponentPositionsUpdated: (positions: UIComponentInfo[]) => void = null
Type declaration
▸ (positions): void
gets called when the screen position of components/previews changes
Parameters
Returns
void
onKernelIsReady
• onKernelIsReady: () => void = null
Type declaration
▸ (): void
When kernel initialization is complete
Returns
void
cameraStartsMoving
▸ cameraStartsMoving(): void
void
UiCallback.cameraStartsMoving
▸ get(target, prop): string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void
string | (target: UiCallback, prop: keyof UiCallback) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void
UiCallback.get
▸ mute(): void
void
UiCallback.mute
onAddonPlusHidden
▸ onAddonPlusHidden(): void
When all addon plus symbols are hidden in the user interface
void
onAddonPlusHover
▸ onAddonPlusHover(): void
When user hovers over an addon plus symbol
void
onAddonPlusHoverOff
▸ onAddonPlusHoverOff(): void
When user hovers over an addon plus symbol
void
onAddonPlusShown
▸ onAddonPlusShown(): void
When all addon plus symbols are shown in the user interface
void
▸ onBoundsUpdate(bounds): void
When the bounds of the object are changed/updated, this event is triggered
on start up and when a configuration changes
void
onCameraPositionChanges
▸ onCameraPositionChanges(): void
called when camera position starts to change or is changing at the moment
void
onChangeTypeChangeTag
▸ onChangeTypeChangeTag(rapiId): void
When @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.changeTypeChangeTag as been called and the sync has been started
void
onClickComponent
▸ onClickComponent(component): void
This function gets called when a selectable component on a configurable element has been clicked on.
An equivalent function for component clicks is onClickElement in the roomle-planner-ui-callback.ts
RoomleComponent instance of the clicked component
void
▸ onClickOutside(): void
When the user clicks on no UI element, can be used to deselect
void
onComponentLoadError
▸ onComponentLoadError(error, id): void
When a requested component could not be loaded from RAPI
void
onConfigurationHasChildren
▸ onConfigurationHasChildren(hasChildren): void
Updates when the current configuration changes
void
onConfigurationLabelChange
▸ onConfigurationLabelChange(catalogName, rapiItemLabel, rootComponentLabel): void
Gets called when a new item/configuration has been loaded
void
onConfigurationLoadError
▸ onConfigurationLoadError(): void
Gets called when configuration/configurable-item could not be loaded
void
onConfigurationReady
▸ onConfigurationReady(partList, hash, rootComponentLabel): void
When configuration has been loaded completely, this can be useful to hide loading indicators
void
onConfigurationSaved
▸ onConfigurationSaved(configurationHash): void
is called when the configuration is saved to our backend
void
onConfiguratorKernelIsReady
▸ onConfiguratorKernelIsReady(kernelContainer, kernelInstance): void
is called when the configurator kernel is ready. It returns the container and the instance
void
onContentProblem
▸ onContentProblem(data): void
When an asset could not be loaded (for example an image or texture). See paths or ids to identify the problem.
void
onDimensionsVisibilityChange
▸ onDimensionsVisibilityChange(visible): void
When the visibility of the dimensions changes from visible to gone or vice versa.
Doesn't matter if triggered by the user or via SDK
void
onDockingsPreviewRemoved
▸ onDockingsPreviewRemoved(): void
When dockings/ghosts are no longer visible
void
onElementDocked
▸ onElementDocked(component, id): void
Fires after an element has been docked
the child component that was docked to the parent component
the runtime id of the child component
void
▸ onError(error): void
When any generic error is thrown while requesting data
void
onErrorDueToOffline
▸ onErrorDueToOffline(error): void
When not connected to the internet
void
onGeometryNotReady
▸ onGeometryNotReady(runtimeId): void
This function gets called when a geometry is not ready
void
onGeometryReady
▸ onGeometryReady(runtimeId): void
This function gets called when a geometry is ready
void
void
onHistoryChange
▸ onHistoryChange(undo, redo): void
gets called if history changes
void
onLoadConfiguration
▸ onLoadConfiguration(): void
When a new item or configuration is loading, this can be useful to display loading screens etc
void
onMemoryCorruption
▸ onMemoryCorruption(): void
When kernel failed to load a mesh
void
onNoDockingsAvailable
▸ onNoDockingsAvailable(): void
Is triggered when @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.previewDockings has no available dockings
void
▸ onOpenAddOns(): void
When UI should show add ons
void
onOpenFloorMaterials
▸ onOpenFloorMaterials(): void
When UI should show floor material selection
void
▸ onOpenPartList(): void
When UI should show part list
void
▸ onOpenTag(tag): void
When UI should show the overlay based on the selected tag. Gets triggered when @roomle/web-sdk/configurator-core/src/utils/shims#CommonInitData.startTag is set
void
onPartListUpdate
▸ onPartListUpdate(partList, hash): void
When part list has been changed/updated, this event is triggered
on start up and when a configuration changes
void
onReadyForRender
▸ onReadyForRender(): void
Deprecated
has been moved to global callbacks
is called the scene is ready for rendering it as an image
void
UiCallback.onReadyForRender
onRemoveTypeChangeTag
▸ onRemoveTypeChangeTag(rapiId): void
When @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.removeTypeChangeTag as been called
void
onRequestExternalMesh
▸ onRequestExternalMesh(meshId, quality): void
This function gets called when an external mesh is requested
void
void
onSelectionCancel
▸ onSelectionCancel(reason): void
When a component or item selection has been canceled
void
onSelectionChange
▸ onSelectionChange(selectionMode, isRoot, hasChildren, components): void
When a/another (different) component has been selected
void
▸ onSyncDone(): void
When a previously requested sync has been completed
void
▸ onSyncStarted(): void
When a sync has been started
void
onUiIntersectionChange
▸ onUiIntersectionChange(intersections): void
When the configuration overlaps the UI (defined by @roomle/web-sdk/configurator-core/src/configurator-interfaces#CanvasOffset)
void
onUpdateParameters
▸ onUpdateParameters(parameters): void
When component parameters are changed/updated, this event is triggered
on start up and when a configuration changes
void
onUpdatePossibleChildren
▸ onUpdatePossibleChildren(tags, defaultChild): void
When children of a component change, this event is triggered
on start up and when a configuration changes
void
▸ onUpdatePrice(currencySymbol, price): void
When the price of a configuration/item changes, this event is triggered
on start up and when a configuration changes
void
onUserInitiatedDockDone
▸ onUserInitiatedDockDone(childDbId, childDockId, parentDbId, parentDockId, position): void
When a dock component call has been completed
the database id of the component which is docked
the number of the dock position
the database id of the component to which is docked
the number of the dock position to which is docked
vector where the dock is done can be null
void
onValueMapChanged
▸ onValueMapChanged(changes): void
void
Implementation of
ConfiguratorDebugCallbacks.onValueMapChanged
▸ onZoomChange(minZoom, maxZoom): void
When the zoom level has been changed by the user
true when zoomed out as far as possible
true when zoomed in as much as possible
void
onZoomToComponent
▸ onZoomToComponent(): void
When the use clicks on a configurable element twice to zoom the camera onto said element.
Doesn't matter if triggered by the user or via SDK
void
▸ unmute(): void
void
UiCallback.unmute
