Roomle Documentation
  • Overview
  • Quick Start Guides
    • Create you first 3D Viewer & AR
      • Sign up & upgrade your license plan in Rubens Admin
      • Create a product for the Rubens 3D Viewer
      • Batch upload products into your catalogue
    • Convert your static product into a material configurator
  • Rubens Products
    • Overview
    • Architectural overview
    • Rubens Products vs. Rubens SDK
    • Rubens 3D Viewer & AR
      • Getting started
    • Rubens Configurator
      • Getting started
      • Integration
        • Setup the configurator
        • Listen to events
          • Request a product
          • Parts list changes
          • Analytic events
          • Button clicks
        • Trigger API functions
          • Implement custom buttons
        • How to use prices in Rubens Configurator?
          • Use the parts list for calculating prices
          • Use Rubens Price Service
          • Use your own backend for calculating prices
        • Analytics Event
          • Rubens Configurator + Google Analytics (GDPR)
        • Customise shareable links
        • Handle CORS
      • Customisation
        • Hide Bottom Bar
        • Custom parts list print
        • Enable / Disable buttons
        • Override labels
        • Skinning options
          • Colors
          • Font
        • Localization
        • Change floor material
        • Highlighting in the configurator
      • Recipes
        • Implement custom AR button
        • Add product variants
        • Parameter outside of the configurator
        • Load different products into the configurator
    • Rubens Room Designer
      • Getting started
      • Integration
        • Setup Room Designer
        • Listen to events
          • onSavePlan
        • Call 3D Scene functions
          • Trigger request plan button
        • How to use prices in Room Designer?
          • Use Rubens Price Service
          • Use your own backend for calculating prices
        • Handle CORS
      • Customisation
        • Hide Bottom Bar
        • Enable / Disable buttons
        • Override labels
        • Skinning options
          • Colors
          • Font
        • Add products from an external catalog
        • Add custom overlays (advanced)
        • Localization
      • Recipes
        • Load different plans into the scene
        • Adding items to the scene
    • Rubens Products Reference
      • Classes
        • ExposedAnalyticsCallbacks.ExposedAnalyticsCallbacks
        • ExposedApi.ExposedApi
        • ExposedApi.Internal.Connector
        • ExposedApi.Internal.ExposedApiDragGhost
        • ExposedApi.Internal.ExposedApiDragHandler
        • ExposedApi.Internal.Libs
        • ExposedApi.Internal.MessageHandler
        • ExposedApi.Internal.RoomleSdkWrapper
        • ExposedApi.Internal.SdkConnector
        • ExposedApi.Internal.SdkConnectorConfigurator
        • ExposedApi.Internal.SdkConnectorPlanner
        • ExposedApi.Internal.SdkConnectorViewer
        • ExposedApi.Internal.UiCallbacks
        • ExposedApi.Internal.default-1
        • ExposedApi.Internal.default-2
        • ExposedApi.Internal.default
        • ExposedCallbacks.ExposedCallbacks
        • RoomleConfiguratorApi.default
      • Enums
        • ExposedApi.Internal.BUTTONACTIONS
        • ExposedApi.Internal.GACATEGORY
        • ExposedApi.Internal.GACUSTOM
        • ExposedApi.Internal.SDKMODULES
        • Types.UIBUTTON
        • Types.UIELEMENTS
      • Interfaces
        • ExposedApi.Internal.Analytics
        • ExposedApi.Internal.CollectionViewComponentIcon
        • ExposedApi.Internal.CollectionViewElement
        • ExposedApi.Internal.CollectionViewUiState
        • ExposedApi.Internal.CommonUiState
        • ExposedApi.Internal.CoreData
        • ExposedApi.Internal.CoreState
        • ExposedApi.Internal.DragGhostOptions
        • ExposedApi.Internal.DragInOptions
        • ExposedApi.Internal.DragInSettings
        • ExposedApi.Internal.EmbeddingCommand
        • ExposedApi.Internal.EmbeddingResponse
        • ExposedApi.Internal.GridViewElement
        • ExposedApi.Internal.GridViewUiState
        • ExposedApi.Internal.GridViewVariantElement
        • ExposedApi.Internal.IncomingMessageBus
        • ExposedApi.Internal.KernelBoundsFormatted
        • ExposedApi.Internal.OutgoingMessageBus
        • ExposedApi.Internal.OverlayState
        • ExposedApi.Internal.ParameterGroup
        • ExposedApi.Internal.PartlistResponse
        • ExposedApi.Internal.PlannerCoreData
        • ExposedApi.Internal.PlannerUiState
        • ExposedApi.Internal.PointRect
        • ExposedApi.Internal.SampleRoom
        • ExposedApi.Internal.SceneSelection
        • ExposedApi.Internal.SharedUiState
        • ExposedApi.Internal.StoreState
        • ExposedApi.Internal.TabCategory
        • ExposedApi.Internal.Translator
        • ExposedApi.Internal.UiLabels
        • ExposedApi.Internal.UiPossibleChildTagWithKey
        • ExposedApi.Internal.UiState
        • ExposedApi.Internal.WrapLines
        • ExposedCallbacks.Labels
        • ExposedCallbacks.Price
        • ExposedCallbacks.Internal.SaveDraftPayload
        • RoomleConfiguratorApi.RoomleEmbeddingApiKeys
        • Types.ConfiguratorSettings
        • Types.CustomViewSettingsForIframe
        • Types.CustomViewSettingsForOverlay
        • Types.CustomViews
        • Types.CustomViewsCallbacks
        • Types.EmbeddingSkin
        • Types.HelpCenterSetting
        • Types.ThumbnailsSettings
        • Types.UiInitData
        • Types.UiState
        • Types.VariantsMap
        • Types.Internal.CustomTutorialTranslation
        • Types.Internal.CustomViewSettingsBase
        • Types.Internal.PartlistPrintPayload
        • Types.Internal.SidebarEventTypes
        • Types.Internal.UiFeatureFlags
      • Modules
        • ExposedAnalyticsCallbacks
        • ExposedApi.Internal
        • ExposedApi
        • ExposedCallbacks.Internal
        • ExposedCallbacks
        • RoomleConfiguratorApi
        • Types.Internal
        • Types
      • Translate-labels
  • Rubens SDK
    • Overview
    • Getting Started
    • Rubens Modules
    • Rubens GLB Viewer
      • Getting started
      • Scene Customisation
        • Environment
        • Transparent Background
    • Rubens Configurator
      • Getting Started
      • Configurator Concepts
      • Listen to events
      • Control 3D Scene
      • Scene Customisation
        • Environment
        • Transparent Background
      • Different types of configurations
      • How to change a configuration
    • Rubens Planner (Room Designer)
      • Getting started
      • Listen to events
      • Control 3D Scene
      • Scene Customisation
        • Environment
        • Transparent Background
    • Rubens SDK Reference
      • Classes
        • EnvironmentDynamicEnvironmentSettingLoader.default
        • LightsettingDynamicLightSettingLoader.default
        • SceneSettingsLoader.default
        • Configurator.Configurator
        • Configurator.Internal.CommunicationInterface
        • Configurator.Internal.GlobalCallback
        • Configurator.Internal.MainThreadToWorker
        • Configurator.Internal.RoomleError
        • Configurator.Internal.UiCallback
        • Configurator.Internal.default-1
        • Configurator.Internal.default-2
        • Configurator.Internal.default-3
        • Configurator.Internal.default-4
        • Configurator.Internal.default-5
        • Configurator.Internal.default-6
        • Configurator.Internal.default-7
        • Configurator.Internal.default-8
        • Configurator.Internal.default-9
        • Configurator.Internal.default
        • RoomleConfigurator.Internal.AORenderPass
        • RoomleConfigurator.Internal.AbstractModel
        • RoomleConfigurator.Internal.AbstractModelWrapper
        • RoomleConfigurator.Internal.BakedGroundContactShadowPass
        • RoomleConfigurator.Internal.BaseMaterial
        • RoomleConfigurator.Internal.BlendAoAndAShadowMaterial
        • RoomleConfigurator.Internal.BlendAoPassDepthMaterial
        • RoomleConfigurator.Internal.BlurPass
        • RoomleConfigurator.Internal.CameraUpdate
        • RoomleConfigurator.Internal.CopyTransformMaterial
        • RoomleConfigurator.Internal.DebugPass
        • RoomleConfigurator.Internal.EMSConstant
        • RoomleConfigurator.Internal.EmsArray
        • RoomleConfigurator.Internal.EmsList
        • RoomleConfigurator.Internal.EnvironmentMapDecodeMaterial
        • RoomleConfigurator.Internal.GBufferMaterialCache
        • RoomleConfigurator.Internal.GBufferRenderPass
        • RoomleConfigurator.Internal.GroundContactCamera
        • RoomleConfigurator.Internal.GroundReflectionIntensityMaterial
        • RoomleConfigurator.Internal.GroundReflectionPass
        • RoomleConfigurator.Internal.InputEvent
        • RoomleConfigurator.Internal.KernelAtticArray
        • RoomleConfigurator.Internal.KernelObjectConfigurationArray
        • RoomleConfigurator.Internal.KernelPlanObjectList
        • RoomleConfigurator.Internal.LightSample
        • RoomleConfigurator.Internal.LightSource
        • RoomleConfigurator.Internal.LinearDepthRenderMaterial
        • RoomleConfigurator.Internal.NormalAndDepthRenderMaterial
        • RoomleConfigurator.Internal.ObjectRenderCache
        • RoomleConfigurator.Internal.ObjectToWallLineArray
        • RoomleConfigurator.Internal.OccurrenceMap
        • RoomleConfigurator.Internal.OutlinePass
        • RoomleConfigurator.Internal.OutlineRenderer
        • RoomleConfigurator.Internal.Panel
        • RoomleConfigurator.Internal.PassRenderer
        • RoomleConfigurator.Internal.PlanObjectList
        • RoomleConfigurator.Internal.PlanObjectPtr
        • RoomleConfigurator.Internal.PointArray
        • RoomleConfigurator.Internal.PoissonDenoiseRenderPass
        • RoomleConfigurator.Internal.PostProcessingMaterialPlugin
        • RoomleConfigurator.Internal.PromiseQueue
        • RoomleConfigurator.Internal.RenderCacheManager
        • RoomleConfigurator.Internal.RenderCacheMapItem
        • RoomleConfigurator.Internal.RenderPass
        • RoomleConfigurator.Internal.RenderPassManager
        • RoomleConfigurator.Internal.RoomLightSourceDistributionArray
        • RoomleConfigurator.Internal.RoomleWebGLRenderer
        • RoomleConfigurator.Internal.SceneEventInfo
        • RoomleConfigurator.Internal.SceneRenderPass
        • RoomleConfigurator.Internal.SceneRenderer
        • RoomleConfigurator.Internal.SceneRendererGUI
        • RoomleConfigurator.Internal.SceneVolume
        • RoomleConfigurator.Internal.ScreenSpaceShadowMapPass
        • RoomleConfigurator.Internal.SelectionHandlerEvent
        • RoomleConfigurator.Internal.ShadowAndAoPass
        • RoomleConfigurator.Internal.ShadowGroundPlane
        • RoomleConfigurator.Internal.ShadowMapPassOverrideMaterialCache
        • RoomleConfigurator.Internal.ShadowTypeConfiguration
        • RoomleConfigurator.Internal.default-1
        • RoomleConfigurator.Internal.default-10
        • RoomleConfigurator.Internal.default-11
        • RoomleConfigurator.Internal.default-12
        • RoomleConfigurator.Internal.default-13
        • RoomleConfigurator.Internal.default-14
        • RoomleConfigurator.Internal.default-15
        • RoomleConfigurator.Internal.default-16
        • RoomleConfigurator.Internal.default-17
        • RoomleConfigurator.Internal.default-18
        • RoomleConfigurator.Internal.default-19
        • RoomleConfigurator.Internal.default-2
        • RoomleConfigurator.Internal.default-20
        • RoomleConfigurator.Internal.default-21
        • RoomleConfigurator.Internal.default-22
        • RoomleConfigurator.Internal.default-23
        • RoomleConfigurator.Internal.default-24
        • RoomleConfigurator.Internal.default-25
        • RoomleConfigurator.Internal.default-26
        • RoomleConfigurator.Internal.default-27
        • RoomleConfigurator.Internal.default-28
        • RoomleConfigurator.Internal.default-29
        • RoomleConfigurator.Internal.default-3
        • RoomleConfigurator.Internal.default-30
        • RoomleConfigurator.Internal.default-31
        • RoomleConfigurator.Internal.default-32
        • RoomleConfigurator.Internal.default-33
        • RoomleConfigurator.Internal.default-34
        • RoomleConfigurator.Internal.default-35
        • RoomleConfigurator.Internal.default-36
        • RoomleConfigurator.Internal.default-37
        • RoomleConfigurator.Internal.default-38
        • RoomleConfigurator.Internal.default-39
        • RoomleConfigurator.Internal.default-4
        • RoomleConfigurator.Internal.default-40
        • RoomleConfigurator.Internal.default-41
        • RoomleConfigurator.Internal.default-42
        • RoomleConfigurator.Internal.default-43
        • RoomleConfigurator.Internal.default-44
        • RoomleConfigurator.Internal.default-45
        • RoomleConfigurator.Internal.default-46
        • RoomleConfigurator.Internal.default-47
        • RoomleConfigurator.Internal.default-48
        • RoomleConfigurator.Internal.default-49
        • RoomleConfigurator.Internal.default-5
        • RoomleConfigurator.Internal.default-50
        • RoomleConfigurator.Internal.default-51
        • RoomleConfigurator.Internal.default-52
        • RoomleConfigurator.Internal.default-53
        • RoomleConfigurator.Internal.default-54
        • RoomleConfigurator.Internal.default-55
        • RoomleConfigurator.Internal.default-6
        • RoomleConfigurator.Internal.default-7
        • RoomleConfigurator.Internal.default-8
        • RoomleConfigurator.Internal.default-9
        • RoomleConfigurator.Internal.default
        • RoomleConfigurator.default
        • ServicesConfiguratorUiCallback.Internal.AddOnSpotArray-1
        • ServicesConfiguratorUiCallback.Internal.AddOnSpotArray
        • ServicesConfiguratorUiCallback.Internal.CatalogItem
        • ServicesConfiguratorUiCallback.Internal.CatalogItemPtrList
        • ServicesConfiguratorUiCallback.Internal.ComponentArray-1
        • ServicesConfiguratorUiCallback.Internal.ComponentArray
        • ServicesConfiguratorUiCallback.Internal.ConfigurationArray-1
        • ServicesConfiguratorUiCallback.Internal.ConfigurationArray
        • ServicesConfiguratorUiCallback.Internal.ConstructionObject
        • ServicesConfiguratorUiCallback.Internal.ConstructionObjectSet
        • ServicesConfiguratorUiCallback.Internal.DockPairToLineArray-1
        • ServicesConfiguratorUiCallback.Internal.DockPairToLineArray
        • ServicesConfiguratorUiCallback.Internal.DockPairToPointArray-1
        • ServicesConfiguratorUiCallback.Internal.DockPairToPointArray
        • ServicesConfiguratorUiCallback.Internal.EMSReference
        • ServicesConfiguratorUiCallback.Internal.EmsSet
        • ServicesConfiguratorUiCallback.Internal.ExternalReference
        • ServicesConfiguratorUiCallback.Internal.Floor
        • ServicesConfiguratorUiCallback.Internal.FloorMaterial
        • ServicesConfiguratorUiCallback.Internal.IntArray-1
        • ServicesConfiguratorUiCallback.Internal.IntArray
        • ServicesConfiguratorUiCallback.Internal.LongArray
        • ServicesConfiguratorUiCallback.Internal.Node
        • ServicesConfiguratorUiCallback.Internal.ObjectGroup
        • ServicesConfiguratorUiCallback.Internal.ParamKeyValuePairArray-1
        • ServicesConfiguratorUiCallback.Internal.ParamKeyValuePairArray
        • ServicesConfiguratorUiCallback.Internal.ParameterArray-1
        • ServicesConfiguratorUiCallback.Internal.ParameterArray
        • ServicesConfiguratorUiCallback.Internal.ParameterGroupArray-1
        • ServicesConfiguratorUiCallback.Internal.ParameterGroupArray
        • ServicesConfiguratorUiCallback.Internal.ParameterValueArray-1
        • ServicesConfiguratorUiCallback.Internal.ParameterValueArray
        • ServicesConfiguratorUiCallback.Internal.PartArray-1
        • ServicesConfiguratorUiCallback.Internal.PartArray
        • ServicesConfiguratorUiCallback.Internal.PartListParameterArray-1
        • ServicesConfiguratorUiCallback.Internal.PartListParameterArray
        • ServicesConfiguratorUiCallback.Internal.Plan
        • ServicesConfiguratorUiCallback.Internal.PlanElement
        • ServicesConfiguratorUiCallback.Internal.PlanImage
        • ServicesConfiguratorUiCallback.Internal.PlanMeasure
        • ServicesConfiguratorUiCallback.Internal.PlanModelViewHelper
        • ServicesConfiguratorUiCallback.Internal.PlanObjectObjectSet
        • ServicesConfiguratorUiCallback.Internal.PlanObjectPtrList
        • ServicesConfiguratorUiCallback.Internal.PlanObjectPtrVector
        • ServicesConfiguratorUiCallback.Internal.PlanText
        • ServicesConfiguratorUiCallback.Internal.PointArray
        • ServicesConfiguratorUiCallback.Internal.PossibleChildArray-1
        • ServicesConfiguratorUiCallback.Internal.PossibleChildArray
        • ServicesConfiguratorUiCallback.Internal.RangeArray-1
        • ServicesConfiguratorUiCallback.Internal.RangeArray
        • ServicesConfiguratorUiCallback.Internal.SizeTArray
        • ServicesConfiguratorUiCallback.Internal.StringArray
        • ServicesConfiguratorUiCallback.Internal.UnitMeasureFormatter-1
        • ServicesConfiguratorUiCallback.Internal.UnitMeasureFormatter
        • ServicesConfiguratorUiCallback.Internal.VariableArray-1
        • ServicesConfiguratorUiCallback.Internal.VariableArray
        • ServicesConfiguratorUiCallback.Internal.VariantArray-1
        • ServicesConfiguratorUiCallback.Internal.VariantArray
        • ServicesConfiguratorUiCallback.Internal.Vector2fArray
        • ServicesConfiguratorUiCallback.Internal.Wall
        • ServicesConfiguratorUiCallback.Internal.WallMaterial
        • ServicesConfiguratorUiCallback.default
        • GlbViewer.GlbViewer
        • RoomleGlbViewer.GlbViewerUiCallbacks
        • RoomleGlbViewer.Internal.default-1
        • RoomleGlbViewer.Internal.default-2
        • RoomleGlbViewer.Internal.default-3
        • RoomleGlbViewer.Internal.default
        • RoomleGlbViewer.default
        • Planner.Planner
        • RoomlePlanner.Internal.PlannerSelectionHandlerEvent
        • RoomlePlanner.Internal.SceneEventInfo
        • RoomlePlanner.Internal.default-1
        • RoomlePlanner.Internal.default-10
        • RoomlePlanner.Internal.default-11
        • RoomlePlanner.Internal.default-12
        • RoomlePlanner.Internal.default-13
        • RoomlePlanner.Internal.default-14
        • RoomlePlanner.Internal.default-15
        • RoomlePlanner.Internal.default-16
        • RoomlePlanner.Internal.default-17
        • RoomlePlanner.Internal.default-18
        • RoomlePlanner.Internal.default-19
        • RoomlePlanner.Internal.default-2
        • RoomlePlanner.Internal.default-20
        • RoomlePlanner.Internal.default-21
        • RoomlePlanner.Internal.default-22
        • RoomlePlanner.Internal.default-23
        • RoomlePlanner.Internal.default-24
        • RoomlePlanner.Internal.default-3
        • RoomlePlanner.Internal.default-4
        • RoomlePlanner.Internal.default-5
        • RoomlePlanner.Internal.default-6
        • RoomlePlanner.Internal.default-7
        • RoomlePlanner.Internal.default-8
        • RoomlePlanner.Internal.default-9
        • RoomlePlanner.Internal.default
        • RoomlePlanner.default
        • RoomlePlannerUiCallback.default
        • TypingsKernel.Internal.BindingError
        • TypingsKernel.Internal.InternalError
        • TypingsKernel.Internal.UnboundTypeError
      • Enums
        • UtilsShims.WINDOWEVENT
        • Configurator.Internal.ASSETKEYS
        • Configurator.Internal.ERRORCODES
        • Configurator.Internal.PROMISECATEGORY
        • Configurator.Internal.RAPIPATHS
        • Configurator.Internal.SHORTTYPES
        • Configurator.Internal.WORKERMESSAGE
        • RoomleConfigurator.PARAMETERUPDATETYPE
        • RoomleConfigurator.Internal.BASECONTEXT
        • RoomleConfigurator.Internal.DrawingType
        • RoomleConfigurator.Internal.INPUTEVENTTYPE
        • RoomleConfigurator.Internal.INTERSECTIONMODE
        • RoomleConfigurator.Internal.KERNELTYPE
        • RoomleConfigurator.Internal.PARAMETERKERNELTYPE
        • RoomleConfigurator.Internal.RenderMode
        • RoomleConfigurator.Internal.ResizingAnchor
        • RoomleConfigurator.Internal.SELECTIONMODE
        • RoomleConfigurator.Internal.STATE-1
        • RoomleConfigurator.Internal.STATE-2
        • RoomleConfigurator.Internal.STATE
        • RoomleConfigurator.Internal.SnapMode
        • ServicesConfiguratorUiCallback.Internal.MaterialSourceType
        • ServicesConfiguratorUiCallback.Internal.PlanElementType
        • ServicesConfiguratorUiCallback.Internal.PlanObjectSide
        • ServicesConfiguratorUiCallback.Internal.Type-1
        • ServicesConfiguratorUiCallback.Internal.Type
        • ServicesConfiguratorUiCallback.Internal.Unit-1
        • ServicesConfiguratorUiCallback.Internal.Unit
        • ServicesConfiguratorUiCallback.Internal.UnitStringType-1
        • ServicesConfiguratorUiCallback.Internal.UnitStringType
        • ServicesConfiguratorUiCallback.Internal.UnitType-1
        • ServicesConfiguratorUiCallback.Internal.UnitType
        • RoomlePlanner.Internal.MODE
        • RoomlePlanner.Internal.PLANNERSCENEEVENTSTATE
        • TypingsKernel.DIMENSIONINGTYPE
        • TypingsKernel.ExportType
        • TypingsKernel.Internal.PARAMETERUNITTYPES
        • TypingsRapiTypes.MAILTYPE
        • TypingsRapiTypes.RAPIADDITIONALCONTENTS
        • TypingsRapiTypes.RAPITEXTURETYPE
        • TypingsRapiTypes.RapiFavoriteType
      • Interfaces
        • CommonInterfaces.Base64Image
        • CommonInterfaces.CanvasOffset
        • CommonInterfaces.Position2
        • CommonInterfaces.Position3
        • EnvironmentDynamicEnvironmentSettingLoader.EnvironmentDetails
        • EnvironmentDynamicEnvironmentSettingLoader.EnvironmentSetting
        • LightsettingDynamicLightSettingLoader.DynamicLight
        • LightsettingDynamicLightSettingLoader.DynamicLightSettingSource
        • SceneSettingsLoader.SceneSettings
        • UtilsShims.CommonInitData
        • UtilsShims.ConfiguratorInitData
        • UtilsShims.FeatureFlags
        • UtilsShims.GlobalInitDataDefinition
        • UtilsShims.InitDataDefinition
        • UtilsShims.PlannerInitData
        • Configurator.Internal.AppState
        • Configurator.Internal.CommunicationInterfaceCallback
        • Configurator.Internal.Context
        • Configurator.Internal.CustomShadingParameters
        • Configurator.Internal.ExternalEmbeddable
        • Configurator.Internal.ExternalObjectApiConfiguration
        • Configurator.Internal.ExternalObjectDebugConfiguration
        • Configurator.Internal.ExternalObjectMaterialConfiguration
        • Configurator.Internal.ExternalObjectUiConfiguration
        • Configurator.Internal.ExternalObjectUiSliderRange
        • Configurator.Internal.FetchOptions
        • Configurator.Internal.KernelMessageMetaInfo
        • Configurator.Internal.LifeCycleCallbacks
        • Configurator.Internal.ListenersMap
        • Configurator.Internal.NetworkRequestValidations
        • Configurator.Internal.QueuedElement
        • Configurator.Internal.RapiError
        • Configurator.Internal.RapiRelationDefinition
        • Configurator.Internal.SaveOptions
        • RoomleConfigurator.Internal.AOPassParameters
        • RoomleConfigurator.Internal.AORenderPassParameters
        • RoomleConfigurator.Internal.ActiveShadowLight
        • RoomleConfigurator.Internal.Anchor
        • RoomleConfigurator.Internal.AtticDimension
        • RoomleConfigurator.Internal.BakedGroundContactShadowConstructorParameters
        • RoomleConfigurator.Internal.BakedGroundContactShadowParameters
        • RoomleConfigurator.Internal.BlendAoAndAShadowMaterialParameters
        • RoomleConfigurator.Internal.BlendAoPassDepthMaterialParameters
        • RoomleConfigurator.Internal.CameraParameter
        • RoomleConfigurator.Internal.CameraTarget
        • RoomleConfigurator.Internal.ChildEntityMode
        • RoomleConfigurator.Internal.CleanupOptions
        • RoomleConfigurator.Internal.CommonConfiguratorKernelCallbackI
        • RoomleConfigurator.Internal.ComponentEventInfo
        • RoomleConfigurator.Internal.ConfigurationLoadedResponse
        • RoomleConfigurator.Internal.ConfiguratorDebugAPI
        • RoomleConfigurator.Internal.ConfiguratorKernelAccessCallbackI
        • RoomleConfigurator.Internal.ConfiguratorKernelCallbackI
        • RoomleConfigurator.Internal.ConfiguratorViewModelCallbackI
        • RoomleConfigurator.Internal.ContinuousDrawingManager
        • RoomleConfigurator.Internal.CopyTransformMaterialParameters
        • RoomleConfigurator.Internal.DenoisePass
        • RoomleConfigurator.Internal.DimensionDefinition
        • RoomleConfigurator.Internal.DynamicPassUpdateRequirements
        • RoomleConfigurator.Internal.EMSReference
        • RoomleConfigurator.Internal.EnvMapParams
        • RoomleConfigurator.Internal.EnvironmentMapResult
        • RoomleConfigurator.Internal.ExternalElement
        • RoomleConfigurator.Internal.ExternalMeta
        • RoomleConfigurator.Internal.ExternalObjectContour
        • RoomleConfigurator.Internal.ExternalObjectGroup
        • RoomleConfigurator.Internal.ExternalObjectGroupPosition
        • RoomleConfigurator.Internal.ExternalObjectLoadConfiguration
        • RoomleConfigurator.Internal.ExternalObjectRootModule
        • RoomleConfigurator.Internal.ExternalObjectSegment
        • RoomleConfigurator.Internal.GBufferNormalDepthMaterialParameters
        • RoomleConfigurator.Internal.GBufferParameters
        • RoomleConfigurator.Internal.GBufferRenderTargetsParameters
        • RoomleConfigurator.Internal.GBufferTextures
        • RoomleConfigurator.Internal.GLTFScene
        • RoomleConfigurator.Internal.GlobalAPI
        • RoomleConfigurator.Internal.GroundReflectionConstructorParameters
        • RoomleConfigurator.Internal.GroundReflectionIntensityMaterialParameters
        • RoomleConfigurator.Internal.GroundReflectionParameters
        • RoomleConfigurator.Internal.HomagIxArticleParams
        • RoomleConfigurator.Internal.HomagIxHeaderParams
        • RoomleConfigurator.Internal.HomagIxOrderParams
        • RoomleConfigurator.Internal.InputEventAttatchment
        • RoomleConfigurator.Internal.KernelAccessCallbackI
        • RoomleConfigurator.Internal.KernelAttic
        • RoomleConfigurator.Internal.KernelFloor
        • RoomleConfigurator.Internal.KernelFloorMaterial
        • RoomleConfigurator.Internal.KernelObject
        • RoomleConfigurator.Internal.KernelObjectConfiguration
        • RoomleConfigurator.Internal.KernelRoomWall
        • RoomleConfigurator.Internal.KernelUnitFormatter
        • RoomleConfigurator.Internal.KernelUtilityForUi
        • RoomleConfigurator.Internal.KernelWall
        • RoomleConfigurator.Internal.KernelWallMaterial
        • RoomleConfigurator.Internal.LightSourceConfiguration
        • RoomleConfigurator.Internal.Listener
        • RoomleConfigurator.Internal.ListenerCallback
        • RoomleConfigurator.Internal.ListenersMap
        • RoomleConfigurator.Internal.LutImageDefinition
        • RoomleConfigurator.Internal.LutPassParameters
        • RoomleConfigurator.Internal.MeasurementBase
        • RoomleConfigurator.Internal.MessageObject
        • RoomleConfigurator.Internal.NodePlanObject
        • RoomleConfigurator.Internal.Object3DRoomleEventMap
        • RoomleConfigurator.Internal.ObjectCacheData
        • RoomleConfigurator.Internal.ObjectCacheEntry
        • RoomleConfigurator.Internal.ObjectMeasurements
        • RoomleConfigurator.Internal.ObjectToWallLine
        • RoomleConfigurator.Internal.OffsetCamera
        • RoomleConfigurator.Internal.OrthographicOffsetCamera
        • RoomleConfigurator.Internal.OutlineParameters
        • RoomleConfigurator.Internal.OutlinePassParameters
        • RoomleConfigurator.Internal.OutlineRendererParameters
        • RoomleConfigurator.Internal.PerspectiveOffsetCamera
        • RoomleConfigurator.Internal.Plan
        • RoomleConfigurator.Internal.PlanElement
        • RoomleConfigurator.Internal.PlanInteractionHandler
        • RoomleConfigurator.Internal.PlanMeasure
        • RoomleConfigurator.Internal.PlanModelViewHelper
        • RoomleConfigurator.Internal.PlanNode
        • RoomleConfigurator.Internal.PlanObject
        • RoomleConfigurator.Internal.PlanOverview
        • RoomleConfigurator.Internal.PlannerKernelCallbackI
        • RoomleConfigurator.Internal.PluginConfigMap
        • RoomleConfigurator.Internal.PoissonDenoiseParameters
        • RoomleConfigurator.Internal.PoissonDenoisePassParameters
        • RoomleConfigurator.Internal.PrepareImageOptions
        • RoomleConfigurator.Internal.PreviewComponent
        • RoomleConfigurator.Internal.PreviewLineComponent
        • RoomleConfigurator.Internal.PreviewLineSegment
        • RoomleConfigurator.Internal.PromiseExecutor
        • RoomleConfigurator.Internal.Rectangle
        • RoomleConfigurator.Internal.RectangleReferencePoints
        • RoomleConfigurator.Internal.RenderCache
        • RoomleConfigurator.Internal.RoomLightSourceDistribution
        • RoomleConfigurator.Internal.RoomleComponent
        • RoomleConfigurator.Internal.RoomleComponentFactory
        • RoomleConfigurator.Internal.RoomleToolsCoreUICallback
        • RoomleConfigurator.Internal.RubensAPI
        • RoomleConfigurator.Internal.SavedIdbData
        • RoomleConfigurator.Internal.ScenePlugin
        • RoomleConfigurator.Internal.ScenePluginHooks
        • RoomleConfigurator.Internal.SceneRendererChangeParameters
        • RoomleConfigurator.Internal.SceneRendererParameters
        • RoomleConfigurator.Internal.ScreenSpaceShadowMapConstructorParameters
        • RoomleConfigurator.Internal.ScreenSpaceShadowMapParameters
        • RoomleConfigurator.Internal.ScriptData
        • RoomleConfigurator.Internal.ShadowAndAoPassConstructorParameters
        • RoomleConfigurator.Internal.ShadowAndAoPassParameters
        • RoomleConfigurator.Internal.ShadowAndAoPassSettings
        • RoomleConfigurator.Internal.ShadowGroundPlaneParameters
        • RoomleConfigurator.Internal.ShadowLightSource
        • RoomleConfigurator.Internal.ShadowParameters
        • RoomleConfigurator.Internal.ShadowTypeParameters
        • RoomleConfigurator.Internal.StaticComponent
        • RoomleConfigurator.Internal.SubComponentWaiter
        • RoomleConfigurator.Internal.ToolsCoreContextCallback
        • RoomleConfigurator.Internal.ToolsCoreInterface
        • RoomleConfigurator.Internal.WallSide
        • RoomleConfigurator.Internal.PassUpdateStates
        • ServicesConfiguratorUiCallback.UIComponentInfo
        • ServicesConfiguratorUiCallback.Internal.ConfiguratorDebugCallbacks
        • ServicesConfiguratorUiCallback.Internal.ConfiguratorKernelContainer
        • ServicesConfiguratorUiCallback.Internal.KernelCube
        • ServicesConfiguratorUiCallback.Internal.PlannerKernelContainer
        • ServicesConfiguratorUiCallback.Internal.WallExtensionType
        • RoomleGlbViewer.RenderEntry
        • RoomleGlbViewer.Internal.GLBRenderWorkerListener
        • RoomleGlbViewer.Internal.RenderCameraInformation
        • RoomlePlanner.BatchPaintMaterial
        • RoomlePlanner.InteractionOptions
        • RoomlePlanner.RoomlePlannerCallback
        • RoomlePlanner.SceneEvents
        • RoomlePlanner.WallDefinition
        • RoomlePlanner.Internal.ConstructionMeasurements
        • RoomlePlanner.Internal.ConstructionPlanObject
        • RoomlePlanner.Internal.ExternalObjectAPI
        • RoomlePlanner.Internal.FloorAreaData
        • RoomlePlanner.Internal.LeftOrRightWallSide
        • RoomlePlanner.Internal.LocalStorageEntry
        • RoomlePlanner.Internal.PlanObjectEventInfo
        • RoomlePlanner.Internal.PrepareImageOptionsPlanner
        • RoomlePlanner.Internal.Store
        • RoomlePlanner.Internal.WallPlanObject
        • RoomlePlannerUiCallback.SelectionPayload
        • RoomlePlannerUiCallback.Internal.ConstructionMeasurementsTransferable
        • RoomlePlannerUiCallback.Internal.ExternalObjectUiCallback
        • RoomlePlannerUiCallback.Internal.ObjectMeasurementsTransferable
        • RoomlePlannerUiCallback.Internal.PlanObjectPosition
        • TypingsKernel.AddOnSpot
        • TypingsKernel.AssetRequest
        • TypingsKernel.AssetResponse
        • TypingsKernel.AssetType
        • TypingsKernel.ConfigurationExporter
        • TypingsKernel.ConfigurationObject
        • TypingsKernel.ConfiguratorKernelClass
        • TypingsKernel.DebugClient
        • TypingsKernel.DebugValueMapChange
        • TypingsKernel.DebugValueMapDump
        • TypingsKernel.Dimensioning
        • TypingsKernel.DockLine
        • TypingsKernel.DockPair
        • TypingsKernel.DockingLineSegment
        • TypingsKernel.EmscriptenList
        • TypingsKernel.EmscriptenMap
        • TypingsKernel.ExternalAttributeInformation
        • TypingsKernel.ExternalModuleInformation
        • TypingsKernel.HomagIxArticleData
        • TypingsKernel.KernelActionValue
        • TypingsKernel.KernelAddOnSpot
        • TypingsKernel.KernelAnimation
        • TypingsKernel.KernelAnimationAction
        • TypingsKernel.KernelCatalogItem
        • TypingsKernel.KernelComponent
        • TypingsKernel.KernelComponentTypeDto
        • TypingsKernel.KernelConfiguration
        • TypingsKernel.KernelConfigurationLoadedData
        • TypingsKernel.KernelContainer
        • TypingsKernel.KernelCube
        • TypingsKernel.KernelDockPairToLine
        • TypingsKernel.KernelDockPairToPoint
        • TypingsKernel.KernelEnum
        • TypingsKernel.KernelExternalObjectDocking
        • TypingsKernel.KernelMatrix4
        • TypingsKernel.KernelMeshAnimation
        • TypingsKernel.KernelMeshAttributes
        • TypingsKernel.KernelMeshBuffer
        • TypingsKernel.KernelObjectInformation
        • TypingsKernel.KernelObjectPtrList
        • TypingsKernel.KernelParamKeyValuePair
        • TypingsKernel.KernelParameter
        • TypingsKernel.KernelParameterGroup
        • TypingsKernel.KernelParameterValue
        • TypingsKernel.KernelPart
        • TypingsKernel.KernelPartList
        • TypingsKernel.KernelPartListParameter
        • TypingsKernel.KernelPartListPrice
        • TypingsKernel.KernelPlanObject
        • TypingsKernel.KernelPlanObjectBase
        • TypingsKernel.KernelPlanObjectComponent
        • TypingsKernel.KernelPossibleChild
        • TypingsKernel.KernelRange
        • TypingsKernel.KernelValue
        • TypingsKernel.KernelVariable
        • TypingsKernel.KernelVariant
        • TypingsKernel.KernelVector2f
        • TypingsKernel.KernelVector3
        • TypingsKernel.KernelVector3f
        • TypingsKernel.KernelViewType
        • TypingsKernel.ObjectConfigurationType
        • TypingsKernel.ObjectGroupPtr
        • TypingsKernel.ParamterKeyValue
        • TypingsKernel.PlanObject
        • TypingsKernel.UiKernelParameter
        • TypingsKernel.UiKernelRange
        • TypingsKernel.UiPlanObject
        • TypingsKernel.UiPossibleChild
        • TypingsKernel.UiPossibleChildTag
        • TypingsKernel.VariantsList
        • TypingsKernel.WasmDbEntry
        • TypingsRapiTypes.AdditionalInfo
        • TypingsRapiTypes.Asset
        • TypingsRapiTypes.AssetItem
        • TypingsRapiTypes.Element
        • TypingsRapiTypes.LinksCollection
        • TypingsRapiTypes.RapiAdditionalContent
        • TypingsRapiTypes.RapiAuth
        • TypingsRapiTypes.RapiBaseColor
        • TypingsRapiTypes.RapiCatalog
        • TypingsRapiTypes.RapiComponent
        • TypingsRapiTypes.RapiConfiguration
        • TypingsRapiTypes.RapiConfigurationEnhanced
        • TypingsRapiTypes.RapiConfiguratorSettings
        • TypingsRapiTypes.RapiElement
        • TypingsRapiTypes.RapiFavorite
        • TypingsRapiTypes.RapiItem
        • TypingsRapiTypes.RapiJson
        • TypingsRapiTypes.RapiJsonBox
        • TypingsRapiTypes.RapiMaterial
        • TypingsRapiTypes.RapiMaterialGroup
        • TypingsRapiTypes.RapiMaterialShading
        • TypingsRapiTypes.RapiMesh
        • TypingsRapiTypes.RapiMeshData
        • TypingsRapiTypes.RapiMeta
        • TypingsRapiTypes.RapiPackage
        • TypingsRapiTypes.RapiPlan
        • TypingsRapiTypes.RapiPlanAsset
        • TypingsRapiTypes.RapiPlanSetting
        • TypingsRapiTypes.RapiPlanSnapshotGetData
        • TypingsRapiTypes.RapiPlanSnapshotGetDataWith3dUrls
        • TypingsRapiTypes.RapiPlanSnapshotPostData
        • TypingsRapiTypes.RapiPrice
        • TypingsRapiTypes.RapiRetailer
        • TypingsRapiTypes.RapiRole
        • TypingsRapiTypes.RapiShortId
        • TypingsRapiTypes.RapiSkin
        • TypingsRapiTypes.RapiTag
        • TypingsRapiTypes.RapiTagForUi
        • TypingsRapiTypes.RapiTagGeneric
        • TypingsRapiTypes.RapiTenant
        • TypingsRapiTypes.RapiTexture
        • TypingsRapiTypes.RapiUser
        • TypingsRapiTypes.RapiUserSetting
        • TypingsRapiTypes.RoomleSortable
        • TypingsRapiTypes.UserAction
      • Modules
        • CommonInterfaces
        • EnvironmentDynamicEnvironmentSettingLoader
        • LightsettingDynamicLightSettingLoader.Internal
        • LightsettingDynamicLightSettingLoader
        • SceneSettingsLoader
        • UtilsShims.Internal
        • UtilsShims
        • Configurator.Internal
        • Configurator
        • RoomleConfigurator.Internal
        • RoomleConfigurator
        • ServicesConfiguratorUiCallback.Internal
        • ServicesConfiguratorUiCallback
        • GlbViewer
        • RoomleGlbViewer.Internal
        • RoomleGlbViewer
        • Planner
        • RoomlePlanner.Internal
        • RoomlePlanner
        • RoomlePlannerUiCallback.Internal
        • RoomlePlannerUiCallback
        • TypingsKernel.Internal
        • TypingsKernel
        • TypingsRapiTypes
  • Rubens admin
    • Rubens Admin Help
      • Getting started
      • Dashboard
      • Catalogs
      • Tags
      • Products
      • Components
      • Meshes
      • Materials
      • Import/Export
      • Administration
    • Requirements & Sample products
      • 3D Assets Requirements
      • Material & Textures Requirements
      • Sample products and files
  • Content Creation
    • Overview
    • Material Definition
      • Ideas
      • References
      • Resources
    • Blender Addon
    • Scripting Resources
      • Environment Setup for Making Roomle Content
      • Hello World Example for Roomle Component Scripting
      • Rubens CLI Setup and Usage Tutorial
      • Using Code Snippets to Instantly Load Offline Component Definitions
      • How to Debug Content
      • Introduction to Making Level 2 Material Configurators
      • Meshes Conversion and Upload
      • Set Up Materials
      • Level 2 Component Definition
      • Set Up Product Entries
      • Level 2-4 Content Requirements for 3D Data
      • 3D Models & Meshes
      • Prerequisities for Roomle Content Scripters
      • Level 3 Component Definition Basics
      • Parameters
      • Roomle Script Language Reference
      • Example: Scripting a Table from Primitives
      • Example: Parameterized Shelf System
      • SubComponents
      • Basic Docking Topics
      • Global Parameters and Parameter Context
      • Advanced Part List Topics
      • Dimensioning
      • Pricing
      • Advanced Docking Logic
      • Using GetMaterialPropery Function
      • Tenant Settings
      • Roomle Content Project Data Structure
      • Roomle Content Naming Conventions
      • Processes and Good Practices
      • Real Configurator Examples - Chairs, Armchairs, Footstools
      • Simple Colour Changing Product Scripting Example
      • 4-Post Shelving System Example
      • Office Table System Example
      • Scripting Template: Complex Sofa
      • Scripting Template: Two-Part Sofa System
      • Scripting Template: Simple Sofa System
      • Scripting Template: Wardrobe
      • Processing Meshes with Blender
    • Importer
    • IDM
      • About IDM
      • Data format
      • Extension files
      • Conversion
      • Docking logic
      • Part lists
      • Price logic
    • RoomleScript Reference
      • Configurationformat
      • Configuration and Plan
      • Error code list
      • Configurator Features
      • Configurator Script
      • Coordinate Systems
  • WHATS NEW?
    • 2025
      • May 2025
      • April 2025
      • March 2025
      • February 2025
      • January 2025
    • 2024
      • December 2024
      • November 2024
      • October 2024
      • September 2024
      • August 2024
      • July 2024
      • June 2024
      • May 2024
      • April 2024
      • March 2024
  • REST API
    • REST API Reference
      • RAPI Documentation
      • Webhook
      • Endpoints
        • AssetController
        • Authentication
        • CatalogController
        • CatalogElementAdditionalInfo
        • ComponentController
        • ConfigurationController
        • ConfiguratorController
        • Item
        • MaterialController
        • MeshController
        • PlanController
        • PlanSnapshotController
        • PriceController
        • PriceServiceController
        • ShortIdController
        • Skin
        • Statistics
        • TagController
        • Tenant
        • TextureController
        • User
        • UserSettings
    • Product Matching
  • Changelogs
    • Rubens Configurator Changelog
    • Rubens SDK Changelog
    • Rubens Admin Changelog
    • Material Definition Changelog
