Class RenderController

Hierarchy

RenderController

Implements

IUIController<ModConfigUIUpdateData>
ISceneEvaluator

Index

Constructors

Properties

cameraAsst currentPlace currentlyLoading delegate dimensionsController fullscreenController hideDoors options productRouter renderer saveAndLoad sceneUpdateTimeoutId showMeasurements ui

Accessors

doorsHidden instanceId isLoadingProject showDimensions

Methods

addCallbackToPlace addProduct addSaveAndLoadPlugins addScreenshotCameraType buildInitialHtml cancelAddProduct createCameraAssistant createCollisionEvaluator createDimensionsController createFullscreenController createGroundController createInfoAction createModularConfigMode createRenderer createShowHideDoorsAction createStyleAction createUI debounceEvaluateSceneUpdates destroy endPlaceMode enterFullscreen evaluateScene exitFullscreen getAllProducts getAnalyticsPlugin getProductDimensionsRenderGroups getScreenshotCamera getTextureLod getTotalBounds hideLoading loadInitialData loadProject loadProjectFully moveExistingModularConfig onAddToFloorClicked onAddToSurfaceLocationClicked onInsertSiblingLocationClicked onLocationClicked onNewProject onOccludedLocationClicked onSizeUpdate onSnapToLocationClicked registerActions reset rotateCameraLeft rotateCameraRight run save setupSceneOptions showDebug showLoading showValidPlaceLocations stop takeScreenshot toggleProductDimensions toggleProjectDoors updateProductDimensions zoomCameraIn zoomCameraOut

Constructors

constructor

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

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

Accessors

doorsHidden

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

instanceId

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

isLoadingProject

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

showDimensions

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

Methods

`Protected` addCallbackToPlace

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

addProduct

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

addSaveAndLoadPlugins

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

addScreenshotCameraType

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

buildInitialHtml

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

cancelAddProduct

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

`Protected` createCameraAssistant

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

`Protected` createCollisionEvaluator

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

`Protected` createDimensionsController

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

`Protected` createFullscreenController

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

`Protected` createGroundController

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

`Protected` createInfoAction

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

`Protected` createModularConfigMode

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

`Protected` createRenderer

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

`Protected` createShowHideDoorsAction

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

`Protected` createStyleAction

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

`Protected` createUI

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

debounceEvaluateSceneUpdates

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

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:242

endPlaceMode

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

enterFullscreen

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

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:123

exitFullscreen

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

getAllProducts

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

`Protected` getAnalyticsPlugin

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

`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:635

getScreenshotCamera

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

`Protected` getTextureLod

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

getTotalBounds

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

hideLoading

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

loadInitialData

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

loadProject

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

`Private` loadProjectFully

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

moveExistingModularConfig

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

onAddToFloorClicked

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

onAddToSurfaceLocationClicked

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

onInsertSiblingLocationClicked

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

`Protected` onLocationClicked

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

onNewProject

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

onOccludedLocationClicked

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

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:272

onSnapToLocationClicked

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

`Protected` registerActions

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

reset

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

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

rotateCameraLeft

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

rotateCameraRight

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

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:133

save

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

`Protected` setupSceneOptions

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

showDebug

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

showLoading

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

`Protected` showValidPlaceLocations

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

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:140

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:682

toggleProductDimensions

toggleProductDimensions(): boolean
Turns product dimensions on/off

Returns
if result is showing dimensions

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

toggleProjectDoors

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

updateProductDimensions

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

Returns

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

zoomCameraIn

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

zoomCameraOut

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

Generated using TypeDoc