Class AppController

Hierarchy

AppController

Implements

Index

Constructors

Accessors

buttonActionsInFullScreen instanceId searchAndBrowseMenuId ui

Methods

addScreenshotCameraType addToCart buildInitialHtml buttonActivateOnMenuClick closeIndividualStyleOnRenderClick createAppDesktopSideScreen createAppDrawer createAppModal createConfigInspirationController createControllers createCustomisationController createIndividualCustomisationController createListeners createLoadController createMenuController createNewProjectController createProductDetailController createRenderController createRunningTotalController createSearchAndBrowseController createShareController createUI createWebARController deleteProduct destroy downloadImageBase64 fullscreenScene getAllProducts getAnalyticsPlugin getProjectData getProjectDataFromCode getProjectFromTemplate getScreenshotCamera getTogglableUI getTotalBounds load loadInitialData onDeleteComplete onDrawerModeSet onDrawerToggled onExitCustomisation onExitFullscreen onMenuItemClick onMenuTypeClick onNewProject onProductAdded onRenderPlaceComplete onRotateComplete onSceneUpdate onSelectedProductsUpdated onSizeUpdate onStyleConfigureSelected onStyleNone onTabChange redoProjectAction reset rotateProductRight15 rotateSceneLeft rotateSceneRight run save screenshotPressed setAppTitleMenu setMenuId setMenuIdFromSavedProject setMenuIdInternal setupDesktopSidescreen setupDrawers setupRunningTotal showDebug showLoadScreen showNewProjectScreen showProductInfo showShareScreen startNewProject stop styleAllProducts styleProduct takeScreenshot toggleGlobalStyle toggleIndividualStyle toggleProjectDoors toggleProjectMeasurements undoProjectAction updateDesktopLayout updateLayout updateMobileLayout updateRunningTotalLocation viewSceneInAR zoomSceneIn zoomSceneOut

Constructors

constructor

new AppController(modConfOptions: MxtModularConfiguratorOptions): AppController
Parameters
- modConfOptions: MxtModularConfiguratorOptions
Returns AppController
- Defined in js/modularconfig/controllers/AppController.tsx:104

Properties

`Protected` allUIControllers

allUIControllers: IUIController<any>[] = []

`Protected` configInspirationController

configInspirationController: ConfigInspirationController

`Protected` debounceSelectedProductsUpdated

debounceSelectedProductsUpdated: (() => any) = ...

Type declaration

- (): any
- Delay repeated calls to func until timeout time has passed
  
  Returns
  a new proxy to func
  
  Returns any

`Protected` defaultScreen

defaultScreen: MenuType = MenuType.PRODUCT_BROWSE

`Protected` desktopSideScreen

desktopSideScreen: DesktopSideScreenUI

`Protected` disableAutoTabChange

disableAutoTabChange: boolean = false

`Protected` drawer

drawer: DrawerUI

`Protected` globalCustomisation

globalCustomisation: CustomisationController

`Protected` individualCustomisation

individualCustomisation: CustomisationController

`Private` landscapeMenuBar

landscapeMenuBar: RefObject<HTMLDivElement> = ...

`Protected` lastSelectedItems

lastSelectedItems: Composable[] = []

latestResponsivenessData

latestResponsivenessData: ResponsivenessData

`Protected` loadController

loadController: LoadProjectController

`Private` menu

menu: RefObject<any> = ...

`Protected` menuController

menuController: MenuController

`Protected` menuRouter

menuRouter: MenuRouter = ...

`Protected` modConfOptions

modConfOptions: MxtModularConfiguratorOptions

`Protected` modal

modal: ModalUI

`Protected` newProjectController

newProjectController: NewProjectController

`Protected` productDetailController

productDetailController: ProductDetailController

`Protected` renderController

renderController: RenderController

`Private` renderer

renderer: RefObject<HTMLDivElement> = ...

`Private` root

root: MultiScreenUI

`Protected` runningTotalController

runningTotalController: RunningTotalController

`Protected` searchAndBrowse

searchAndBrowse: SearchAndBrowseController

`Protected` shareController

shareController: ShareController

`Protected` webARController

webARController: WebARController

Accessors

`Protected` buttonActionsInFullScreen

get buttonActionsInFullScreen(): MenuAction[]
Returns MenuAction[]
- Defined in js/modularconfig/controllers/AppController.tsx:681

instanceId

get instanceId(): number
Returns number
Implementation of IAppControllerDelegate.instanceId
- Defined in js/modularconfig/controllers/AppController.tsx:117

searchAndBrowseMenuId

