Class RenderController

Hierarchy

RenderController

Implements

IUIController<ModConfigUIUpdateData>
ISceneEvaluator

Index

Constructors

Constructors

constructor

new RenderController(delegate: IRenderControllerDelegate, options: MxtModularConfiguratorOptions): RenderController
Parameters
- delegate: IRenderControllerDelegate
- options: MxtModularConfiguratorOptions
Returns RenderController
- Defined in js/modularconfig/controllers/RenderController.ts:79

Properties

`Protected` cameraAsst

cameraAsst: CameraAssistant

`Protected` currentPlace

currentPlace: ClickToPlaceOptions

`Protected` currentlyLoading

currentlyLoading: boolean = false

delegate

delegate: IRenderControllerDelegate

`Protected` dimensionsController

dimensionsController: DimensionsController

`Protected` fullscreenController

fullscreenController: FullscreenController

`Protected` hideDoors

hideDoors: boolean = false

options

options: MxtModularConfiguratorOptions

`Protected` productRouter

productRouter: ProductRouter = ...

`Protected` renderer

renderer: IJSSpinRenderingEngine

`Protected` saveAndLoad

saveAndLoad: ProjectSaveAndLoad = ...

`Protected` sceneUpdateTimeoutId

sceneUpdateTimeoutId: number

`Protected` showMeasurements

showMeasurements: boolean = false

ui

ui: RenderUI

Accessors

doorsHidden

