Class MxtModularConfigurator

Hierarchy

MxtModularConfigurator

Constructors

constructor

new MxtModularConfigurator(options: MxtModularConfiguratorOptions): MxtModularConfigurator
Parameters
- options: MxtModularConfiguratorOptions
Returns MxtModularConfigurator
- Defined in js/modularconfig/MxtModularConfigurator.tsx:39

Properties

`Protected` analyticsSender

analyticsSender: string = 'Modular Configurator'

`Protected` appController

appController: AppController

options

options: MxtModularConfiguratorOptions

`Protected` responsiveness

responsiveness: Responsiveness

`Protected` root

root: HTMLElement

Accessors

instanceId

get instanceId(): number
Returns number
- Defined in js/modularconfig/MxtModularConfigurator.tsx:150

Methods

`Protected` addDefaultPlugins

addDefaultPlugins(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:381

`Protected` addPluginsFromOptions

addPluginsFromOptions(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:373

`Protected` addSaveBeforeExitPrompt

addSaveBeforeExitPrompt(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:456

addScreenshotCameraType

addScreenshotCameraType(type: string, options: ScreenshotCameraOptions): void
Add a screenshot camera type to be later used to take screenshots (see takeScreenshot#type)
Parameters
- type: string
- options: ScreenshotCameraOptions
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:318

`Protected` createControllers

createControllers(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:439

destroy

destroy(): void
Tear down the modular configurator

Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:117

getAllProducts

getAllProducts(): Product[]
Get all products in scene

Returns

Returns Product[]
- Defined in js/modularconfig/MxtModularConfigurator.tsx:279

`Protected` getAnalyticsPlugin

getAnalyticsPlugin(): ModularConfigAnalyticsPlugin
Returns ModularConfigAnalyticsPlugin
- Defined in js/modularconfig/MxtModularConfigurator.tsx:473

getProjectData

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

getScreenshotCamera

getScreenshotCamera(type: string): ICamera
Get your screenshot camera so that you can manipulate its position/target/rotation

Returns
Parameters
- type: string
Returns ICamera
- Defined in js/modularconfig/MxtModularConfigurator.tsx:327

getTotalBounds

getTotalBounds(): IBoundingBox
Total encapsulated 3d bounds of all products in scene

Returns
Null if no products in scene

Returns IBoundingBox
- Defined in js/modularconfig/MxtModularConfigurator.tsx:287

init

init(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:232

`Protected` loadInitialData

loadInitialData(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:452

loadProject

loadProject(projectData: ProjectData): Promise<void>
Parameters
- projectData: ProjectData
Returns Promise<void>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:271

onResponsivenessDataChange

onResponsivenessDataChange(data: ResponsivenessData): void
Parameters
- data: ResponsivenessData
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:466

overrideOptionsFromUrlParams

overrideOptionsFromUrlParams(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:58

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:138

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/MxtModularConfigurator.tsx:127

`Protected` setDefaultOptions

setDefaultOptions(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:154

setMenuId

setMenuId(menuId: string): Promise<void>
Set the menu id that should drive the root search and browse menu

Returns
Parameters
- menuId: string
Returns Promise<void>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:296

`Protected` setup

setup(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:424

`Protected` setupCssVariables

setupCssVariables(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:331

`Protected` setupErrorHandling

setupErrorHandling(): void
Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:405

`Protected` setupHtml

setupHtml(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:443

showDebug

showDebug(): void
Show the debug on the renderer

Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:146

`Protected` start

start(): void
Synchronous start on construction, initialize manifest options, etc

Returns void
- Defined in js/modularconfig/MxtModularConfigurator.tsx:185

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/MxtModularConfigurator.tsx:134

takeScreenshot

takeScreenshot(type?: string, width?: number, height?: number, mimeType?: string, backgroundColor?: IColor4): Promise<string>
Take a screenshot

Returns
Parameters
- Optional type: string
  
  If you want to take a screenshot with a camera that is not the main viewing camera, use this
- Optional width: number
  
  If you want to use a width other than width of current canvas in browser, supply this
- Optional height: number
  
  If you want to use a height other than width of current canvas in browser, supply this
- Optional mimeType: string
  
  If you want to supply a mime type, use this
- Optional backgroundColor: IColor4
  
  If you want to use a different background color than the background color of the 3d rendering, supply this
Returns Promise<string>
- Defined in js/modularconfig/MxtModularConfigurator.tsx:309

Generated using TypeDoc