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
  • Type parameters
  • Implements
  • Table of contents
  • Constructors
  • Properties
  • Accessors
  • Methods
  • Constructors
  • constructor
  • Properties
  • _creator_
  • Accessors
  • PlannerCoreTypes
  • callbacks
  • hasSingleRoom
  • Methods
  • _selectExternalObjectGroup
  • _selectExternalObjectModule
  • addAtticToWall
  • back
  • backTo
  • backToPlanner
  • calcPartsPriceSum
  • cancelSelection
  • changeExteriorWallsMaterial
  • changeFloorsMaterial
  • changeInteriorWallsMaterial
  • configureExternalObjectApi
  • createNewSerializedConfiguration
  • createPlanFromObject
  • deleteSelection
  • disableAdvancedDocking
  • disableEvents
  • disableMeasurementLineDrawing
  • disableMultiselect
  • disableRotation
  • disableShowChildrenOfPlanObject
  • disableSnapping
  • disableWallDrawing
  • downloadHomagIxExportPoC
  • dragInObject
  • drawWalls
  • duplicateItems
  • enableAdvancedDocking
  • enableEvents
  • enableMeasurementLineDrawing
  • enableMultiselect
  • enableRotation
  • enableShowChildrenOfPlanObject
  • enableSnapping
  • enableWallDrawing
  • escapeDrawing
  • exportCanvasScreenshot
  • exportGLB
  • exportImageFromCamera
  • formatValueToUnitString
  • generateTCExport
  • getAttachedAttic
  • getCameraOffset
  • getConfigurator
  • getConfiguratorApi
  • getConfiguratorContext
  • getCurrentSkin
  • getExternalObjectGroups
  • getObjects
  • getPartlistOf
  • getPlanInteractionHandler
  • getPlanModelViewHelper
  • getPlanOverview
  • getPlanXmlFrom
  • getRuntimeComponentIdOfRootComponent
  • getScene
  • getStorage
  • getUnitFormatter
  • getWallAngleDegrees
  • hasWalls
  • highlightPlanElements
  • importGLB
  • init
  • insertItemList
  • insertItems
  • insertObject
  • isCurrentlyDrawing
  • isReady
  • loadError
  • loadExternalObjectGroup
  • loadExternalObjectLibrary
  • loadPlan
  • loadPlanXml
  • moveCamera
  • moveElementPosition
  • moveElementsPosition
  • onCloseHSC
  • openOrCloseGeometryOfExternalObject
  • preparePerspectiveImage
  • preparePerspectiveImageOf
  • prepareTopImage
  • removeAttic
  • removeElements
  • removeExternalObjectGroup
  • removeExternalObjectRootModule
  • renderImagesOfExternalObjectGroup
  • resetCameraPosition
  • resolveShortUrl
  • rotateSelection
  • saveCurrentPlanSnapshot
  • saveExternalObjectSnapshot
  • selectExternalObjectGroup
  • selectExternalObjectRootModule
  • selectExternalObjectSubModule
  • selectPlanObjectById
  • setAtticSide
  • setCameraOffset
  • setEnvironmentMap
  • setMeasurementLineLength
  • setObjectToWallMeasurementLength
  • setOverrides
  • setSceneEvents
  • setWallMeasurementLength
  • showBenchmarks
  • showGUI
  • showStats
  • showsChildrenOfPlanObject
  • startConfiguring
  • startViewing
  • swapObject
  • switch2D
  • switch3D
  • switchToConfigurator
  • switchToFirstPerson
  • switchToPlanner
  • switchToViewer
  • syncCatalog
  • toggleConfigureInRoom
  • update
  • updateAtticKneeHeight
  • updateAtticWidth
  • updateScene
  • updateSize
  1. Rubens SDK
  2. Rubens SDK Reference
  3. Classes

RoomlePlanner.default

PreviousRoomlePlanner.Internal.defaultNextRoomlePlannerUiCallback.default

Last updated 16 days ago

.default

Shared API between configurator and planner

Type parameters

Name
Type

P

Implements

  • <>

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new default<P>(creator, activePlugins?)

Type parameters

Name
Type

P

extends readonly "external-objects"[] = readonly []

Parameters

Name
Type

creator

string

activePlugins?

P

Properties

_creator_

• _creator_: string

Implementation of

Accessors

PlannerCoreTypes

Returns

an object which has all type constants from Roomle Core (C/C++)