Powered by GitBook
On this page
  • Hierarchy
  • Implements
  • Table of contents
  • Constructors
  • Properties
  • Accessors
  • Methods
  • Constructors
  • constructor
  • Properties
  • _creator_
  • currentSelection
  • Accessors
  • configuratorContext
  • hasSingleRoom
  • Methods
  • _preparePerspectiveImage
  • addComponentHandlers
  • addEventListener
  • addMesh
  • addPlanMesh
  • addPlanObjectToScene
  • addPreviewHandlers
  • addPreviewLineHandlers
  • animateElement
  • backToPlanner
  • beginPlanConstruction
  • cameraBehaviourChanged
  • cancelComponentSelection
  • cancelDockings
  • cancelPlanElementSelection
  • cancelPreviousDockings
  • changeEnvironmentMapIntensity
  • changeExteriorWallsMaterial
  • changeFloorMaterial
  • changeFloorsMaterial
  • changeInteriorWallsMaterial
  • changeOffset
  • cleanUp
  • clearScene
  • componentDeleted
  • componentUpdated
  • configurationLoaded
  • debugScene
  • debugSceneGraph
  • deletePlanElementByIds
  • deletePlanElementSelection
  • destroy
  • disableAdvancedDocking
  • disableConfiguratorEvents
  • disableEvents
  • disableMeasurementLineDrawing
  • disablePlannerEvents
  • disableRotation
  • disableShowChildrenOfPlanObject
  • disableSnapping
  • disableWallDrawing
  • display
  • dragIn
  • enableAdvancedDocking
  • enableConfiguratorEvents
  • enableDragIn
  • enableEvents
  • enableHD
  • enableMeasurementLineDrawing
  • enablePlannerEvents
  • enableRotation
  • enableShowChildrenOfPlanObject
  • enableSnapping
  • enableWallDrawing
  • endPlanConstruction
  • escapeDrawing
  • exportCanvasScreenshot
  • exportGLB
  • exportImageFromCamera
  • getBounds
  • getCameraOffset
  • getCameraParameters3d
  • getComponent
  • getGeometryBounds
  • getObjectComponent
  • getOrthographicOffsetCamera
  • getPlanObject
  • getPlannerSceneEventHandler
  • getRootPlanObjectId
  • getScene
  • getScreenXY
  • getSelectedRuntimeComponentIds
  • getWallAngleDegrees
  • handleEvent
  • handlerSwitchedPlans
  • hideDimensions
  • highlightExternalObject
  • highlightParts
  • highlightPlanElementById
  • highlightPlanElementsById
  • importGLB
  • loadDynamicLightSetting
  • loadEnvMap
  • loadSceneSettings
  • loadStaticPlanObjects
  • lockCamera
  • moveCamera
  • moveElementPosition
  • moveElementsPosition
  • pause
  • planBoundsChanged
  • planCleared
  • planCompletelyLoaded
  • planElementChanged
  • planElementRemoved
  • planHistoryStateChanged
  • planObjectConfigurationChanged
  • planObjectConfigurationLoaded
  • planObjectConstructionDone
  • planObjectUpdated
  • planXMLLoaded
  • preload
  • preparePartImage
  • preparePerspectiveImage
  • preparePerspectiveImageOf
  • prepareTopImage
  • previewConstructionDone
  • removeEventListener
  • removePlanObjectFromScene
  • renderImage
  • requestCatalogItem
  • requestDeleteSelectedComponent
  • requestDockingsPreview
  • resetCameraPositionToStart
  • resetConfiguratorContext
  • resetPreviews
  • resume
  • rotatePlanElementSelection
  • saveConfigToIdb
  • sceneChanged
  • sceneCleared
  • selectComponent
  • selectPlanObject
  • setBackgroundColor
  • setBackgroundImage
  • setCameraOffset
  • setCompletelyLoaded
  • setEnvironmentMap
  • setMeasurementLineLength
  • setMode
  • setObjectToWallMeasurementLength
  • setSceneEvents
  • setSelectionMode
  • setWallMeasurementLength
  • showDimensions
  • showGUI
  • showStats
  • showsChildrenOfPlanObject
  • startConfiguring
  • startViewing
  • startedDrawing
  • stoppedDrawing
  • switchTo2D
  • switchTo3D
  • switchToFirstPerson
  • toggleConfigureInRoom
  • unlockCamera
  • updateCamera
  • updateCameraOnDrawWalls
  • updateScene
  • waitForMaterialQueue
  • zoomIn
  • zoomOut
  1. Rubens SDK
  2. Rubens SDK Reference
  3. Classes

