RoomlePlanner.Internal.default
planner-core/src/roomle-planner.internal.default
Hierarchy
↳
default
Implements
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new default(creator
, offset
, plannerCallback
, mode
)
Parameters
Name | Type |
---|---|
|
|
| |
| |
|
|
Overrides
Properties
_creator_
• _creator_: string
Inherited from
currentSelection
• currentSelection: SelectionPayload
= null
Methods
_preparePerspectiveImage
▸ _preparePerspectiveImage(options?
): Promise
<Base64Image
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<Base64Image
>
addComponentHandlers
▸ addComponentHandlers(component
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
addEventListener
▸ addEventListener(_listener
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
addMesh
▸ addMesh(_planElement
, _material
, _vertices
, _indices
, _uvCoords
, _normals
): void
Parameters
Name | Type |
---|---|
| |
|
|
|
|
|
|
|
|
|
|
Returns
void
Implementation of
PlannerKernelCallbackI.addMesh
addPlanMesh
▸ addPlanMesh(_plan
, _material
, _vertices
, _indices
, _uvCoords
, _normals
, _type
): void
Parameters
Name | Type |
---|---|
| |
|
|
|
|
|
|
|
|
|
|
|
Returns
void
Implementation of
PlannerKernelCallbackI.addPlanMesh
addPlanObjectToScene
▸ addPlanObjectToScene(planViewModel
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<void
>
Implementation of
PlannerKernelCallbackI.addPlanObjectToScene
addPreviewHandlers
▸ addPreviewHandlers(previewComponent
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
addPreviewLineHandlers
▸ addPreviewLineHandlers(previewLineComponent
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
default.addPreviewLineHandlers
backToPlanner
▸ backToPlanner(): void
Returns
void
beginPlanConstruction
▸ beginPlanConstruction(_plan
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Implementation of
PlannerKernelCallbackI.beginPlanConstruction
cameraBehaviourChanged
▸ cameraBehaviourChanged(): void
Returns
void
Overrides
default.cameraBehaviourChanged
cancelComponentSelection
▸ cancelComponentSelection(resetCamera?
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
default.cancelComponentSelection
cancelDockings
▸ cancelDockings(): void
Returns
void
Inherited from
cancelPlanElementSelection
▸ cancelPlanElementSelection(reason
): void
Parameters
Name | Type |
---|---|
|
Returns
void
cancelPreviousDockings
▸ cancelPreviousDockings(): void
Returns
void
Inherited from
default.cancelPreviousDockings
changeEnvironmentMapIntensity
▸ changeEnvironmentMapIntensity(intensity
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
default.changeEnvironmentMapIntensity
changeExteriorWallsMaterial
▸ changeExteriorWallsMaterial(material
): void
Parameters
Name | Type |
---|---|
|
Returns
void
changeFloorMaterial
▸ changeFloorMaterial(material
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<void
>
Inherited from
changeFloorsMaterial
▸ changeFloorsMaterial(material
): void
Parameters
Name | Type |
---|---|
|
Returns
void
changeInteriorWallsMaterial
▸ changeInteriorWallsMaterial(material
): void
Parameters
Name | Type |
---|---|
|
Returns
void
changeOffset
▸ changeOffset(offset
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
cleanUp
▸ cleanUp(): void
Returns
void
Inherited from
clearScene
▸ clearScene(): void
Returns
void
Overrides
componentDeleted
▸ componentDeleted(component
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
componentUpdated
▸ componentUpdated(component
, _kernelComponent
): void
Parameters
Name | Type |
---|---|
| |
|
Returns
void
Inherited from
configurationLoaded
▸ configurationLoaded(component
, isFreeFlying
): void
Parameters
Name | Type |
---|---|
| |
|
|
Returns
void
Inherited from
debugScene
▸ debugScene(): Scene
Returns
Scene
Inherited from
debugSceneGraph
▸ debugSceneGraph(id?
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
deletePlanElementByIds
▸ deletePlanElementByIds(runtimeIds
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
|
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
disableMeasurementLineDrawing
▸ disableMeasurementLineDrawing(): void
Returns
void
disablePlannerEvents
▸ disablePlannerEvents(): void
Returns
void
disableRotation
▸ disableRotation(): void
Returns
void
disableShowChildrenOfPlanObject
▸ disableShowChildrenOfPlanObject(planElementViewModel
): void
Parameters
Name | Type |
---|---|
|
Returns
void
disableSnapping
▸ disableSnapping(): void
Returns
void
disableWallDrawing
▸ disableWallDrawing(): void
Returns
void
display
▸ display(component
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
dragIn
▸ dragIn(dragEvent
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
enableAdvancedDocking
▸ enableAdvancedDocking(): void
Returns
void
enableConfiguratorEvents
▸ enableConfiguratorEvents(): void
Returns
void
Inherited from
default.enableConfiguratorEvents
enableDragIn
▸ enableDragIn(dragEvent
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
enableHD
▸ enableHD(source?
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
enableMeasurementLineDrawing
▸ enableMeasurementLineDrawing(): void
Returns
void
enablePlannerEvents
▸ enablePlannerEvents(): void
Returns
void
enableRotation
▸ enableRotation(): void
Returns
void
enableShowChildrenOfPlanObject
▸ enableShowChildrenOfPlanObject(planElementViewModel
): void
Parameters
Name | Type |
---|---|
|
Returns
void
enableSnapping
▸ enableSnapping(): void
Returns
void
enableWallDrawing
▸ enableWallDrawing(): void
Returns
void
endPlanConstruction
▸ endPlanConstruction(_plan
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Implementation of
PlannerKernelCallbackI.endPlanConstruction
escapeDrawing
▸ escapeDrawing(cancelDrawing
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
exportGLB
▸ exportGLB(_exportObjects?
, _id?
): void
Parameters
Name | Type |
---|---|
|
|
|
|
Returns
void
exportImageFromCamera
▸ exportImageFromCamera(filename
, shouldWaitForAssets?
): Promise
<void
>
Parameters
Name | Type | Default value |
---|---|---|
|
|
|
|
|
|
Returns
Promise
<void
>
Inherited from
getBounds
▸ getBounds(): Box3
Returns
Box3
Overrides
getCameraOffset
▸ getCameraOffset(): CanvasOffset
Returns
Inherited from
getComponent
▸ getComponent(componentRuntimeId
): KernelComponent
Parameters
Name | Type |
---|---|
|
|
Returns
Inherited from
getGeometryBounds
▸ getGeometryBounds(): Box3
Returns
Box3
Overrides
getOrthographicOffsetCamera
▸ getOrthographicOffsetCamera(): OrthographicOffsetCamera
Returns
Inherited from
default.getOrthographicOffsetCamera
getPlanObject
▸ getPlanObject(id
): KernelPlanObject
Parameters
Name | Type |
---|---|
|
|
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
Name | Type |
---|---|
|
|
Returns
number
getScene
▸ getScene(): Scene
Returns
Scene
Inherited from
getScreenXY
▸ getScreenXY(position
): Vector3
Parameters
Name | Type |
---|---|
|
|
Returns
Vector3
Inherited from
getWallAngleDegrees
▸ getWallAngleDegrees(wall
): number
Parameters
Name | Type |
---|---|
|
Returns
number
handleEvent
▸ handleEvent(evt
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
handlerSwitchedPlans
▸ handlerSwitchedPlans(fromPlan
, toPlan
): void
Parameters
Returns
void
Implementation of
PlannerKernelCallbackI.handlerSwitchedPlans
hideDimensions
▸ hideDimensions(): void
Returns
void
Inherited from
highlightParts
▸ highlightParts(ids
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
importGLB
▸ importGLB(url
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
loadDynamicLightSetting
▸ loadDynamicLightSetting(source
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<void
>
Inherited from
default.loadDynamicLightSetting
loadEnvMap
▸ loadEnvMap(url
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<void
>
Inherited from
loadSceneSettings
▸ loadSceneSettings(sceneSetting
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<void
>
Inherited from
loadStaticPlanObjects
▸ loadStaticPlanObjects(): void
Returns
void
lockCamera
▸ lockCamera(): void
Returns
void
Inherited from
moveCamera
▸ moveCamera(cameraParameter
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<void
>
Overrides
moveElementPosition
▸ moveElementPosition(selectedElement
, position
): void
Parameters
Name | Type |
---|---|
| |
|
Returns
void
moveElementsPosition
▸ moveElementsPosition(selectedElements
, position
): void
Parameters
Name | Type |
---|---|
|
|
|
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
Name | Type |
---|---|
|
Returns
void
Implementation of
PlannerKernelCallbackI.planCompletelyLoaded
planElementChanged
▸ planElementChanged(_plan
, _planViewModel
): Promise
<void
>
Parameters
Returns
Promise
<void
>
Implementation of
PlannerKernelCallbackI.planElementChanged
planElementRemoved
▸ planElementRemoved(element
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Implementation of
PlannerKernelCallbackI.planElementRemoved
planHistoryStateChanged
▸ planHistoryStateChanged(): void
Returns
void
Implementation of
PlannerKernelCallbackI.planHistoryStateChanged
planObjectConfigurationLoaded
▸ planObjectConfigurationLoaded(plan
, element
, _success
): void
Parameters
Name | Type |
---|---|
| |
| |
|
|
Returns
void
Implementation of
PlannerKernelCallbackI.planObjectConfigurationLoaded
planObjectConstructionDone
▸ planObjectConstructionDone(_planObject
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
default.planObjectConstructionDone
planObjectUpdated
▸ planObjectUpdated(planObject
, geometryChanged
, pendingDocking
): void
Parameters
Name | Type |
---|---|
| |
|
|
|
|
Returns
void
Inherited from
planXMLLoaded
▸ planXMLLoaded(plan
): void
Parameters
Name | Type |
---|---|
|
Returns
void
preload
▸ preload(id
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
preparePartImage
▸ preparePartImage(partId
, options
): Promise
<any
>
Parameters
Name | Type |
---|---|
|
|
|
Returns
Promise
<any
>
Inherited from
preparePerspectiveImage
▸ preparePerspectiveImage(options?
): Promise
<Base64Image
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<Base64Image
>
Overrides
default.preparePerspectiveImage
preparePerspectiveImageOf
▸ preparePerspectiveImageOf(runtimeId
, options?
): Promise
<Base64Image
>
Parameters
Name | Type |
---|---|
|
|
|
Returns
Promise
<Base64Image
>
prepareTopImage
▸ prepareTopImage(options?
): Promise
<Base64Image
>
Parameters
Name | Type |
---|---|
|
Returns
Promise
<Base64Image
>
Overrides
previewConstructionDone
▸ previewConstructionDone(_component
, hasPreviews
): void
Parameters
Name | Type |
---|---|
| |
|
|
Returns
void
Inherited from
default.previewConstructionDone
removeEventListener
▸ removeEventListener(_listener
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
removePlanObjectFromScene
▸ removePlanObjectFromScene(planViewModel
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Implementation of
PlannerKernelCallbackI.removePlanObjectFromScene
renderImage
▸ renderImage(renderOptions
): Promise
<Base64Image
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<Base64Image
>
Inherited from
requestDeleteSelectedComponent
▸ requestDeleteSelectedComponent(): void
Returns
void
Inherited from
default.requestDeleteSelectedComponent
requestDockingsPreview
▸ requestDockingsPreview(userInitiated
, possibleChild?
, dragEvent?
, dragIn?
): void
Parameters
Name | Type |
---|---|
|
|
| |
|
|
|
|
Returns
void
Inherited from
default.requestDockingsPreview
resetCameraPositionToStart
▸ resetCameraPositionToStart(): void
Returns
void
Overrides
default.resetCameraPositionToStart
resetConfiguratorContext
▸ resetConfiguratorContext(): void
Returns
void
resetPreviews
▸ resetPreviews(): void
Returns
void
Inherited from
resume
▸ resume(): void
Returns
void
Inherited from
rotatePlanElementSelection
▸ rotatePlanElementSelection(rotateBy
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
saveConfigToIdb
▸ saveConfigToIdb(): void
Returns
void
Inherited from
sceneChanged
▸ sceneChanged(): void
Returns
void
Overrides
sceneCleared
▸ sceneCleared(shouldHardReset
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
selectComponent
▸ selectComponent(runtimeId
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
selectPlanObject
▸ selectPlanObject(runtimeId
): Promise
<void
>
Parameters
Name | Type |
---|---|
|
|
Returns
Promise
<void
>
setBackgroundColor
▸ setBackgroundColor(hex
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
setBackgroundImage
▸ setBackgroundImage(url
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
setCameraOffset
▸ setCameraOffset(offset
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
setCompletelyLoaded
▸ setCompletelyLoaded(completelyLoaded
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
setEnvironmentMap
▸ setEnvironmentMap(url?
, intensity?
, rotation?
, maxLightSources?
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
|
|
Returns
void
Inherited from
setMeasurementLineLength
▸ setMeasurementLineLength(measurementId
, length
, wallDirection
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
setMode
▸ setMode(mode
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
setObjectToWallMeasurementLength
▸ setObjectToWallMeasurementLength(planElementId
, measurementId
, length
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
|
Returns
void
setSceneEvents
▸ setSceneEvents(sceneEvents
): void
Parameters
Name | Type |
---|---|
|
Returns
void
setSelectionMode
▸ setSelectionMode(mode
): void
Parameters
Name | Type |
---|---|
|
Returns
void
Inherited from
setWallMeasurementLength
▸ setWallMeasurementLength(measurementId
, length
, wallDirection
): void
Parameters
Name | Type |
---|---|
|
|
|
|
|
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
Name | Type |
---|---|
|
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
Name | Type | Default value |
---|---|---|
|
|
|
Returns
void
Inherited from
updateCameraOnDrawWalls
▸ updateCameraOnDrawWalls(): void
Returns
void
updateScene
▸ updateScene(): void
Returns
void
Inherited from
zoomIn
▸ zoomIn(value?
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
zoomOut
▸ zoomOut(value?
): void
Parameters
Name | Type |
---|---|
|
|
Returns
void
Inherited from
Last updated