callbacks

Returns

Implementation of

• set callbacks(callback): void

Parameters

Name
Type

callback

Returns

void

Implementation of


hasSingleRoom

• get hasSingleRoom(): boolean

Check if the 3D scene contains only one room

Returns

boolean

True if there is only one room, false otherwise

Methods

_selectExternalObjectGroup

â–¸ _selectExternalObjectGroup(groupId, switchToPlanner): Promise<void>

Parameters

Name
Type

groupId

string

switchToPlanner

boolean

Returns

Promise<void>


_selectExternalObjectModule

â–¸ _selectExternalObjectModule(rootModuleId, subModuleId, selectPlanObject, switchToConfigurator, selectComponent, highlightSelection): Promise<void>

Parameters

Name
Type

rootModuleId

string

subModuleId

string

selectPlanObject

boolean

switchToConfigurator

boolean

selectComponent

boolean

highlightSelection

boolean

Returns

Promise<void>


addAtticToWall

Creates a sloping roof attic on a given wall.

Parameters

Name
Type
Description

wall

The wall to add an attic to.

kneeHeight

number

Height of the attic knee wall.

width

number

Width of the sloping roof.

preferredSide?

The side where the attic should be added.

Returns

The newly created attic.


back

â–¸ back(): void

Returns

void


backTo

â–¸ backTo(_cssClass): void

Parameters

Name
Type

_cssClass

string

Returns

void


backToPlanner

â–¸ backToPlanner(): void

Returns

void


calcPartsPriceSum

Parameters

Name
Type

partList

Returns


cancelSelection

â–¸ cancelSelection(reason?): void

Parameters

Name
Type
Default value

reason

'unknown'

Returns

void

Implementation of

RoomlePlannerCallback.cancelSelection


changeExteriorWallsMaterial

â–¸ changeExteriorWallsMaterial(material): void

Parameters

Name
Type

material

Returns

void


changeFloorsMaterial

â–¸ changeFloorsMaterial(material): void

Parameters

Name
Type

material

Returns

void


changeInteriorWallsMaterial

â–¸ changeInteriorWallsMaterial(material): void

Parameters

Name
Type

material

Returns

void


configureExternalObjectApi

â–¸ configureExternalObjectApi(configurationJson): Promise<void>

With "configureExternalObjectApi" the default representation of the objects and UI and the default behavior when interacting with external objects can be completely or partially overwritten. This configuration should be set prior to loading plans or objects.

Parameters

Name
Type
Description

configurationJson

The configuration JSON as string or object.

Returns

Promise<void>

Implementation of


createNewSerializedConfiguration

â–¸ createNewSerializedConfiguration(configurationRuntimeId): Promise<string>

Parameters

Name
Type

configurationRuntimeId

number

Returns

Promise<string>


createPlanFromObject

â–¸ createPlanFromObject(id, position?, rotation?): Promise<number>

creates and loads a plan from a given object

Parameters

Name
Type
Description

id

string

position?

rotation?

number

return the object runtime id

Returns

Promise<number>


deleteSelection

â–¸ deleteSelection(): void

Returns

void

Implementation of

RoomlePlannerCallback.deleteSelection


disableAdvancedDocking

â–¸ disableAdvancedDocking(): void

disable docking of objects that fit together when objects are snapped in the plan

Returns

void


disableEvents

â–¸ disableEvents(): void

Returns

void


disableMeasurementLineDrawing

â–¸ disableMeasurementLineDrawing(): void

Returns

void


disableMultiselect

â–¸ disableMultiselect(): void

Disable the selection of multiple elements.

Returns

void


disableRotation

â–¸ disableRotation(): void

Disable rotation of selected elements

Returns

void


disableShowChildrenOfPlanObject

â–¸ disableShowChildrenOfPlanObject(planElementViewModel): void

disable interaction with child components of configurable objects in the plan

Parameters

Name
Type

planElementViewModel

Returns

void


disableSnapping

â–¸ disableSnapping(): void

disable all types of snapping

Returns

void


disableWallDrawing

â–¸ disableWallDrawing(): void

Returns

void


downloadHomagIxExportPoC

â–¸ downloadHomagIxExportPoC(): Promise<any>

Returns

Promise<any>


dragInObject

â–¸ dragInObject(idOrSerializedConfigString, dragEvent, type?): Promise<number>

Parameters

Name
Type
Default value

idOrSerializedConfigString