RoomlePlanner.Internal.default

PreviousRoomlePlanner.Internal.default-9NextRoomlePlanner.default

Last updated 28 days ago

..default

Hierarchy

  • ↳ default

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new default(creator, offset, plannerCallback, mode)

Parameters

Name
Type

creator

string

offset

plannerCallback

mode

Overrides

Properties

_creator_

• _creator_: string

Inherited from


currentSelection

Accessors

configuratorContext

Returns


hasSingleRoom

• get hasSingleRoom(): boolean

Returns

boolean

Methods

_preparePerspectiveImage

Parameters

Name
Type

options

isolationMode?

boolean

Returns


addComponentHandlers

â–¸ addComponentHandlers(component): void

Parameters

Name
Type

component

Returns

void

Inherited from


addEventListener

â–¸ addEventListener(_listener): void

Parameters

Name
Type

_listener

Returns

void

Inherited from


addMesh

â–¸ addMesh(_planElement, _material, _vertices, _indices, _uvCoords, _normals): void

Parameters

Name
Type

_planElement

_material

any

_vertices

Float32Array

_indices

Int32Array

_uvCoords

Float32Array

_normals

Float32Array

Returns

void

Implementation of


addPlanMesh

â–¸ addPlanMesh(_plan, _material, _vertices, _indices, _uvCoords, _normals, _type): void

