ServicesConfiguratorUiCallback.default
Last updated
Last updated
.default
↳ default
• new default(creator)
creator
string
• _creator_: string
â–¸ (positions): void
gets called when the screen position of components/previews changes
Parameters
positions
Returns
void
• onKernelIsReady: () => void = null
â–¸ (): void
When kernel initialization is complete
Returns
void
â–¸ cameraStartsMoving(): void
void
target
prop
â–¸ mute(): void
void
â–¸ onAddonPlusHidden(): void
When all addon plus symbols are hidden in the user interface
void
â–¸ onAddonPlusHover(): void
When user hovers over an addon plus symbol
void
â–¸ onAddonPlusHoverOff(): void
When user hovers over an addon plus symbol
void
â–¸ 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
bounds
Object
bounds.depth
string
bounds.height
string
bounds.kernelBounds
bounds.width
string
void
â–¸ onCameraPositionChanges(): void
called when camera position starts to change or is changing at the moment
void
â–¸ onChangeTypeChangeTag(rapiId): void
rapiId
string
void
â–¸ 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
component
RoomleComponent instance of the clicked component
void
â–¸ onClickOutside(): void
When the user clicks on no UI element, can be used to deselect
void
â–¸ onComponentLoadError(error, id): void
When a requested component could not be loaded from RAPI
error
Error
id
string
void
â–¸ onConfigurationHasChildren(hasChildren): void
Updates when the current configuration changes
hasChildren
boolean
void
â–¸ onConfigurationLabelChange(catalogName, rapiItemLabel, rootComponentLabel): void
Gets called when a new item/configuration has been loaded
catalogName
string
rapiItemLabel
string
rootComponentLabel
string
void
â–¸ onConfigurationLoadError(): void
Gets called when configuration/configurable-item could not be loaded
void
â–¸ onConfigurationReady(partList, hash, rootComponentLabel): void
When configuration has been loaded completely, this can be useful to hide loading indicators
partList
hash
string
rootComponentLabel
string
void
â–¸ onConfigurationSaved(configurationHash): void
is called when the configuration is saved to our backend
configurationHash
string
void
â–¸ onConfiguratorKernelIsReady(kernelContainer, kernelInstance): void
is called when the configurator kernel is ready. It returns the container and the instance
kernelContainer
kernelInstance
void
â–¸ onContentProblem(data): void
When an asset could not be loaded (for example an image or texture). See paths or ids to identify the problem.
data
Object
data.ids
string[]
data.message
string
data.rapiPath
void
â–¸ 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
visible
boolean
void
â–¸ onDockingsPreviewRemoved(): void
When dockings/ghosts are no longer visible
void
â–¸ onElementDocked(component, id): void
Fires after an element has been docked
component
the child component that was docked to the parent component
id
number
the runtime id of the child component
void
â–¸ onError(error): void
When any generic error is thrown while requesting data
error
Error
void
â–¸ onErrorDueToOffline(error): void
When not connected to the internet
error
Error
void
â–¸ onGeometryNotReady(runtimeId): void
This function gets called when a geometry is not ready
runtimeId
number
void
â–¸ onGeometryReady(runtimeId): void
This function gets called when a geometry is ready
runtimeId
number
number
void
void
â–¸ onHistoryChange(undo, redo): void
gets called if history changes
undo
boolean
true if undo is possible
redo
boolean
true if redo is possible
void
â–¸ onLoadConfiguration(): void
When a new item or configuration is loading, this can be useful to display loading screens etc
void
â–¸ onMemoryCorruption(): void
When kernel failed to load a mesh
void
â–¸ onNoDockingsAvailable(): void
void
â–¸ onOpenAddOns(): void
When UI should show add ons
void
â–¸ onOpenFloorMaterials(): void
When UI should show floor material selection
void
â–¸ onOpenPartList(): void
When UI should show part list
void
â–¸ onOpenTag(tag): void
tag
void
â–¸ onPartListUpdate(partList, hash): void
When part list has been changed/updated, this event is triggered on start up and when a configuration changes
partList
hash
string
void
â–¸ onReadyForRender(): void
Deprecated
has been moved to global callbacks is called the scene is ready for rendering it as an image
void
â–¸ onRemoveTypeChangeTag(rapiId): void
rapiId
string
void
â–¸ onRequestExternalMesh(meshId, quality): void
This function gets called when an external mesh is requested
meshId
string
meshId
quality
number
number between 0 and 100
void
void
â–¸ onSelectionCancel(reason): void
When a component or item selection has been canceled
reason
void
â–¸ onSelectionChange(selectionMode, isRoot, hasChildren, components): void
When a/another (different) component has been selected
selectionMode
string
isRoot
boolean
hasChildren
boolean
components
void
â–¸ onSyncDone(): void
When a previously requested sync has been completed
void
â–¸ onSyncStarted(): void
When a sync has been started
void
â–¸ onUiIntersectionChange(intersections): void
intersections
void
â–¸ onUpdateParameters(parameters): void
When component parameters are changed/updated, this event is triggered on start up and when a configuration changes
parameters
void
â–¸ onUpdatePossibleChildren(tags, defaultChild): void
When children of a component change, this event is triggered on start up and when a configuration changes
tags
defaultChild
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
currencySymbol
string
price
number
void
â–¸ onUserInitiatedDockDone(childDbId, childDockId, parentDbId, parentDockId, position): void
When a dock component call has been completed
childDbId
string
the database id of the component which is docked
childDockId
number
the number of the dock position
parentDbId
string
the database id of the component to which is docked
parentDockId
number
the number of the dock position to which is docked
position
vector where the dock is done can be null
void
â–¸ onValueMapChanged(changes): void
changes
void
â–¸ onZoomChange(minZoom, maxZoom): void
When the zoom level has been changed by the user
minZoom
boolean
true when zoomed out as far as possible
maxZoom
boolean
true when zoomed in as much as possible
void
â–¸ 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
.
.
• onComponentPositionsUpdated: (positions: []) => void = null
[]
.
â–¸ get(target, prop): string | (target: , prop: keyof ) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void
keyof
string | (target: , prop: keyof ) => string | (target: UiCallback, prop: keyof UiCallback) => string | ... | (() => void) | (() => void) | (() => void) | (() => void) | () => void | () => void | () => void | () => void | () => void | () => void | () => void | () => void
.
.
When as been called and the sync has been started
|
Is triggered when has no available dockings
When UI should show the overlay based on the selected tag. Gets triggered when is set
.
When as been called
[]
When the configuration overlaps the UI (defined by )
[]
[]
[]
.
.