string

undefined

dragEvent

DragEvent

undefined

type

'rml_id'

Returns

Promise<number>


drawWalls

Draws walls according to the wall definitions this can be used to create a room on the fly

Parameters

Name
Type

wallDefinitions

interactionOptions

Returns


duplicateItems

Duplicates all planObjects in the array and inserts them into the current plan

Parameters

Name
Type
Description

itemList

Array of PlanObjects

Returns


enableAdvancedDocking

â–¸ enableAdvancedDocking(): void

enable docking of objects that fit together when objects are snapped in the plan

Returns

void


enableEvents

â–¸ enableEvents(): void

Returns

void


enableMeasurementLineDrawing

â–¸ enableMeasurementLineDrawing(): void

Returns

void


enableMultiselect

â–¸ enableMultiselect(): void

Enable the selection of multiple elements. Common parameters shared between those elements can then be changed at once

Returns

void

Implementation of


enableRotation

â–¸ enableRotation(): void

Enables rotation of selected elements

Returns

void


enableShowChildrenOfPlanObject

â–¸ enableShowChildrenOfPlanObject(planElementViewModel): void

enable interaction with child components of configurable objects in the plan

Parameters

Name
Type

planElementViewModel

Returns

void


enableSnapping

â–¸ enableSnapping(): void

enable snapping of object to object and object to wall

Returns

void


enableWallDrawing

â–¸ enableWallDrawing(): void

Returns

void


escapeDrawing

â–¸ escapeDrawing(cancelDrawing): void

Parameters

Name
Type

cancelDrawing

boolean

Returns

void


exportCanvasScreenshot

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

Parameters

Name
Type

quality?

number

Returns

Promise<string>

Implementation of


exportGLB

â–¸ exportGLB(): void

Returns

void


exportImageFromCamera

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

Parameters

Name
Type
Default value

filename

string

'image'

shouldWaitForAssets

boolean

false

Returns

Promise<void>

Implementation of


formatValueToUnitString

â–¸ formatValueToUnitString(value, parameter): string | number

Returns the formatted value based on the parameter.unitType

Parameters

Name
Type

value

number

parameter

Returns

string | number


generateTCExport

â–¸ generateTCExport(planObjectIds?): Promise<any>

Parameters

Name
Type
Default value

planObjectIds

string[]

[]

Returns

Promise<any>


getAttachedAttic

Gets the attached attic from a wall.

Parameters

Name
Type
Description

wall

The wall to retrieve the attic from.

Returns

The first attached attic or null.


getCameraOffset

Gets the available screen space for our item default: 'left: 0, top: 1, right: 1, bottom: 0'

Returns

Implementation of


getConfigurator

Returns


getConfiguratorApi

Returns


getConfiguratorContext

returns class containing configurator specific data properties

Returns


getCurrentSkin

Returns


getExternalObjectGroups

â–¸ getExternalObjectGroups(): Promise<object[]>

"getExternalObjectGroups" returns all groups of external objects modules (PosData) that are currently loaded in the plan.

Returns

Promise<object[]>

Implementation of


getObjects

returns all objects found in the current plan this includes info about size, rotation, id and parts

Returns


getPartlistOf

get the Partlist of certain runtimeID can be used if partlist of a selected Item is needed

Parameters

Name
Type
Description

id

number

runtimeID of a configurable item

Returns

kernelPartlist with processed price, currency and RAL colors


getPlanInteractionHandler

Returns


getPlanModelViewHelper

Returns


getPlanOverview

get all info available for the current plan, including objects, rooms and walls

Returns


getPlanXmlFrom

â–¸ getPlanXmlFrom(plan): any

Parameters

Name
Type

plan

Returns

any


getRuntimeComponentIdOfRootComponent

â–¸ getRuntimeComponentIdOfRootComponent(planObjectId): number

Returns the runtime component id of the plan object with the given id

Parameters

Name
Type
Description

planObjectId

number

id of the plan object you want to get the runtime component id of the root component from

Returns

number

number the number of the runtime id of the root component

Implementation of


getScene

â–¸ getScene(): Scene