Parameters

Name
Type

_plan

_material

any

_vertices

Float32Array

_indices

Int32Array

_uvCoords

Float32Array

_normals

Float32Array

_type

Returns

void

Implementation of


addPlanObjectToScene

â–¸ addPlanObjectToScene(planViewModel): Promise<void>

Parameters

Name
Type

planViewModel

Returns

Promise<void>

Implementation of


addPreviewHandlers

â–¸ addPreviewHandlers(previewComponent): void

Parameters

Name
Type

previewComponent

Returns

void

Inherited from


addPreviewLineHandlers

â–¸ addPreviewLineHandlers(previewLineComponent): void

Parameters

Name
Type

previewLineComponent

Returns

void

Inherited from


animateElement

â–¸ animateElement(elementId, parameterName, value, applyToChildren, animate): void

Parameters

Name
Type

elementId

number

parameterName

string

value

string

applyToChildren

boolean

animate

boolean

Returns

void

Inherited from


backToPlanner

â–¸ backToPlanner(): void

Returns

void


beginPlanConstruction

â–¸ beginPlanConstruction(_plan): void

Parameters

Name
Type

_plan

Returns

void

Implementation of


cameraBehaviourChanged

â–¸ cameraBehaviourChanged(): void

Returns

void

Overrides


cancelComponentSelection