get searchAndBrowseMenuId(): string
Returns string
Implementation of IRenderControllerDelegate.searchAndBrowseMenuId
- Defined in js/modularconfig/controllers/AppController.tsx:349

ui

get ui(): IUIElement<{}>
Returns IUIElement<{}>
Implementation of IUIController.ui
- Defined in js/modularconfig/controllers/AppController.tsx:113

Methods

addScreenshotCameraType

addScreenshotCameraType(type: string, options: ScreenshotCameraOptions): void
Parameters
- type: string
- options: ScreenshotCameraOptions
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:689

addToCart

addToCart(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:892

buildInitialHtml

buildInitialHtml(): MultiScreenUI
Returns MultiScreenUI
- Defined in js/modularconfig/controllers/AppController.tsx:199

`Protected` buttonActivateOnMenuClick

buttonActivateOnMenuClick(type: MenuType, open: boolean): void
Parameters
- type: MenuType
- open: boolean
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:943

`Protected` closeIndividualStyleOnRenderClick

closeIndividualStyleOnRenderClick(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:783

`Protected` createAppDesktopSideScreen

createAppDesktopSideScreen(): DesktopSideScreenUI
Returns DesktopSideScreenUI
- Defined in js/modularconfig/controllers/AppController.tsx:1160

`Protected` createAppDrawer

createAppDrawer(): DrawerUI
Returns DrawerUI
- Defined in js/modularconfig/controllers/AppController.tsx:1157

`Protected` createAppModal

createAppModal(): ModalUI
Returns ModalUI
- Defined in js/modularconfig/controllers/AppController.tsx:1148

`Protected` createConfigInspirationController

createConfigInspirationController(): ConfigInspirationController
Returns ConfigInspirationController
- Defined in js/modularconfig/controllers/AppController.tsx:1144

createControllers

createControllers(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:135

`Protected` createCustomisationController

createCustomisationController(): CustomisationController
Returns CustomisationController
- Defined in js/modularconfig/controllers/AppController.tsx:1106

`Protected` createIndividualCustomisationController

createIndividualCustomisationController(): CustomisationController
Returns CustomisationController
- Defined in js/modularconfig/controllers/AppController.tsx:1117

createListeners

createListeners(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:178

`Protected` createLoadController

createLoadController(): LoadProjectController
Returns LoadProjectController
- Defined in js/modularconfig/controllers/AppController.tsx:1136

`Protected` createMenuController

createMenuController(): MenuController
Returns MenuController
- Defined in js/modularconfig/controllers/AppController.tsx:1124

`Protected` createNewProjectController

createNewProjectController(): NewProjectController
Returns NewProjectController
- Defined in js/modularconfig/controllers/AppController.tsx:1132

`Protected` createProductDetailController

createProductDetailController(): ProductDetailController
Returns ProductDetailController
- Defined in js/modularconfig/controllers/AppController.tsx:1086

`Protected` createRenderController

createRenderController(): RenderController
Returns RenderController
- Defined in js/modularconfig/controllers/AppController.tsx:1081

`Protected` createRunningTotalController

createRunningTotalController(showOnMobile: boolean, showOnDesktop: boolean): RunningTotalController
Parameters
- showOnMobile: boolean
- showOnDesktop: boolean
Returns RunningTotalController
- Defined in js/modularconfig/controllers/AppController.tsx:1102

`Protected` createSearchAndBrowseController

createSearchAndBrowseController(): SearchAndBrowseController
Returns SearchAndBrowseController
- Defined in js/modularconfig/controllers/AppController.tsx:1094

`Protected` createShareController

createShareController(): ShareController
Returns ShareController
- Defined in js/modularconfig/controllers/AppController.tsx:1128

createUI

createUI(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:162

`Protected` createWebARController

createWebARController(): WebARController
Returns WebARController
- Defined in js/modularconfig/controllers/AppController.tsx:1140

deleteProduct

deleteProduct(): Promise<boolean>
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/AppController.tsx:770

destroy

destroy(): void
Returns void
Implementation of IUIController.destroy
- Defined in js/modularconfig/controllers/AppController.tsx:591

`Protected` downloadImageBase64

downloadImageBase64(imageBase64: string): void
Parameters
- imageBase64: string
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1193

fullscreenScene

fullscreenScene(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:640

getAllProducts

getAllProducts(): Product[]
Returns Product[]
- Defined in js/modularconfig/controllers/AppController.tsx:608

`Protected` getAnalyticsPlugin

getAnalyticsPlugin(): ModularConfigAnalyticsPlugin
Returns ModularConfigAnalyticsPlugin
- Defined in js/modularconfig/controllers/AppController.tsx:1215

getProjectData

getProjectData(code?: string): Promise<ProjectData>
Parameters
- Optional code: string
Returns Promise<ProjectData>
- Defined in js/modularconfig/controllers/AppController.tsx:374

getProjectDataFromCode

getProjectDataFromCode(code: string): Promise<ProjectData>
Parameters
- code: string
Returns Promise<ProjectData>
- Defined in js/modularconfig/controllers/AppController.tsx:386

getProjectFromTemplate

getProjectFromTemplate(): Promise<ProjectData>
Returns Promise<ProjectData>
- Defined in js/modularconfig/controllers/AppController.tsx:399

getScreenshotCamera

getScreenshotCamera(type: string): ICamera
Parameters
- type: string
Returns ICamera
- Defined in js/modularconfig/controllers/AppController.tsx:693

getTogglableUI

getTogglableUI(): DrawerUI | DesktopSideScreenUI
Get the UI element that toggles screens based on mobile vs desktop

Returns DrawerUI | DesktopSideScreenUI
- Defined in js/modularconfig/controllers/AppController.tsx:905

getTotalBounds

getTotalBounds(): IBoundingBox
Returns IBoundingBox
- Defined in js/modularconfig/controllers/AppController.tsx:612

load

load(projectData: ProjectData): Promise<void>
Parameters
- projectData: ProjectData
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:357

loadInitialData

loadInitialData(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:245

`Protected` onDeleteComplete

onDeleteComplete(data: Product): void
Parameters
- data: Product
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1211

`Protected` onDrawerModeSet

onDrawerModeSet(drawerMode: DrawerMode): void
Parameters
- drawerMode: DrawerMode
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1071

`Protected` onDrawerToggled

onDrawerToggled(shown: boolean): void
Parameters
- shown: boolean
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1068

onExitCustomisation

onExitCustomisation(): void
Returns void
Implementation of IAppControllerDelegate.onExitCustomisation
- Defined in js/modularconfig/controllers/AppController.tsx:168

onExitFullscreen

onExitFullscreen(): void
Returns void
Implementation of IRenderControllerDelegate.onExitFullscreen
- Defined in js/modularconfig/controllers/AppController.tsx:662

onMenuItemClick

onMenuItemClick(e: Event, menu: Menu): void
Clicking on a menu action (dimensions, etc)
Parameters
- e: Event
- menu: Menu
Returns void
Implementation of IMenusDelegate.onMenuItemClick
- Defined in js/modularconfig/controllers/AppController.tsx:949

onMenuTypeClick

onMenuTypeClick(e: Event, type: MenuType): void
Clicking one of the drawer menu types (search and browse, style, view, etc)
Parameters
- e: Event
- type: MenuType
Returns void
Implementation of IMenusDelegate.onMenuTypeClick
- Defined in js/modularconfig/controllers/AppController.tsx:909

onNewProject

onNewProject(): Promise<void>
Returns Promise<void>
Implementation of IUIController.onNewProject
- Defined in js/modularconfig/controllers/AppController.tsx:1220

`Protected` onProductAdded

onProductAdded(permanentId: string): void
Parameters
- permanentId: string
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1165

onRenderPlaceComplete

onRenderPlaceComplete(pc: ProductController): void
Parameters
- pc: ProductController
Returns void
Implementation of IRenderControllerDelegate.onRenderPlaceComplete
- Defined in js/modularconfig/controllers/AppController.tsx:560

`Protected` onRotateComplete

onRotateComplete(data: string): void
Parameters
- data: string
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1206

onSceneUpdate

onSceneUpdate(): void
Returns void
Implementation of IRenderControllerDelegate.onSceneUpdate
- Defined in js/modularconfig/controllers/AppController.tsx:510

`Protected` onSelectedProductsUpdated

onSelectedProductsUpdated(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:710

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIController.onSizeUpdate
- Defined in js/modularconfig/controllers/AppController.tsx:417

`Protected` onStyleConfigureSelected

onStyleConfigureSelected(data: CustomisationAssemblyData): void
Parameters
- data: CustomisationAssemblyData
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1173

`Protected` onStyleNone

onStyleNone(data: {
target: StyleActionTarget;
}): void
Parameters
- data: {
  target: StyleActionTarget;
  }
  - target: StyleActionTarget
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:1181

onTabChange

onTabChange(screen: string, oldTabName: string): void
Parameters
- screen: string
- oldTabName: string
Returns void
Implementation of IDesktopSideScreenUIDelegate.onTabChange
- Defined in js/modularconfig/controllers/AppController.tsx:531

redoProjectAction

redoProjectAction(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:854

reset

reset(): Promise<void>
Returns Promise<void>
Implementation of IUIController.reset
- Defined in js/modularconfig/controllers/AppController.tsx:572

rotateProductRight15

rotateProductRight15(): Promise<boolean>
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/AppController.tsx:775

rotateSceneLeft

rotateSceneLeft(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:737

rotateSceneRight

rotateSceneRight(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:741

run

run(): void
Starts the render loop for modular config (starts by default unless MxtModularConfiguratorOptions.loadPaused is set to true)

Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:124

save

save(): Promise<ProjectData>
Returns Promise<ProjectData>
- Defined in js/modularconfig/controllers/AppController.tsx:353

screenshotPressed

screenshotPressed(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:697

setAppTitleMenu

setAppTitleMenu(menu: Menu): void
Set the menu that should provide the app title
Parameters
- menu: Menu
Returns void
Implementation of ISearchAndBrowseControllerDelegate.setAppTitleMenu
- Defined in js/modularconfig/controllers/AppController.tsx:1056

setMenuId

setMenuId(menuId: string): Promise<void>
Parameters
- menuId: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:616

setMenuIdFromSavedProject

setMenuIdFromSavedProject(menuId: string): Promise<void>
Parameters
- menuId: string
Returns Promise<void>
Implementation of IRenderControllerDelegate.setMenuIdFromSavedProject
- Defined in js/modularconfig/controllers/AppController.tsx:620

`Protected` setMenuIdInternal

setMenuIdInternal(menuId: string, startNewProject: boolean): Promise<void>
Parameters
- menuId: string
- startNewProject: boolean
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:624

setupDesktopSidescreen

setupDesktopSidescreen(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:294

setupDrawers

setupDrawers(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:329

setupRunningTotal

setupRunningTotal(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:277

showDebug

showDebug(): void
Show the debug on the renderer

Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:567

showLoadScreen

showLoadScreen(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:820

showNewProjectScreen

showNewProjectScreen(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:826

showProductInfo

showProductInfo(): Promise<boolean>
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/AppController.tsx:779

showShareScreen

showShareScreen(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:823

startNewProject

startNewProject(): Promise<void>
Returns Promise<void>
Implementation of INewProjectControllerDelegate.startNewProject
- Defined in js/modularconfig/controllers/AppController.tsx:830

stop

stop(): void
Stops the render loop. Use when modular configurator is not being shown to prevent render loop overhead.

Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:131

styleAllProducts

styleAllProducts(): Promise<boolean>
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/AppController.tsx:816

styleProduct

styleProduct(): Promise<boolean>
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/AppController.tsx:812

takeScreenshot

takeScreenshot(type?: string, width?: number, height?: number, mimeType?: string, clearColor?: IColor4): Promise<string>
Parameters
- Optional type: string
- Optional width: number
- Optional height: number
- Optional mimeType: string
- Optional clearColor: IColor4
Returns Promise<string>
- Defined in js/modularconfig/controllers/AppController.tsx:685

`Protected` toggleGlobalStyle

toggleGlobalStyle(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:806

`Protected` toggleIndividualStyle

toggleIndividualStyle(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:791

toggleProjectDoors

toggleProjectDoors(menu: Menu): Promise<boolean>
Parameters
- menu: Menu
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/AppController.tsx:858

toggleProjectMeasurements

toggleProjectMeasurements(menu: Menu): boolean
Parameters
- menu: Menu
Returns boolean
- Defined in js/modularconfig/controllers/AppController.tsx:875

undoProjectAction

undoProjectAction(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:888

`Protected` updateDesktopLayout

updateDesktopLayout(data: ResponsivenessData): void
Parameters
- data: ResponsivenessData
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:473

`Protected` updateLayout

updateLayout(data: ResponsivenessData): void
handle devices and orientation changes
Parameters
- data: ResponsivenessData
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:444

`Protected` updateMobileLayout

updateMobileLayout(data: ResponsivenessData): void
Parameters
- data: ResponsivenessData
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:460

`Protected` updateRunningTotalLocation

updateRunningTotalLocation(data: ResponsivenessData): void
Parameters
- data: ResponsivenessData
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:493

viewSceneInAR

viewSceneInAR(e: Event, menu: Menu): Promise<void>
Parameters
- e: Event
- menu: Menu
Returns Promise<void>
- Defined in js/modularconfig/controllers/AppController.tsx:745

zoomSceneIn

zoomSceneIn(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:762

zoomSceneOut

zoomSceneOut(): void
Returns void
- Defined in js/modularconfig/controllers/AppController.tsx:766

Generated using TypeDoc