Returns the three.js scene (https://threejs.org/docs/#api/en/scenes/Scene) WARNING: This is the actual scene (reference) and not a copy!

Returns

Scene

Implementation of


getStorage

returns manager class to interface with indexedDB storage

Returns

Implementation of


getUnitFormatter

returns unit formatter for formatting input und output values in scene

Returns

Implementation of


getWallAngleDegrees

â–¸ getWallAngleDegrees(wall): number

Returns the wall angle in degrees relative to the camera

Parameters

Name
Type
Description

wall

a WallPlanElementViewModel instance

Returns

number


hasWalls

â–¸ hasWalls(): boolean

Returns

boolean


highlightPlanElements

â–¸ highlightPlanElements(runtimeIds): void

Highlights one or more objects in the scene based on their runtime IDs. If runtimeIds is null, all highlighted objects will be unhighlighted.

Parameters

Name
Type
Description

runtimeIds

number | number[]

A single runtime ID, an array of runtime IDs, or null.

Returns

void


importGLB

â–¸ importGLB(url): void

Parameters

Name
Type

url

string

Returns

void


init

â–¸ init(element, preloadPlanId?, options?): Promise<void>

Parameters

Name
Type

element

HTMLElement

preloadPlanId?

string

options?

Returns

Promise<void>


insertItemList

â–¸ insertItemList(ids): Promise<number[]>

Parameters

Name
Type

ids

string[]

Returns

Promise<number[]>


insertItems

â–¸ insertItems(itemList): Promise<number[]>

Inserts all of the items in the array into current plan

Parameters

Name
Type
Description

itemList

Array of items received from the Roomle API

Returns

Promise<number[]>


insertObject

â–¸ insertObject(id, position?, rotation?): Promise<number>

Inserts the object into the scene (at a given position and rotation)

Parameters

Name
Type
Description

id

string

position?

x (left/right),y (up, down) and z(front, back) in meters

rotation?

number

in radians

Returns

Promise<number>


isCurrentlyDrawing

â–¸ isCurrentlyDrawing(): boolean

Returns

boolean


isReady

â–¸ isReady(): void

Returns

void

Implementation of


loadError

â–¸ loadError(error?): void

Parameters

Name
Type

error?

any

Returns

void

Implementation of


loadExternalObjectGroup

â–¸ loadExternalObjectGroup(groupData, findFreeSpaceInPlan, verifyArrangement?, mergedGroups?): Promise<void>

"loadExternalObjectGroup" loads a group of modules and places them in the plan. If the group has already been loaded, it is completely replaced by the new group. This function therefore has 2 use cases:

  1. Load a new group of modules

  2. Update or modify an existing group of modules The initial location of the group and the IDs of the modules are defined in the group JSON.

Parameters

Name
Type
Default value
Description

groupData

undefined

The group JSON as string or object.

findFreeSpaceInPlan

boolean

undefined

A free space is automatically searched for in the plane.

verifyArrangement

boolean

false

Verify whether the root modules of the group need to be rearranged as they have changed in size.

mergedGroups

string[]

[]

Groups that were merged into another group and have to be delete (this is required to generate correct undo/redo steps).

Returns

Promise<void>

Implementation of


loadExternalObjectLibrary

â–¸ loadExternalObjectLibrary(libraryJson): void

"loadExternalObjectLibrary" loads the master data of a library. If master data has already been loaded for the library, it is completely replaced by the new master data.

Parameters

Name
Type
Description

libraryJson

string | object

The library JSON as string or object.

Returns

void

Implementation of


loadPlan

Parameters

Name
Type

id

string

options?

Returns


loadPlanXml

â–¸ loadPlanXml(xml, options?): Promise<void>

Parameters

Name
Type

xml

string

options?

Returns

Promise<void>


moveCamera

â–¸ moveCamera(cameraParameter): Promise<void>

Parameters

Name
Type

cameraParameter

Returns

Promise<void>


moveElementPosition

â–¸ moveElementPosition(selectedElement, position): void

Move the current selected element in the 3D space

Parameters

Name
Type
Description

selectedElement

this is the current selected plan object

position

new KernelVector3 position of the current selected element returns runtime ID of the new object

Returns

void


moveElementsPosition

â–¸ moveElementsPosition(selectedElements, position): void

Moves the current multi-selected elements in the 3D space

Parameters

Name
Type
Description

selectedElements

this is the current selected plan object

position

new KernelVector3 position of the current selected element returns runtime ID of the new object

Returns

void


onCloseHSC

â–¸ onCloseHSC(): void

Returns

void


openOrCloseGeometryOfExternalObject

â–¸ openOrCloseGeometryOfExternalObject(groupIdOrRootModuleId, subModuleId, open, animate): Promise<void>

"openOrCloseGeometryOfExternalObject" switches the geometry of the modules between closed and open representation. The function can switch the geometry of the group or the singe root module with the ID "groupIdOrRootModuleId". If "groupIdOrRootModuleId" is the ID of a root module and the "subModuleId" is also specified, only this one sub-module is opened or closed.

Parameters

Name
Type
Description

groupIdOrRootModuleId

string

The ID of the group of modules or the ID of the root module.

subModuleId

string

The ID of the sub module.

open

boolean

If true, the modules are opened, if false, they are closed, if the geometry is already in the desired state, nothing happens.

animate

boolean

If true the opening or closing is animated else the geometry is switched instantly.

Returns

Promise<void>

Implementation of


preparePerspectiveImage

Generates a perspective image (slightly from the side) and returns it as base64

Parameters

Name
Type
Default value
Description

options

{}

isolationMode

boolean

false

defaults to false. Determines whether to generate a perspective image for the current configuration.

Returns


preparePerspectiveImageOf

Generates a perspective image (slightly from the side) of a plan element by a given runtime-id and returns it as base64

Parameters

Name
Type
Description

runtimeId

number

runtime-id of the plan element, e.g.: a selected element

options

PrepareImageOptions

Returns


prepareTopImage

Generates a top image (birds eye view) and returns it as base64

Parameters

Name
Type

options

Returns


removeAttic

â–¸ removeAttic(attic): void

Removes an attic from a wall.

Parameters

Name
Type
Description

attic

The attic to be removed.

Returns

void


removeElements

â–¸ removeElements(kernelPlanElements, interactionOptions?): Promise<void>

Parameters

Name
Type

kernelPlanElements

interactionOptions

Returns

Promise<void>


removeExternalObjectGroup

â–¸ removeExternalObjectGroup(groupId, wasMerged?): Promise<void>

"removeExternalObjectGroup" removes a group and all its modules from the plan.

Parameters

Name
Type
Default value
Description

groupId

string

undefined

The ID of the group of modules.

wasMerged

boolean

false

Should be set to true if the group has been merged with another group (this is required to generate correct undo/redo steps).

Returns

Promise<void>

Implementation of


removeExternalObjectRootModule

â–¸ removeExternalObjectRootModule(rootModuleId): void

"removeExternalObjectRootModule" removes a root module from a group and splits the remaining group if the removed root module is located between other root modules. If the group consists of only one root module, the group is removed.

Parameters

Name
Type

rootModuleId

string

Returns

void

Implementation of


renderImagesOfExternalObjectGroup

â–¸ renderImagesOfExternalObjectGroup(groups): Promise<{ [key: string]: string; }>

"renderImagesOfExternalObjectGroups" renders images of groups of modules.

Parameters

Name
Type

groups

object

Returns

Promise<{ [key: string]: string; }>

Implementation of


resetCameraPosition

â–¸ resetCameraPosition(): void

Returns

void

Implementation of


resolveShortUrl

â–¸ resolveShortUrl(shortUrl): Promise<string>

Resolves a shortened URL.

Parameters

Name
Type
Description

shortUrl

string

The shortened URL to resolve.

Returns

Promise<string>

  • A promise that resolves to the URL.


rotateSelection

â–¸ rotateSelection(rotateBy): void

rotates the selected item(s)

Parameters

Name
Type
Description

rotateBy

number

angle in rad

Returns

void

Implementation of

RoomlePlannerCallback.rotateSelection


saveCurrentPlanSnapshot

Parameters

Name
Type

parentPlanId?

string

configurationHashOrGroupId?

string | string[]

Returns


saveExternalObjectSnapshot

Saves a snapshot of the external objects in the plan without walls and other objects Also contains the urls to the glb and usdz files

Parameters

Name
Type
Description

parentPlanId?

string

id of the current plan, optional

Returns

the snapshot of the external objects if there are no external objects it returns null


selectExternalObjectGroup

â–¸ selectExternalObjectGroup(groupId): Promise<void>

"selectExternalObjectGroup" changes the selected object in the scene. The function selects a complete group of root modules and always switches to planning mode. If the group consists of only one root module, this is equivalent to selecting a single root module.

Parameters

Name
Type
Description

groupId

string

The ID of the group of modules.

Returns

Promise<void>

Implementation of


selectExternalObjectRootModule

â–¸ selectExternalObjectRootModule(rootModuleId): Promise<void>

"selectExternalObjectRootModule" changes the selected object in the scene. The function selects a root module within a group and always switches to planning mode.

Parameters

Name
Type
Description

rootModuleId

string

The ID of the root module.

Returns

Promise<void>

Implementation of


selectExternalObjectSubModule

â–¸ selectExternalObjectSubModule(rootModuleId, subModuleId): Promise<void>

"selectExternalObjectSubModule" changes the selected object in the scene. The function selects a sub module a root module and always switches to configuration mode.

Parameters

Name
Type
Description

rootModuleId

string

The ID of the root module.

subModuleId

string

The ID of the sub module.

Returns

Promise<void>

Implementation of


selectPlanObjectById

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

select an object in the scene based on its runtime id

Parameters

Name
Type

runtimeId

number

Returns

Promise<void>


setAtticSide

â–¸ setAtticSide(attic, side): void

Set the attic direction from a wall.

Parameters

Name
Type
Description

attic

The attic to be removed.

side

-

Returns

void


setCameraOffset

â–¸ setCameraOffset(offset): void

Sets the available screen space for our item Example 1: right 0.9 means 10% padding on the right side Example 2: bottom 0.2 means 20% padding on the bottom side default: 'left: 0, top: 1, right: 1, bottom: 0'

Parameters

Name
Type

offset

Returns

void

Implementation of


setEnvironmentMap

â–¸ setEnvironmentMap(params): void

Parameters

Name
Type

params

Object

params.intensity?

number

params.maxLightSources?

number

params.rotation?

number

params.url?

string

Returns

void

Implementation of


setMeasurementLineLength

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

Parameters

Name
Type

measurementId

number

length

number

wallDirection

string

Returns

void


setObjectToWallMeasurementLength

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

Parameters

Name
Type

planElementId

number

measurementId

number

length

number

Returns

void


setOverrides

â–¸ setOverrides(initData): void

Set general configuration parameter

Parameters

Name
Type

initData

Returns

void


setSceneEvents

â–¸ setSceneEvents(sceneEvents): void

set which events are enabled in the scene, for example disable selection of walls and wall nodes

Parameters

Name
Type

sceneEvents

Returns

void


setWallMeasurementLength

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

Parameters

Name
Type

measurementId

number

length

number

wallDirection

Returns

void


showBenchmarks

â–¸ showBenchmarks(): void

Returns

void


showGUI

â–¸ showGUI(): void

Returns

void


showStats

â–¸ showStats(): void

Returns

void


showsChildrenOfPlanObject

â–¸ showsChildrenOfPlanObject(planElementViewModel): boolean

returns true if interaction with the child components of a configuration object is enabled, and flashes otherwise

Parameters

Name
Type

planElementViewModel

Returns

boolean


startConfiguring

â–¸ startConfiguring(): void

Returns

void


startViewing

â–¸ startViewing(): void

Returns

void


swapObject

â–¸ swapObject(old, idOfNew): Promise<number>

Swap two plan objects in the scene in the same position for example swap two object variants

Parameters

Name
Type
Description

old

this is the current selected plan object

idOfNew

string

the RAPI id of the new plan object returns runtime ID of the new object

Returns

Promise<number>


switch2D

â–¸ switch2D(): void

Returns

void


switch3D

â–¸ switch3D(): void

Returns

void


switchToConfigurator

Returns

Implementation of

RoomlePlannerCallback.switchToConfigurator


switchToFirstPerson

â–¸ switchToFirstPerson(): void

Returns

void


switchToPlanner

â–¸ switchToPlanner(id?): void

Parameters

Name
Type

id?

string

Returns

void


switchToViewer

Returns

Implementation of

RoomlePlannerCallback.switchToViewer


syncCatalog

â–¸ syncCatalog(catalogId): Promise<void>

Parameters

Name
Type

catalogId

string

Returns

Promise<void>


toggleConfigureInRoom

â–¸ toggleConfigureInRoom(): void

Returns

void


update

â–¸ update(): void

Returns

void


updateAtticKneeHeight

â–¸ updateAtticKneeHeight(attic, kneeHeight): void

Updates the knee height of an attic.

Parameters

Name
Type
Description

attic

The attic to update.

kneeHeight

number

The new knee height value.

Returns

void


updateAtticWidth

â–¸ updateAtticWidth(attic, width): void

Updates the width of an attic.

Parameters

Name
Type
Description

attic

The attic to update.

width

number

The new width value.

Returns

void


updateScene

â–¸ updateScene(): void

Updates the scene (recalculating bounds) and restart rendering

Returns

void

Implementation of


updateSize

â–¸ updateSize(): void

Returns

void

Implementation of

extends readonly [] = readonly []

.

• get PlannerCoreTypes():

• get callbacks():

.

.

â–¸ addAtticToWall(wall, kneeHeight, width, preferredSide?):

â–¸ calcPartsPriceSum(partList): Promise<>

Promise<>

string |

.

â–¸ drawWalls(wallDefinitions, interactionOptions?): []

[]

[]

â–¸ duplicateItems(itemList): []

[]

[]

.

.

.

â–¸ getAttachedAttic(wall):

â–¸ getCameraOffset():

.

â–¸ getConfigurator():

â–¸ getConfiguratorApi(): <P>

<P>

â–¸ getConfiguratorContext():

â–¸ getCurrentSkin(): Promise<>

Promise<>

.

â–¸ getObjects(): Promise<[]>

Promise<[]>

â–¸ getPartlistOf(id): Promise<>

Promise<>

â–¸ getPlanInteractionHandler(): Promise<>

Promise<>

â–¸ getPlanModelViewHelper(): Promise<>

Promise<>

â–¸ getPlanOverview(): Promise<>

Promise<>

|

.

.

â–¸ getStorage():

.

â–¸ getUnitFormatter():

.

&

( | | `__ext__obj__#${string}` | )[]

.

.

.

.

â–¸ loadPlan(id, options?): Promise< | >

&

Promise< | >

&

[]

.

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

Promise<>

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

Promise<>

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

Promise<>

[]

.

.

.

.

â–¸ saveCurrentPlanSnapshot(parentPlanId?, configurationHashOrGroupId?): Promise<>

Promise<>

â–¸ saveExternalObjectSnapshot(parentPlanId?): Promise<>

Promise<>

.

.

.

.

.

&

â–¸ switchToConfigurator(): Promise<>

Promise<>

â–¸ switchToViewer(): Promise<>

Promise<>

.

.

planner-core/src/roomle-planner
KernelAccessCallbackI
RoomlePlannerCallback
GlobalAPI
Context
KernelUtilityForUi
ExternalEmbeddable
default
RubensAPI
ExternalObjectAPI
PlannerKernelContainer
PlannerKernelContainer
default
default
KernelAttic
KernelAttic
KernelPartListPrice
KernelPartListPrice
KernelWall
KernelWall
PlanObject
PlanObject
KernelAttic
KernelAttic
CanvasOffset
CanvasOffset
Configurator
Configurator
default
default
default
default
RapiSkin
RapiSkin
UiPlanObject
UiPlanObject
KernelPartList
KernelPartList
PlanInteractionHandler
PlanInteractionHandler
PlanModelViewHelper
PlanModelViewHelper
PlanOverview
PlanOverview
default
default
default
default
RapiPlan
RapiPlanSnapshotGetData
RapiPlan
RapiPlanSnapshotGetData
Base64Image
Base64Image
Base64Image
Base64Image
Base64Image
Base64Image
RapiPlanSnapshotGetData
RapiPlanSnapshotGetData
RapiPlanSnapshotGetDataWith3dUrls
RapiPlanSnapshotGetDataWith3dUrls
Configurator
Configurator
GlbViewer
GlbViewer
constructor
_creator_
PlannerCoreTypes
callbacks
hasSingleRoom
_selectExternalObjectGroup
_selectExternalObjectModule
addAtticToWall
back
backTo
backToPlanner
calcPartsPriceSum
cancelSelection
changeExteriorWallsMaterial
changeFloorsMaterial
changeInteriorWallsMaterial
configureExternalObjectApi
createNewSerializedConfiguration
createPlanFromObject
deleteSelection
disableAdvancedDocking
disableEvents
disableMeasurementLineDrawing
disableMultiselect
disableRotation
disableShowChildrenOfPlanObject
disableSnapping
disableWallDrawing
downloadHomagIxExportPoC
dragInObject
drawWalls
duplicateItems
enableAdvancedDocking
enableEvents
enableMeasurementLineDrawing
enableMultiselect
enableRotation
enableShowChildrenOfPlanObject
enableSnapping
enableWallDrawing
escapeDrawing
exportCanvasScreenshot
exportGLB
exportImageFromCamera
formatValueToUnitString
generateTCExport
getAttachedAttic
getCameraOffset
getConfigurator
getConfiguratorApi
getConfiguratorContext
getCurrentSkin
getExternalObjectGroups
getObjects
getPartlistOf
getPlanInteractionHandler
getPlanModelViewHelper
getPlanOverview
getPlanXmlFrom
getRuntimeComponentIdOfRootComponent
getScene
getStorage
getUnitFormatter
getWallAngleDegrees
hasWalls
highlightPlanElements
importGLB
init
insertItemList
insertItems
insertObject
isCurrentlyDrawing
isReady
loadError
loadExternalObjectGroup
loadExternalObjectLibrary
loadPlan
loadPlanXml
moveCamera
moveElementPosition
moveElementsPosition
onCloseHSC
openOrCloseGeometryOfExternalObject
preparePerspectiveImage
preparePerspectiveImageOf
prepareTopImage
removeAttic
removeElements
removeExternalObjectGroup
removeExternalObjectRootModule
renderImagesOfExternalObjectGroup
resetCameraPosition
resolveShortUrl
rotateSelection
saveCurrentPlanSnapshot
saveExternalObjectSnapshot
selectExternalObjectGroup
selectExternalObjectRootModule
selectExternalObjectSubModule
selectPlanObjectById
setAtticSide
setCameraOffset
setEnvironmentMap
setMeasurementLineLength
setObjectToWallMeasurementLength
setOverrides
setSceneEvents
setWallMeasurementLength
showBenchmarks
showGUI
showStats
showsChildrenOfPlanObject
startConfiguring
startViewing
swapObject
switch2D
switch3D
switchToConfigurator
switchToFirstPerson
switchToPlanner
switchToViewer
syncCatalog
toggleConfigureInRoom
update
updateAtticKneeHeight
updateAtticWidth
updateScene
updateSize
default
KernelWall
WallSide
KernelPartList
BatchPaintMaterial
BatchPaintMaterial
BatchPaintMaterial
ExternalObjectApiConfiguration
Position3
default
WallDefinition
InteractionOptions
PlanObject
default
KernelParameter
KernelWall
RapiPlan
RapiPlanSnapshotGetData
default
InitDataDefinition
GlobalInitDataDefinition
Position3
InitDataDefinition
GlobalInitDataDefinition
InitDataDefinition
GlobalInitDataDefinition
CameraParameter
default
KernelVector3
default
KernelVector3
PrepareImageOptions
PrepareImageOptions
PrepareImageOptions
KernelAttic
KernelObject
InteractionOptions
KernelAttic
WallSide
CanvasOffset
InitDataDefinition
GlobalInitDataDefinition
SceneEvents
EMSConstant
default
default
KernelAttic
KernelAttic
Context
ExternalEmbeddable
ExternalEmbeddable
ExternalObjectAPI
RubensAPI
RubensAPI
RubensAPI
GlobalAPI
ExternalObjectAPI
KernelUtilityForUi
GlobalAPI
RubensAPI
GlobalAPI
KernelAccessCallbackI
KernelAccessCallbackI
ExternalObjectAPI
ExternalObjectAPI
ExternalObjectAPI
ExternalObjectAPI
ExternalObjectAPI
ExternalObjectAPI
RubensAPI
ExternalObjectAPI
ExternalObjectAPI
ExternalObjectAPI
GlobalAPI
GlobalAPI
GlobalAPI
GlobalAPI
RapiItem
RapiConfiguration
enableMultiselect
exportCanvasScreenshot
exportImageFromCamera
getStorage
resetCameraPosition
configureExternalObjectApi
getExternalObjectGroups
loadExternalObjectGroup
loadExternalObjectLibrary
openOrCloseGeometryOfExternalObject
removeExternalObjectGroup
removeExternalObjectRootModule
renderImagesOfExternalObjectGroup
selectExternalObjectGroup
selectExternalObjectRootModule
selectExternalObjectSubModule
getRuntimeComponentIdOfRootComponent
callbacks
callbacks
creator
ExternalObject
ExternalGroupData
ID_TYPE
isReady
loadError
PluginName
CancelSelectionReasons
getCameraOffset
getScene
getUnitFormatter
setCameraOffset
setEnvironmentMap
updateScene
updateSize