RoomlePlanner.Internal.default
planner-core/src/roomle-planner.internal.default
Hierarchy
↳
default
Implements
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new default(creator
, offset
, plannerCallback
, mode
)
Parameters
creator
string
offset
plannerCallback
mode
Overrides
Properties
_creator_
• _creator_: string
Inherited from
currentSelection
• currentSelection: SelectionPayload
= null
Accessors
configuratorContext
• get
configuratorContext(): default
Returns
hasSingleRoom
• get
hasSingleRoom(): boolean
Returns
boolean
Methods
_preparePerspectiveImage
â–¸ _preparePerspectiveImage(options?
, isolationMode?
): Promise
<Base64Image
>
Parameters
options
isolationMode?
boolean
Returns
Promise
<Base64Image
>
addComponentHandlers
â–¸ addComponentHandlers(component
): void
Parameters
component
Returns
void
Inherited from
addEventListener
â–¸ addEventListener(_listener
): void
Parameters
_listener
Returns
void
Inherited from
addMesh
â–¸ addMesh(_planElement
, _material
, _vertices
, _indices
, _uvCoords
, _normals
): void
Parameters
_planElement
_material
any
_vertices
Float32Array
_indices
Int32Array
_uvCoords
Float32Array
_normals
Float32Array
Returns
void
Implementation of
PlannerKernelCallbackI.addMesh
addPlanMesh
â–¸ addPlanMesh(_plan
, _material
, _vertices
, _indices
, _uvCoords
, _normals
, _type
): void
Parameters
_plan
_material
any
_vertices
Float32Array
_indices
Int32Array
_uvCoords
Float32Array
_normals
Float32Array
_type
Returns
void
Implementation of
PlannerKernelCallbackI.addPlanMesh
addPlanObjectToScene
â–¸ addPlanObjectToScene(planViewModel
): Promise
<void
>
Parameters
planViewModel
Returns
Promise
<void
>
Implementation of
PlannerKernelCallbackI.addPlanObjectToScene
addPreviewHandlers
â–¸ addPreviewHandlers(previewComponent
): void
Parameters
previewComponent
Returns
void
Inherited from
addPreviewLineHandlers
â–¸ addPreviewLineHandlers(previewLineComponent
): void
Parameters
previewLineComponent
Returns
void
Inherited from
default.addPreviewLineHandlers
animateElement
â–¸ animateElement(elementId
, parameterName
, value
, applyToChildren
, animate
): void
Parameters
elementId
number
parameterName
string
value
string
applyToChildren
boolean
animate
boolean
Returns
void
Inherited from
backToPlanner
â–¸ backToPlanner(): void
Returns
void
beginPlanConstruction
â–¸ beginPlanConstruction(_plan
): void
Parameters
_plan
Returns
void
Implementation of
PlannerKernelCallbackI.beginPlanConstruction
cameraBehaviourChanged
â–¸ cameraBehaviourChanged(): void
Returns
void
Overrides
default.cameraBehaviourChanged
cancelComponentSelection
â–¸ cancelComponentSelection(resetCamera?
, reason?
): void
Parameters
resetCamera?
boolean
reason?
Returns
void
Inherited from
default.cancelComponentSelection
cancelDockings
â–¸ cancelDockings(): void
Returns
void
Inherited from
cancelPlanElementSelection
â–¸ cancelPlanElementSelection(reason
): void
Parameters
reason
Returns
void
cancelPreviousDockings
â–¸ cancelPreviousDockings(): void
Returns
void
Inherited from
default.cancelPreviousDockings
changeEnvironmentMapIntensity
â–¸ changeEnvironmentMapIntensity(intensity
): void
Parameters
intensity
number
Returns
void
Inherited from
default.changeEnvironmentMapIntensity
changeExteriorWallsMaterial
â–¸ changeExteriorWallsMaterial(material
): void
Parameters
material
Returns
void
changeFloorMaterial
â–¸ changeFloorMaterial(material
): Promise
<void
>
Parameters
material
Returns
Promise
<void
>
Inherited from
changeFloorsMaterial
â–¸ changeFloorsMaterial(material
): void
Parameters
material
Returns
void
changeInteriorWallsMaterial
â–¸ changeInteriorWallsMaterial(material
): void
Parameters
material
Returns
void
changeOffset
â–¸ changeOffset(offset
): void
Parameters
offset
Returns
void
Inherited from
cleanUp
â–¸ cleanUp(): void
Returns
void
Inherited from
clearScene
â–¸ clearScene(): void
Returns
void
Overrides
componentDeleted
â–¸ componentDeleted(component
): void
Parameters
component
Returns
void
Inherited from
componentUpdated
â–¸ componentUpdated(component
, _kernelComponent
): void
Parameters
component
_kernelComponent
Returns
void
Inherited from
configurationLoaded
â–¸ configurationLoaded(component
, isFreeFlying
): void
Parameters
component
isFreeFlying
boolean
Returns
void
Inherited from
debugScene
â–¸ debugScene(): Scene
Returns
Scene
Inherited from
debugSceneGraph
â–¸ debugSceneGraph(id?
): void
Parameters
id?
number
Returns
void
Inherited from
deletePlanElementByIds
â–¸ deletePlanElementByIds(runtimeIds
): Promise
<void
>
Parameters
runtimeIds
number
[]
Returns
Promise
<void
>
deletePlanElementSelection
â–¸ deletePlanElementSelection(): Promise
<void
>
Returns
Promise
<void
>
destroy
â–¸ destroy(): void
Returns
void
Overrides
disableAdvancedDocking
â–¸ disableAdvancedDocking(): void
Returns
void
disableConfiguratorEvents
â–¸ disableConfiguratorEvents(): void
Returns
void
Inherited from
default.disableConfiguratorEvents
disableEvents
â–¸ disableEvents(): void
Returns
void
Overrides
disableMeasurementLineDrawing
â–¸ disableMeasurementLineDrawing(): void
Returns
void
disablePlannerEvents
â–¸ disablePlannerEvents(): void
Returns
void
disableRotation
â–¸ disableRotation(): void
Returns
void
disableShowChildrenOfPlanObject
â–¸ disableShowChildrenOfPlanObject(planElementViewModel
): void
Parameters
planElementViewModel
Returns
void
disableSnapping
â–¸ disableSnapping(): void
Returns
void
disableWallDrawing
â–¸ disableWallDrawing(): void
Returns
void
display
â–¸ display(component
): void
Parameters
component
Returns
void
Inherited from
dragIn
â–¸ dragIn(dragEvent
): void
Parameters
dragEvent
DragEvent
Returns
void
enableAdvancedDocking
â–¸ enableAdvancedDocking(): void
Returns
void
enableConfiguratorEvents
â–¸ enableConfiguratorEvents(): void
Returns
void
Inherited from
default.enableConfiguratorEvents
enableDragIn
â–¸ enableDragIn(dragEvent
): void
Parameters
dragEvent
DragEvent
Returns
void
Inherited from
enableEvents
â–¸ enableEvents(): void
Returns
void
Overrides
enableHD
â–¸ enableHD(source?
): void
Parameters
source?
Returns
void
Inherited from
enableMeasurementLineDrawing
â–¸ enableMeasurementLineDrawing(): void
Returns
void
enablePlannerEvents
â–¸ enablePlannerEvents(): void
Returns
void
enableRotation
â–¸ enableRotation(): void
Returns
void
enableShowChildrenOfPlanObject
â–¸ enableShowChildrenOfPlanObject(planElementViewModel
): void
Parameters
planElementViewModel
Returns
void
enableSnapping
â–¸ enableSnapping(): void
Returns
void
enableWallDrawing
â–¸ enableWallDrawing(): void
Returns
void
endPlanConstruction
â–¸ endPlanConstruction(_plan
): void
Parameters
_plan
Returns
void
Implementation of
PlannerKernelCallbackI.endPlanConstruction
escapeDrawing
â–¸ escapeDrawing(cancelDrawing
): void
Parameters
cancelDrawing
boolean
Returns
void
exportCanvasScreenshot
â–¸ exportCanvasScreenshot(quality?
): Promise
<string
>
Parameters
quality
number
1
Returns
Promise
<string
>
Inherited from
default.exportCanvasScreenshot
exportGLB
â–¸ exportGLB(_exportObjects?
, _id?
): void
Parameters
_exportObjects?
Object3D
<Object3DEventMap
>[]
_id?
string
Returns
void
exportImageFromCamera
â–¸ exportImageFromCamera(filename
, shouldWaitForAssets?
): Promise
<void
>
Parameters
filename
string
undefined
shouldWaitForAssets
boolean
false
Returns
Promise
<void
>
Inherited from
getBounds
â–¸ getBounds(): Box3
Returns
Box3
Overrides
getCameraOffset
â–¸ getCameraOffset(): CanvasOffset
Returns
Inherited from
getCameraParameters3d
â–¸ getCameraParameters3d(): CameraParameter
Returns
getComponent
â–¸ getComponent(componentRuntimeId
): KernelComponent
Parameters
componentRuntimeId
number
Returns
Inherited from
getGeometryBounds
â–¸ getGeometryBounds(): Box3
Returns
Box3
Overrides
getObjectComponent
â–¸ getObjectComponent(id
): KernelPlanObjectComponent
Parameters
id
number
Returns
getOrthographicOffsetCamera
â–¸ getOrthographicOffsetCamera(): OrthographicOffsetCamera
Returns
Inherited from
default.getOrthographicOffsetCamera
getPlanObject
â–¸ getPlanObject(id
): KernelPlanObject
Parameters
id
number
Returns
getPlannerSceneEventHandler
â–¸ getPlannerSceneEventHandler(): default
Returns
getRootPlanObjectId
â–¸ getRootPlanObjectId(id
): number
This is needed to get the root plan object id in case a plan element is selected
which has been docked using advanced docking
Parameters
id
number
Returns
number
getScene
â–¸ getScene(): Scene
Returns
Scene
Inherited from
getScreenXY
â–¸ getScreenXY(position
): Vector3
Parameters
position
Vector3
Returns
Vector3
Inherited from
getSelectedRuntimeComponentIds
â–¸ getSelectedRuntimeComponentIds(): number
[]
Returns
number
[]
Inherited from
default.getSelectedRuntimeComponentIds
getWallAngleDegrees
â–¸ getWallAngleDegrees(wall
): number
Parameters
wall
Returns
number
handleEvent
â–¸ handleEvent(evt
): void
Parameters
evt
Event
Returns
void
Inherited from
handlerSwitchedPlans
â–¸ handlerSwitchedPlans(fromPlan
, toPlan
): void
Parameters
fromPlan
toPlan
Returns
void
Implementation of
PlannerKernelCallbackI.handlerSwitchedPlans
hideDimensions
â–¸ hideDimensions(): void
Returns
void
Inherited from
highlightExternalObject
â–¸ highlightExternalObject(planObjectComponent
): void
Parameters
planObjectComponent
Returns
void
highlightParts
â–¸ highlightParts(ids
): void
Parameters
ids
number
[]
Returns
void
Inherited from
highlightPlanElementById
â–¸ highlightPlanElementById(runtimeId
): void
Parameters
runtimeId
number
Returns
void
highlightPlanElementsById
â–¸ highlightPlanElementsById(runtimeIds
): void
Parameters
runtimeIds
number
[]
Returns
void
importGLB
â–¸ importGLB(url
): void
Parameters
url
string
Returns
void
loadDynamicLightSetting
â–¸ loadDynamicLightSetting(source
): Promise
<void
>
Parameters
source
Returns
Promise
<void
>
Inherited from
default.loadDynamicLightSetting
loadEnvMap
â–¸ loadEnvMap(url
): Promise
<void
>
Parameters
url
string
Returns
Promise
<void
>
Inherited from
loadSceneSettings
â–¸ loadSceneSettings(sceneSetting
): Promise
<void
>
Parameters
sceneSetting
Returns
Promise
<void
>
Inherited from
loadStaticPlanObjects
â–¸ loadStaticPlanObjects(): void
Returns
void
lockCamera
â–¸ lockCamera(): void
Returns
void
Inherited from
moveCamera
â–¸ moveCamera(cameraParameter
): Promise
<void
>
Parameters
cameraParameter
Returns
Promise
<void
>
Overrides
moveElementPosition
â–¸ moveElementPosition(selectedElement
, position
): void
Parameters
selectedElement
position
Returns
void
moveElementsPosition
â–¸ moveElementsPosition(selectedElements
, position
): void
Parameters
selectedElements
position
Returns
void
pause
â–¸ pause(): void
Returns
void
Inherited from
planBoundsChanged
â–¸ planBoundsChanged(): void
Returns
void
Implementation of
PlannerKernelCallbackI.planBoundsChanged
planCleared
â–¸ planCleared(): void
Returns
void
Implementation of
PlannerKernelCallbackI.planCleared
planCompletelyLoaded
â–¸ planCompletelyLoaded(_plan
): void
Parameters
_plan
Returns
void
Implementation of
PlannerKernelCallbackI.planCompletelyLoaded
planElementChanged
â–¸ planElementChanged(_plan
, planElementViewModel
): Promise
<void
>
Parameters
_plan
planElementViewModel
Returns
Promise
<void
>
Implementation of
PlannerKernelCallbackI.planElementChanged
planElementRemoved
â–¸ planElementRemoved(element
): void
Parameters
element
Returns
void
Implementation of
PlannerKernelCallbackI.planElementRemoved
planHistoryStateChanged
â–¸ planHistoryStateChanged(): void
Returns
void
Implementation of
PlannerKernelCallbackI.planHistoryStateChanged
planObjectConfigurationChanged
â–¸ planObjectConfigurationChanged(_plan
, _object
): void
Parameters
_plan
_object
Returns
void
Implementation of
PlannerKernelCallbackI.planObjectConfigurationChanged
planObjectConfigurationLoaded
â–¸ planObjectConfigurationLoaded(plan
, element
, success
): void
Parameters
plan
element
success
boolean
Returns
void
Implementation of
PlannerKernelCallbackI.planObjectConfigurationLoaded
planObjectConstructionDone
â–¸ planObjectConstructionDone(_planObject
): void
Parameters
_planObject
Returns
void
Inherited from
default.planObjectConstructionDone
planObjectUpdated
â–¸ planObjectUpdated(planObject
, geometryChanged
, pendingDocking
): void
Parameters
planObject
geometryChanged
boolean
pendingDocking
boolean
Returns
void
Inherited from
planXMLLoaded
â–¸ planXMLLoaded(plan
): void
Parameters
plan
Returns
void
preload
â–¸ preload(id
): void
Parameters
id
string
Returns
void
preparePartImage
â–¸ preparePartImage(partId
, options
): Promise
<any
>
Parameters
partId
number
options
Returns
Promise
<any
>
Inherited from
preparePerspectiveImage
â–¸ preparePerspectiveImage(options?
, isolationMode?
): Promise
<Base64Image
>
Parameters
options
isolationMode?
boolean
Returns
Promise
<Base64Image
>
Overrides
default.preparePerspectiveImage
preparePerspectiveImageOf
â–¸ preparePerspectiveImageOf(runtimeId
, options?
): Promise
<Base64Image
>
Parameters
runtimeId
number
options
Returns
Promise
<Base64Image
>
prepareTopImage
â–¸ prepareTopImage(options?
): Promise
<Base64Image
>
Parameters
options
Returns
Promise
<Base64Image
>
Overrides
previewConstructionDone
â–¸ previewConstructionDone(_component
, hasPreviews
): void
Parameters
_component
hasPreviews
boolean
Returns
void
Inherited from
default.previewConstructionDone
removeEventListener
â–¸ removeEventListener(_listener
): void
Parameters
_listener
Returns
void
Inherited from
removePlanObjectFromScene
â–¸ removePlanObjectFromScene(planViewModel
): void
Parameters
planViewModel
Returns
void
Implementation of
PlannerKernelCallbackI.removePlanObjectFromScene
renderImage
â–¸ renderImage(renderOptions
): Promise
<Base64Image
>
Parameters
renderOptions
Partial
<{ useCurrentPerspective
: boolean
= false }>
Returns
Promise
<Base64Image
>
Inherited from
requestCatalogItem
â–¸ requestCatalogItem(catalogItemId
): void
Parameters
catalogItemId
string
Returns
void
Implementation of
PlannerKernelCallbackI.requestCatalogItem
requestDeleteSelectedComponent
â–¸ requestDeleteSelectedComponent(): void
Returns
void
Inherited from
default.requestDeleteSelectedComponent
requestDockingsPreview
â–¸ requestDockingsPreview(userInitiated
, possibleChild?
, dragEvent?
, dragIn?
): void
Parameters
userInitiated
boolean
possibleChild?
dragEvent?
DragEvent
dragIn?
boolean
Returns
void
Inherited from
default.requestDockingsPreview
resetCameraPositionToStart
â–¸ resetCameraPositionToStart(): void
Returns
void
Overrides
default.resetCameraPositionToStart
resetConfiguratorContext
â–¸ resetConfiguratorContext(reason
): void
Parameters
reason
Returns
void
resetPreviews
â–¸ resetPreviews(): void
Returns
void
Inherited from
resume
â–¸ resume(): void
Returns
void
Inherited from
rotatePlanElementSelection
â–¸ rotatePlanElementSelection(rotateBy
): void
Parameters
rotateBy
number
Returns
void
saveConfigToIdb
â–¸ saveConfigToIdb(): void
Returns
void
Inherited from
sceneChanged
â–¸ sceneChanged(): void
Returns
void
Overrides
sceneCleared
â–¸ sceneCleared(shouldHardReset
): void
Parameters
shouldHardReset
boolean
Returns
void
Inherited from
selectComponent
â–¸ selectComponent(runtimeId
, triggerClickCallback?
): void
Parameters
runtimeId
number
undefined
triggerClickCallback
boolean
true
Returns
void
Inherited from
selectPlanObject
â–¸ selectPlanObject(runtimeId
): Promise
<void
>
Parameters
runtimeId
number
Returns
Promise
<void
>
setBackgroundColor
â–¸ setBackgroundColor(hex
): void
Parameters
hex
string
Returns
void
Inherited from
setBackgroundImage
â–¸ setBackgroundImage(url
): void
Parameters
url
string
Returns
void
Inherited from
setCameraOffset
â–¸ setCameraOffset(offset
): void
Parameters
offset
Returns
void
Inherited from
setCompletelyLoaded
â–¸ setCompletelyLoaded(completelyLoaded
): void
Parameters
completelyLoaded
boolean
Returns
void
setEnvironmentMap
â–¸ setEnvironmentMap(url?
, intensity?
, rotation?
, maxLightSources?
): void
Parameters
url?
string
intensity?
number
rotation?
number
maxLightSources?
number
Returns
void
Inherited from
setMeasurementLineLength
â–¸ setMeasurementLineLength(measurementId
, length
, wallDirection
): void
Parameters
measurementId
number
length
number
wallDirection
string
Returns
void
setMode
â–¸ setMode(mode
): void
Parameters
mode
Returns
void
setObjectToWallMeasurementLength
â–¸ setObjectToWallMeasurementLength(planElementId
, measurementId
, length
): void
Parameters
planElementId
number
measurementId
number
length
number
Returns
void
setSceneEvents
â–¸ setSceneEvents(sceneEvents
): void
Parameters
sceneEvents
Returns
void
setSelectionMode
â–¸ setSelectionMode(mode
): void
Parameters
mode
Returns
void
Inherited from
setWallMeasurementLength
â–¸ setWallMeasurementLength(measurementId
, length
, wallDirection
): void
Parameters
measurementId
number
length
number
wallDirection
Returns
void
showDimensions
â–¸ showDimensions(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
showGUI
â–¸ showGUI(): void
Returns
void
Inherited from
showStats
â–¸ showStats(): void
Returns
void
Inherited from
showsChildrenOfPlanObject
â–¸ showsChildrenOfPlanObject(planElementViewModel
): boolean
Parameters
planElementViewModel
Returns
boolean
startConfiguring
â–¸ startConfiguring(): void
Returns
void
startViewing
â–¸ startViewing(): void
Returns
void
startedDrawing
â–¸ startedDrawing(): void
called by kernel
Returns
void
Implementation of
PlannerKernelCallbackI.startedDrawing
stoppedDrawing
â–¸ stoppedDrawing(): void
called by kernel
Returns
void
Implementation of
PlannerKernelCallbackI.stoppedDrawing
switchTo2D
â–¸ switchTo2D(): void
Returns
void
switchTo3D
â–¸ switchTo3D(): void
Returns
void
switchToFirstPerson
â–¸ switchToFirstPerson(): void
Returns
void
toggleConfigureInRoom
â–¸ toggleConfigureInRoom(): void
Returns
void
unlockCamera
â–¸ unlockCamera(): void
Returns
void
Inherited from
updateCamera
â–¸ updateCamera(_changeCamera?
): void
Parameters
_changeCamera
boolean
true
Returns
void
Inherited from
updateCameraOnDrawWalls
â–¸ updateCameraOnDrawWalls(): void
Returns
void
updateScene
â–¸ updateScene(): void
Returns
void
Inherited from
waitForMaterialQueue
â–¸ waitForMaterialQueue(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
zoomIn
â–¸ zoomIn(value?
): void
Parameters
value?
number
Returns
void
Inherited from
zoomOut
â–¸ zoomOut(value?
): void
Parameters
value?
number
Returns
void
Inherited from
Last updated