â–¸ cancelComponentSelection(resetCamera?, reason?): void

Parameters

Name
Type

resetCamera?

boolean

reason?

Returns

void

Inherited from


cancelDockings

â–¸ cancelDockings(): void

Returns

void

Inherited from


cancelPlanElementSelection

â–¸ cancelPlanElementSelection(reason): void

Parameters

Name
Type

reason

Returns

void


cancelPreviousDockings

â–¸ cancelPreviousDockings(): void

Returns

void

Inherited from


changeEnvironmentMapIntensity

â–¸ changeEnvironmentMapIntensity(intensity): void

Parameters

Name
Type

intensity

number

Returns

void

Inherited from


changeExteriorWallsMaterial

â–¸ changeExteriorWallsMaterial(material): void

Parameters

Name
Type

material

Returns

void


changeFloorMaterial

â–¸ changeFloorMaterial(material): Promise<void>

Parameters

Name
Type

material

Returns

Promise<void>

Inherited from


changeFloorsMaterial

â–¸ changeFloorsMaterial(material): void

Parameters

Name
Type

material

Returns

void


changeInteriorWallsMaterial

â–¸ changeInteriorWallsMaterial(material): void

Parameters

Name
Type

material

Returns

void


changeOffset

â–¸ changeOffset(offset): void