get doorsHidden(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/RenderController.ts:130

instanceId

get instanceId(): number
Returns number
- Defined in js/modularconfig/controllers/RenderController.ts:122

isLoadingProject

get isLoadingProject(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/RenderController.ts:155

showDimensions

get showDimensions(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/RenderController.ts:126

Methods

`Protected` addCallbackToPlace

addCallbackToPlace(options: ClickToPlaceOptions): Promise<void>
Parameters
- options: ClickToPlaceOptions
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:372

addProduct

addProduct(product: Product): Promise<void>
Parameters
- product: Product
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:322

addRunningTotalUI

addRunningTotalUI(runningTotal: HTMLElement): void
Parameters
- runningTotal: HTMLElement
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:693

addSaveAndLoadPlugins

addSaveAndLoadPlugins(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:166

addScreenshotCameraType

addScreenshotCameraType(type: string, options: ScreenshotCameraOptions): void
Parameters
- type: string
- options: ScreenshotCameraOptions
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:932

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
- Defined in js/modularconfig/controllers/RenderController.ts:159

cancelAddProduct

cancelAddProduct(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:328

`Protected` createCameraAssistant

createCameraAssistant(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:314

`Protected` createCollisionEvaluator

createCollisionEvaluator(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:697

`Protected` createDimensionsController

createDimensionsController(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:752

`Protected` createFullscreenController

createFullscreenController(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:318

`Protected` createGroundController

createGroundController(): GroundController
Returns GroundController
- Defined in js/modularconfig/controllers/RenderController.ts:746

`Protected` createInfoAction

createInfoAction(): DefaultInfoAction
Returns DefaultInfoAction
- Defined in js/modularconfig/controllers/RenderController.ts:742

`Protected` createModularConfigMode

createModularConfigMode(): DefaultModularConfigModePlugin
Returns DefaultModularConfigModePlugin
- Defined in js/modularconfig/controllers/RenderController.ts:736

`Protected` createRenderer

createRenderer(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:398

`Protected` createShowHideDoorsAction

createShowHideDoorsAction(show: boolean): DefaultShowHideDoorsAction
Parameters
- show: boolean
Returns DefaultShowHideDoorsAction
- Defined in js/modularconfig/controllers/RenderController.ts:772

`Protected` createStyleAction

createStyleAction(): DefaultStyleAction
Returns DefaultStyleAction
- Defined in js/modularconfig/controllers/RenderController.ts:739

`Protected` createUI

createUI(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:310

debounceEvaluateSceneUpdates

debounceEvaluateSceneUpdates(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:850

destroy

destroy(): void
Destroy means kill everything, does not make anything re-usable, this is purely for memory purposes

Returns void
Implementation of IUIController.destroy
- Defined in js/modularconfig/controllers/RenderController.ts:270

endPlaceMode

endPlaceMode(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:956

enterFullscreen

enterFullscreen(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:176

evaluateScene

evaluateScene(job: Job<any>, type: JOB_EXECUTION_TYPE): void
Parameters
- job: Job<any>
- type: JOB_EXECUTION_TYPE
Returns void
Implementation of ISceneEvaluator.evaluateScene
- Defined in js/modularconfig/controllers/RenderController.ts:134

exitFullscreen

exitFullscreen(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:356

getAllProducts

getAllProducts(): Product[]
Returns Product[]
- Defined in js/modularconfig/controllers/RenderController.ts:187

`Protected` getAnalyticsPlugin

getAnalyticsPlugin(): ModularConfigAnalyticsPlugin
Returns ModularConfigAnalyticsPlugin
- Defined in js/modularconfig/controllers/RenderController.ts:960

`Protected` getProductDimensionsRenderGroups

getProductDimensionsRenderGroups(): {
id: string;
renderObjects: IRenderObject[];
}[]
Gets a list of product groups to show dimensions for

Remarks
Each stand-alone ottoman is its own separate group. Everything else is considered one large group, as we are assuming everything else is either stacked in a parent/child relationship (compose surface) and/or chained as sibling attachments (mount points).

Returns
array of render groups

Returns {
id: string;
renderObjects: IRenderObject[];
}[]
- Defined in js/modularconfig/controllers/RenderController.ts:893

getScreenshotCamera

getScreenshotCamera(type: string): ICamera
Parameters
- type: string
Returns ICamera
- Defined in js/modularconfig/controllers/RenderController.ts:936

`Protected` getTextureLod

getTextureLod(): DefinedLevelOfDetail
Returns DefinedLevelOfDetail
- Defined in js/modularconfig/controllers/RenderController.ts:776

getTotalBounds

getTotalBounds(): IBoundingBox
Returns IBoundingBox
- Defined in js/modularconfig/controllers/RenderController.ts:193

hideLoading

hideLoading(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:352

hideNoProductGuidance

hideNoProductGuidance(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:183

loadInitialData

loadInitialData(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:435

`Protected` loadInitialKong

loadInitialKong(permanentId: string, productId: string, skus: string[]): Promise<Product>
Parameters
- permanentId: string
- productId: string
- skus: string[]
Returns Promise<Product>
- Defined in js/modularconfig/controllers/RenderController.ts:575

`Protected` loadInitialProduct

loadInitialProduct(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:500

`Protected` loadInitialProductId

loadInitialProductId(productId: string): Promise<Product>
Parameters
- productId: string
Returns Promise<Product>
- Defined in js/modularconfig/controllers/RenderController.ts:547

`Protected` loadInitialProductIdAssembly

loadInitialProductIdAssembly(productId: string, assembly: {
productId: string;
stepType: string;
}[]): Promise<Product>
Parameters
- productId: string
- assembly: {
  productId: string;
  stepType: string;
  }[]
Returns Promise<Product>
- Defined in js/modularconfig/controllers/RenderController.ts:596

`Protected` loadInitialSku

loadInitialSku(sku: string): Promise<Product>
Parameters
- sku: string
Returns Promise<Product>
- Defined in js/modularconfig/controllers/RenderController.ts:559

`Protected` loadInitialSkuAssembly

loadInitialSkuAssembly(sku: string, assembly: {
sku: string;
stepType: string;
}[]): Promise<Product>
Parameters
- sku: string
- assembly: {
  sku: string;
  stepType: string;
  }[]
Returns Promise<Product>
- Defined in js/modularconfig/controllers/RenderController.ts:637

loadProject

loadProject(projectData: ProjectData): Promise<void>
Parameters
- projectData: ProjectData
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:218

`Private` loadProjectFully

loadProjectFully(projectData: ProjectData): Promise<void>
Parameters
- projectData: ProjectData
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:247

moveExistingModularConfig

moveExistingModularConfig(): Promise<boolean>
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/RenderController.ts:928

onAddToFloorClicked

onAddToFloorClicked(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:344

onAddToSurfaceLocationClicked

onAddToSurfaceLocationClicked(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:341

onInsertSiblingLocationClicked

onInsertSiblingLocationClicked(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:338

`Protected` onLocationClicked

onLocationClicked(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:361

onNewProject

onNewProject(): Promise<void>
Returns Promise<void>
Implementation of IUIController.onNewProject
- Defined in js/modularconfig/controllers/RenderController.ts:965

onOccludedLocationClicked

onOccludedLocationClicked(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:335

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Called every time size updates, should generally call onSizeUpdate on its UI components
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIController.onSizeUpdate
- Defined in js/modularconfig/controllers/RenderController.ts:300

onSnapToLocationClicked

onSnapToLocationClicked(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:332

`Protected` registerActions

registerActions(toolbelt: MxtToolbeltOptions): void
Parameters
- toolbelt: MxtToolbeltOptions
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:701

reset

reset(): Promise<void>
Reset for re-use

Returns Promise<void>
Implementation of IUIController.reset
- Defined in js/modularconfig/controllers/RenderController.ts:276

rotateCameraLeft

rotateCameraLeft(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:824

rotateCameraRight

rotateCameraRight(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:828

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/RenderController.ts:144

save

save(): Promise<ProjectData>
Returns Promise<ProjectData>
- Defined in js/modularconfig/controllers/RenderController.ts:172

`Protected` setupSceneOptions

setupSceneOptions(): MxtSceneOptions
Returns MxtSceneOptions
- Defined in js/modularconfig/controllers/RenderController.ts:402

showDebug

showDebug(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:296

showLoading

showLoading(message: string, atTop?: boolean): void
Parameters
- message: string
- Optional atTop: boolean
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:348

showNoProductGuidance

showNoProductGuidance(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:180

`Protected` showValidPlaceLocations

showValidPlaceLocations(product: Product): Promise<void>
Parameters
- product: Product
Returns Promise<void>
- Defined in js/modularconfig/controllers/RenderController.ts:389

startLoading

startLoading(): void
A method to call prior to actually loadding if you want to alert the renderer that you have started the loading process Maybe you are doing other stuff (UI cleanup, etc) before you actually call .loadProject, and you want to renderer to know you are beginning the loading process so that renderer guidance shows up correctly

Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:213

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/RenderController.ts:151

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/RenderController.ts:940

toggleProductDimensions

toggleProductDimensions(): boolean
Turns product dimensions on/off

Returns
if result is showing dimensions

Returns boolean
- Defined in js/modularconfig/controllers/RenderController.ts:836

toggleProjectDoors

toggleProjectDoors(): Promise<boolean>
Returns Promise<boolean>
- Defined in js/modularconfig/controllers/RenderController.ts:919

updateProductDimensions

updateProductDimensions(): void
Reinitializes the dimensionsController with updated render groups

Returns

Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:871

zoomCameraIn

zoomCameraIn(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:816

zoomCameraOut

zoomCameraOut(): void
Returns void
- Defined in js/modularconfig/controllers/RenderController.ts:820

Class RenderController

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

delegate: IRenderControllerDelegate

options: MxtModularConfiguratorOptions

Returns RenderController

Properties

Protected cameraAsst

Protected currentPlace

Protected currentlyLoading

delegate

Protected dimensionsController

Protected fullscreenController

Protected hideDoors

options

Protected productRouter

Protected renderer

Protected saveAndLoad

Protected sceneUpdateTimeoutId

Protected showMeasurements

ui

Accessors

doorsHidden

Returns boolean

instanceId

Returns number

isLoadingProject

Returns boolean

showDimensions

Returns boolean

Methods

Protected addCallbackToPlace

Parameters

options: ClickToPlaceOptions

Returns Promise<void>

addProduct

Parameters

product: Product

Returns Promise<void>

addRunningTotalUI

Parameters

runningTotal: HTMLElement

Returns void

addSaveAndLoadPlugins

Returns void

addScreenshotCameraType

Parameters

type: string

options: ScreenshotCameraOptions

Returns void

buildInitialHtml

Returns HTMLElement

cancelAddProduct

Returns void

Protected createCameraAssistant

Returns void

Protected createCollisionEvaluator

Returns void

Protected createDimensionsController

Returns void

Protected createFullscreenController

Returns void

Protected createGroundController

Returns GroundController

Protected createInfoAction

Returns DefaultInfoAction

Protected createModularConfigMode

Returns DefaultModularConfigModePlugin

Protected createRenderer

Returns void

Protected createShowHideDoorsAction

Parameters

`Protected` cameraAsst

`Protected` currentPlace

`Protected` currentlyLoading

`Protected` dimensionsController

`Protected` fullscreenController

`Protected` hideDoors

`Protected` productRouter

`Protected` renderer

`Protected` saveAndLoad

`Protected` sceneUpdateTimeoutId

`Protected` showMeasurements

`Protected` addCallbackToPlace

`Protected` createCameraAssistant

`Protected` createCollisionEvaluator

`Protected` createDimensionsController

`Protected` createFullscreenController

`Protected` createGroundController

`Protected` createInfoAction

`Protected` createModularConfigMode

`Protected` createRenderer

`Protected` createShowHideDoorsAction

`Protected` createStyleAction

`Protected` createUI

`Protected` getAnalyticsPlugin

`Protected` getProductDimensionsRenderGroups

Returns {
id: string;
renderObjects: IRenderObject[];
}[]

`Protected` getTextureLod

`Protected` loadInitialKong

`Protected` loadInitialProduct

`Protected` loadInitialProductId

`Protected` loadInitialProductIdAssembly

assembly: {
productId: string;
stepType: string;
}[]

`Protected` loadInitialSku

`Protected` loadInitialSkuAssembly

assembly: {
sku: string;
stepType: string;
}[]