Parameters

Name
Type

offset

Returns

void

Inherited from


cleanUp

â–¸ cleanUp(): void

Returns

void

Inherited from


clearScene

â–¸ clearScene(): void

Returns

void

Overrides


componentDeleted

â–¸ componentDeleted(component): void

Parameters

Name
Type

component

Returns

void

Inherited from


componentUpdated

â–¸ componentUpdated(component, _kernelComponent): void

Parameters

Name
Type

component

_kernelComponent

Returns

void

Inherited from


configurationLoaded

â–¸ configurationLoaded(component, isFreeFlying): void

Parameters

Name
Type

component

isFreeFlying

boolean

Returns

void

Inherited from


debugScene

â–¸ debugScene(): Scene

Returns

Scene

Inherited from


debugSceneGraph

â–¸ debugSceneGraph(id?): void

Parameters

Name
Type

id?

number

Returns

void

Inherited from


deletePlanElementByIds

â–¸ deletePlanElementByIds(runtimeIds): Promise<void>

Parameters

Name
Type

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


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

Name
Type

planElementViewModel

Returns

void


disableSnapping

â–¸ disableSnapping(): void

Returns

void


disableWallDrawing

â–¸ disableWallDrawing(): void

Returns

void


display

â–¸ display(component): void

Parameters

Name
Type

component

Returns

void

Inherited from


dragIn

â–¸ dragIn(dragEvent): void

Parameters

Name
Type

dragEvent

DragEvent

Returns

void


enableAdvancedDocking

â–¸ enableAdvancedDocking(): void

Returns

void


enableConfiguratorEvents

â–¸ enableConfiguratorEvents(): void

Returns

void

Inherited from


enableDragIn

â–¸ enableDragIn(dragEvent): void

Parameters

Name
Type

dragEvent

DragEvent

Returns

void

Inherited from


enableEvents

â–¸ enableEvents(): void

Returns

void

Overrides


enableHD

â–¸ enableHD(source?): void

Parameters

Name
Type

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

Name
Type

planElementViewModel

Returns

void


enableSnapping

â–¸ enableSnapping(): void

Returns

void


enableWallDrawing

â–¸ enableWallDrawing(): void

Returns

void


endPlanConstruction

â–¸ endPlanConstruction(_plan): void

Parameters

Name
Type

_plan

Returns

void

Implementation of


escapeDrawing

â–¸ escapeDrawing(cancelDrawing): void

Parameters

Name
Type

cancelDrawing

boolean

Returns

void


exportCanvasScreenshot

â–¸ exportCanvasScreenshot(quality?): Promise<string>

Parameters

Name
Type
Default value

quality

number

1

Returns

Promise<string>

Inherited from


exportGLB

â–¸ exportGLB(_exportObjects?, _id?): void

Parameters

Name
Type

_exportObjects?

Object3D<Object3DEventMap>[]

_id?

string

Returns

void


exportImageFromCamera

â–¸ exportImageFromCamera(filename, shouldWaitForAssets?): Promise<void>

Parameters

Name
Type
Default value

filename

string

undefined

shouldWaitForAssets

boolean

false

Returns

Promise<void>

Inherited from


getBounds

â–¸ getBounds(): Box3

Returns

Box3

Overrides


getCameraOffset

Returns

Inherited from


getCameraParameters3d

Returns


getComponent

Parameters

Name
Type

componentRuntimeId

number

Returns

Inherited from


getGeometryBounds

â–¸ getGeometryBounds(): Box3

Returns

Box3

Overrides


getObjectComponent

Parameters

Name
Type

id

number

Returns


getOrthographicOffsetCamera

Returns

Inherited from


getPlanObject

Parameters

Name
Type

id

number

Returns


getPlannerSceneEventHandler

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

id

number

Returns

number


getScene

â–¸ getScene(): Scene

Returns

Scene

Inherited from


getScreenXY

â–¸ getScreenXY(position): Vector3

Parameters

Name
Type

position

Vector3

Returns

Vector3

Inherited from


getSelectedRuntimeComponentIds

â–¸ getSelectedRuntimeComponentIds(): number[]

Returns

number[]

Inherited from


getWallAngleDegrees

â–¸ getWallAngleDegrees(wall): number

Parameters

Name
Type

wall

Returns

number


handleEvent

â–¸ handleEvent(evt): void

Parameters

Name
Type

evt

Event

Returns

void

Inherited from


handlerSwitchedPlans

â–¸ handlerSwitchedPlans(fromPlan, toPlan): void

Parameters

Name
Type

fromPlan

toPlan

Returns

void

Implementation of


hideDimensions

â–¸ hideDimensions(): void

Returns

void

Inherited from


highlightExternalObject

â–¸ highlightExternalObject(planObjectComponent): void

Parameters

Name
Type

planObjectComponent

Returns

void


highlightParts

â–¸ highlightParts(ids): void

Parameters

Name
Type

ids

number[]

Returns

void

Inherited from


highlightPlanElementById

â–¸ highlightPlanElementById(runtimeId): void

Parameters

Name
Type

runtimeId

number

Returns

void


highlightPlanElementsById

â–¸ highlightPlanElementsById(runtimeIds): void

Parameters

Name
Type

runtimeIds

number[]

Returns

void


importGLB

â–¸ importGLB(url): void

Parameters

Name
Type

url

string

Returns

void


loadDynamicLightSetting

â–¸ loadDynamicLightSetting(source): Promise<void>

Parameters

Name
Type

source

Returns

Promise<void>

Inherited from


loadEnvMap

â–¸ loadEnvMap(url): Promise<void>

Parameters

Name
Type

url

string

Returns

Promise<void>

Inherited from


loadSceneSettings

â–¸ loadSceneSettings(sceneSetting): Promise<void>

Parameters

Name
Type

sceneSetting

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

cameraParameter

Returns

Promise<void>

Overrides


moveElementPosition

â–¸ moveElementPosition(selectedElement, position): void

Parameters

Name
Type

selectedElement

position

Returns

void


moveElementsPosition

â–¸ moveElementsPosition(selectedElements, position): void

Parameters

Name
Type

selectedElements

position

Returns

void


pause

â–¸ pause(): void

Returns

void

Inherited from


planBoundsChanged

â–¸ planBoundsChanged(): void

Returns

void

Implementation of


planCleared

â–¸ planCleared(): void

Returns

void

Implementation of


planCompletelyLoaded

â–¸ planCompletelyLoaded(_plan): void

Parameters

Name
Type

_plan

Returns

void

Implementation of


planElementChanged

â–¸ planElementChanged(_plan, planElementViewModel): void

Parameters

Name
Type

_plan

planElementViewModel

Returns

void

Implementation of


planElementRemoved

â–¸ planElementRemoved(element): void

Parameters

Name
Type

element

Returns

void

Implementation of


planHistoryStateChanged

â–¸ planHistoryStateChanged(): void

Returns

void

Implementation of


planObjectConfigurationChanged

â–¸ planObjectConfigurationChanged(plan, element): Promise<void>

Parameters

Name
Type

plan

element

Returns

Promise<void>

Implementation of


planObjectConfigurationLoaded

â–¸ planObjectConfigurationLoaded(plan, element, success): void

Parameters

Name
Type

plan

element

success

boolean

Returns

void

Implementation of


planObjectConstructionDone

â–¸ planObjectConstructionDone(_planObject): void

Parameters

Name
Type

_planObject

Returns

void

Inherited from


planObjectUpdated

â–¸ planObjectUpdated(planObject, geometryChanged, pendingDocking): void

Parameters

Name
Type

planObject

geometryChanged

boolean

pendingDocking

boolean

Returns

void

Inherited from


planXMLLoaded

â–¸ planXMLLoaded(plan): void

Parameters

Name
Type

plan

Returns

void


preload

â–¸ preload(id): void

Parameters

Name
Type

id

string

Returns

void


preparePartImage

â–¸ preparePartImage(partId, options): Promise<any>

Parameters

Name
Type

partId

number

options

Returns

Promise<any>

Inherited from


preparePerspectiveImage

Parameters

Name
Type

options

isolationMode?

boolean

Returns

Overrides


preparePerspectiveImageOf

Parameters

Name
Type

runtimeId

number

options

Returns


prepareTopImage

Parameters

Name
Type

options

isolationMode?

boolean

Returns

Overrides


previewConstructionDone

â–¸ previewConstructionDone(_component, hasPreviews): void

Parameters

Name
Type

_component

hasPreviews

boolean

Returns

void

Inherited from


removeEventListener

â–¸ removeEventListener(_listener): void

Parameters

Name
Type

_listener

Returns

void

Inherited from


removePlanObjectFromScene

â–¸ removePlanObjectFromScene(planViewModel): void

Parameters

Name
Type

planViewModel

Returns

void

Implementation of


renderImage

Parameters

Name
Type

renderOptions

Partial<{ useCurrentPerspective: boolean = false }>

Returns

Inherited from


requestCatalogItem

â–¸ requestCatalogItem(catalogItemId): void

Parameters

Name
Type

catalogItemId

string

Returns

void

Implementation of


requestDeleteSelectedComponent

â–¸ requestDeleteSelectedComponent(): void

Returns

void

Inherited from


requestDockingsPreview

â–¸ requestDockingsPreview(userInitiated, possibleChild?, dragEvent?, dragIn?): void

Parameters

Name
Type

userInitiated

boolean

possibleChild?

dragEvent?

DragEvent

dragIn?

boolean

Returns

void

Inherited from


resetCameraPositionToStart

â–¸ resetCameraPositionToStart(): void

Returns

void

Overrides


resetConfiguratorContext

â–¸ resetConfiguratorContext(reason): void

Parameters

Name
Type

reason

Returns

void


resetPreviews

â–¸ resetPreviews(): void

Returns

void

Inherited from


resume

â–¸ resume(): void

Returns

void

Inherited from


rotatePlanElementSelection

â–¸ rotatePlanElementSelection(rotateBy): void

Parameters

Name
Type

rotateBy

number

Returns

void


saveConfigToIdb

â–¸ saveConfigToIdb(): void

Returns

void

Inherited from


sceneChanged

â–¸ sceneChanged(): void

Returns

void

Overrides


sceneCleared

â–¸ sceneCleared(shouldHardReset): void

Parameters

Name
Type

shouldHardReset

boolean

Returns

void

Inherited from


selectComponent

â–¸ selectComponent(runtimeId, triggerClickCallback?): void

Parameters

Name
Type
Default value

runtimeId

number

undefined

triggerClickCallback

boolean

true

Returns

void

Inherited from


selectPlanObject

â–¸ selectPlanObject(runtimeId): Promise<void>

Parameters

Name
Type

runtimeId

number

Returns

Promise<void>


setBackgroundColor

â–¸ setBackgroundColor(hex): void

Parameters

Name
Type

hex

string

Returns

void

Inherited from


setBackgroundImage

â–¸ setBackgroundImage(url): void

Parameters

Name
Type

url

string

Returns

void

Inherited from


setCameraOffset

â–¸ setCameraOffset(offset): void

Parameters

Name
Type

offset

Returns

void

Inherited from


setCompletelyLoaded

â–¸ setCompletelyLoaded(completelyLoaded): void

Parameters

Name
Type

completelyLoaded

boolean

Returns

void


setEnvironmentMap

â–¸ setEnvironmentMap(url?, intensity?, rotation?, maxLightSources?): void

Parameters

Name
Type

url?

string

intensity?

number

rotation?

number

maxLightSources?

number

Returns

void

Inherited from


setMeasurementLineLength

â–¸ setMeasurementLineLength(measurementId, length, wallDirection): void

Parameters

Name
Type

measurementId

number

length

number

wallDirection

string

Returns

void


setMode

â–¸ setMode(mode): void

Parameters

Name
Type

mode

Returns

void


setObjectToWallMeasurementLength

â–¸ setObjectToWallMeasurementLength(planElementId, measurementId, length): void

Parameters

Name
Type

planElementId

number

measurementId

number

length

number

Returns

void


setSceneEvents

â–¸ setSceneEvents(sceneEvents): void

Parameters

Name
Type

sceneEvents

Returns

void


setSelectionMode

â–¸ setSelectionMode(mode): void

Parameters

Name
Type

mode

Returns

void

Inherited from


setWallMeasurementLength

â–¸ setWallMeasurementLength(measurementId, length, wallDirection): void

Parameters

Name
Type

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

Name
Type

planElementViewModel

Returns

boolean


startConfiguring

â–¸ startConfiguring(): void

Returns

void


startViewing

â–¸ startViewing(): void

Returns

void


startedDrawing

â–¸ startedDrawing(): void

called by kernel

Returns

void

Implementation of


stoppedDrawing

â–¸ stoppedDrawing(): void

called by kernel

Returns

void

Implementation of


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

_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

Name
Type

value?

number

Returns

void

Inherited from


zoomOut

â–¸ zoomOut(value?): void

Parameters

Name
Type

value?

number

Returns

void

Inherited from

<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>

.

.

• currentSelection: = null

• get configuratorContext():

â–¸ _preparePerspectiveImage(options?, isolationMode?): Promise<>

Promise<>

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

â–¸ getCameraOffset():

.

â–¸ getCameraParameters3d():

â–¸ getComponent(componentRuntimeId):

.

.

â–¸ getObjectComponent(id):

â–¸ getOrthographicOffsetCamera():

.

â–¸ getPlanObject(id):

â–¸ getPlannerSceneEventHandler():

.

.

.

.

.

.

.

.

.

.

.

.

[]

.

.

.

.

.

.

.

.

.

.

.

.

â–¸ preparePerspectiveImage(options?, isolationMode?): Promise<>

Promise<>

.

â–¸ preparePerspectiveImageOf(runtimeId, options?): Promise<>

Promise<>

â–¸ prepareTopImage(options?, isolationMode?): Promise<>

Promise<>

.

.

.

.

â–¸ renderImage(renderOptions): Promise<>

Promise<>

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

<{ CAMERA_2D: "2D" = '2D'; CAMERA_3D: "3D" = '3D'; CAMERA_FP: "FP" = 'FP' }>

.

.

.

.

.

.

.

.

.

.

.

.

SelectionPayload
default
default
Base64Image
Base64Image
CanvasOffset
CanvasOffset
CameraParameter
CameraParameter
KernelComponent
KernelComponent
KernelPlanObjectComponent
KernelPlanObjectComponent
OrthographicOffsetCamera
OrthographicOffsetCamera
KernelPlanObject
KernelPlanObject
default
default
Base64Image
Base64Image
Base64Image
Base64Image
Base64Image
Base64Image
Base64Image
Base64Image
planner-core/src/roomle-planner
internal
default
PlannerKernelCallbackI
constructor
_creator_
currentSelection
configuratorContext
hasSingleRoom
_preparePerspectiveImage
addComponentHandlers
addEventListener
addMesh
addPlanMesh
addPlanObjectToScene
addPreviewHandlers
addPreviewLineHandlers
animateElement
backToPlanner
beginPlanConstruction
cameraBehaviourChanged
cancelComponentSelection
cancelDockings
cancelPlanElementSelection
cancelPreviousDockings
changeEnvironmentMapIntensity
changeExteriorWallsMaterial
changeFloorMaterial
changeFloorsMaterial
changeInteriorWallsMaterial
changeOffset
cleanUp
clearScene
componentDeleted
componentUpdated
configurationLoaded
debugScene
debugSceneGraph
deletePlanElementByIds
deletePlanElementSelection
destroy
disableAdvancedDocking
disableConfiguratorEvents
disableEvents
disableMeasurementLineDrawing
disablePlannerEvents
disableRotation
disableShowChildrenOfPlanObject
disableSnapping
disableWallDrawing
display
dragIn
enableAdvancedDocking
enableConfiguratorEvents
enableDragIn
enableEvents
enableHD
enableMeasurementLineDrawing
enablePlannerEvents
enableRotation
enableShowChildrenOfPlanObject
enableSnapping
enableWallDrawing
endPlanConstruction
escapeDrawing
exportCanvasScreenshot
exportGLB
exportImageFromCamera
getBounds
getCameraOffset
getCameraParameters3d
getComponent
getGeometryBounds
getObjectComponent
getOrthographicOffsetCamera
getPlanObject
getPlannerSceneEventHandler
getRootPlanObjectId
getScene
getScreenXY
getSelectedRuntimeComponentIds
getWallAngleDegrees
handleEvent
handlerSwitchedPlans
hideDimensions
highlightExternalObject
highlightParts
highlightPlanElementById
highlightPlanElementsById
importGLB
loadDynamicLightSetting
loadEnvMap
loadSceneSettings
loadStaticPlanObjects
lockCamera
moveCamera
moveElementPosition
moveElementsPosition
pause
planBoundsChanged
planCleared
planCompletelyLoaded
planElementChanged
planElementRemoved
planHistoryStateChanged
planObjectConfigurationChanged
planObjectConfigurationLoaded
planObjectConstructionDone
planObjectUpdated
planXMLLoaded
preload
preparePartImage
preparePerspectiveImage
preparePerspectiveImageOf
prepareTopImage
previewConstructionDone
removeEventListener
removePlanObjectFromScene
renderImage
requestCatalogItem
requestDeleteSelectedComponent
requestDockingsPreview
resetCameraPositionToStart
resetConfiguratorContext
resetPreviews
resume
rotatePlanElementSelection
saveConfigToIdb
sceneChanged
sceneCleared
selectComponent
selectPlanObject
setBackgroundColor
setBackgroundImage
setCameraOffset
setCompletelyLoaded
setEnvironmentMap
setMeasurementLineLength
setMode
setObjectToWallMeasurementLength
setSceneEvents
setSelectionMode
setWallMeasurementLength
showDimensions
showGUI
showStats
showsChildrenOfPlanObject
startConfiguring
startViewing
startedDrawing
stoppedDrawing
switchTo2D
switchTo3D
switchToFirstPerson
toggleConfigureInRoom
unlockCamera
updateCamera
updateCameraOnDrawWalls
updateScene
waitForMaterialQueue
zoomIn
zoomOut
CanvasOffset
RoomlePlannerCallback
PrepareImageOptionsPlanner
RoomleComponent
LifeCycleCallbacks
PlanElement
Plan
KernelEnum
default
PreviewComponent
PreviewLineComponent
Plan
BatchPaintMaterial
RapiMaterial
BatchPaintMaterial
BatchPaintMaterial
CanvasOffset
RoomleComponent
RoomleComponent
KernelComponent
RoomleComponent
default
RoomleComponent
DynamicLightSettingSource
default
Plan
default
Plan
Plan
KernelPlanObjectComponent
DynamicLightSettingSource
SceneSettings
CameraParameter
default
KernelVector3
default
KernelVector3
Plan
Plan
default
PlanElement
Plan
default
Plan
PlanElement
PlanObject
PlanObject
Plan
PrepareImageOptions
PrepareImageOptions
PrepareImageOptions
PrepareImageOptions
RoomleComponent
LifeCycleCallbacks
default
UiPossibleChild
CanvasOffset
SceneEvents
SELECTION_MODE
EMSConstant
default
PlannerKernelCallbackI
addMesh
PlannerKernelCallbackI
addPlanMesh
PlannerKernelCallbackI
addPlanObjectToScene
PlannerKernelCallbackI
beginPlanConstruction
PlannerKernelCallbackI
endPlanConstruction
PlannerKernelCallbackI
handlerSwitchedPlans
PlannerKernelCallbackI
planBoundsChanged
PlannerKernelCallbackI
planCleared
PlannerKernelCallbackI
planCompletelyLoaded
PlannerKernelCallbackI
planElementChanged
PlannerKernelCallbackI
planElementRemoved
PlannerKernelCallbackI
planHistoryStateChanged
PlannerKernelCallbackI
planObjectConfigurationChanged
PlannerKernelCallbackI
planObjectConfigurationLoaded
PlannerKernelCallbackI
removePlanObjectFromScene
PlannerKernelCallbackI
requestCatalogItem
PlannerKernelCallbackI
startedDrawing
PlannerKernelCallbackI
stoppedDrawing
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
default
Enumify
Enumify
CancelSelectionReasons
CancelSelectionReasons
CancelSelectionReasons
constructor
creator
addComponentHandlers
addEventListener
addPreviewHandlers
addPreviewLineHandlers
animateElement
cameraBehaviourChanged
cancelComponentSelection
cancelDockings
cancelPreviousDockings
changeEnvironmentMapIntensity
changeFloorMaterial
changeOffset
cleanUp
clearScene
componentDeleted
componentUpdated
configurationLoaded
debugScene
debugSceneGraph
destroy
disableConfiguratorEvents
disableEvents
display
enableConfiguratorEvents
enableDragIn
enableEvents
enableHD
exportCanvasScreenshot
exportImageFromCamera
getBounds
getCameraOffset
getComponent
getGeometryBounds
getOrthographicOffsetCamera
getScene
getScreenXY
getSelectedRuntimeComponentIds
handleEvent
hideDimensions
highlightParts
loadDynamicLightSetting
loadEnvMap
loadSceneSettings
lockCamera
moveCamera
pause
planObjectConstructionDone
planObjectUpdated
preparePartImage
preparePerspectiveImage
prepareTopImage
previewConstructionDone
removeEventListener
renderImage
requestDeleteSelectedComponent
requestDockingsPreview
resetCameraPositionToStart
resetPreviews
resume
saveConfigToIdb
sceneChanged
sceneCleared
selectComponent
setBackgroundColor
setBackgroundImage
setCameraOffset
setEnvironmentMap
setSelectionMode
showDimensions
showGUI
showStats
unlockCamera
updateCamera
updateScene
waitForMaterialQueue
zoomIn
zoomOut