@vtj / Modules / designer / Simulator

Class: Simulator

designer.Simulator

Hierarchy

• Base

  ↳ Simulator

Table of contents

Constructors

• constructor

Properties

• contentWindow
• designer
• engine
• isReady
• listeners
• materialPath
• renderer
• setup

Methods

• createEnv
• dispose
• emitReady
• init
• ready
• refresh
• resetReady
• triggerReady

Constructors

constructor

• new Simulator(options): Simulator

Parameters

Name	Type
options	SimulatorOptions

Returns

Simulator

Overrides

Base.constructor

Defined in

packages/designer/types/framework/simulator.d.ts:38

Properties

contentWindow

• contentWindow: null | Window

Defined in

packages/designer/types/framework/simulator.d.ts:33

---

designer

• designer: ShallowRef<null | Designer>

Defined in

packages/designer/types/framework/simulator.d.ts:35

---

engine

• engine: Engine

Defined in

packages/designer/types/framework/simulator.d.ts:36

---

isReady

• Protected isReady: boolean

Inherited from

Base.isReady

Defined in

packages/core/types/models/base.d.ts:3

---

listeners

• Protected listeners: () => void[]

Inherited from

Base.listeners

Defined in

packages/core/types/models/base.d.ts:2

---

materialPath

• materialPath: string

Defined in

packages/designer/types/framework/simulator.d.ts:37

---

renderer

• renderer: null | Renderer

Defined in

packages/designer/types/framework/simulator.d.ts:34

---

setup

• Private setup: any

Defined in

packages/designer/types/framework/simulator.d.ts:40

Methods

createEnv

▸ createEnv(libraryExports?, materialMapLibrary?, materials?, libraryLocaleMap?): SimulatorEnv

Parameters

Name	Type
libraryExports?	string[]
materialMapLibrary?	Record<string, string>
materials?	Material[]
libraryLocaleMap?	Record<string, string>

Returns

SimulatorEnv

Defined in

packages/designer/types/framework/simulator.d.ts:42

---

dispose

▸ dispose(): void

Returns

void

Defined in

packages/designer/types/framework/simulator.d.ts:44

---

emitReady

▸ emitReady(libraryExports?, materialExports?, materialMapLibrary?, libraryLocaleMap?): Promise<void>

Parameters

Name	Type
libraryExports?	string[]
materialExports?	string[]
materialMapLibrary?	Record<string, string>
libraryLocaleMap?	Record<string, string>

Returns

Promise<void>

Defined in

packages/designer/types/framework/simulator.d.ts:41

---

init

▸ init(iframe, deps, apis, config): void

Parameters

Name	Type
iframe	Ref<undefined | HTMLIFrameElement>
deps	Ref<Dependencie[]>
apis	Ref<ApiSchema[]>
config	Ref<ProjectConfig>

Returns

void

Defined in

packages/designer/types/framework/simulator.d.ts:39

---

ready

▸ ready(callback): void

Parameters

Name	Type
callback	() => void

Returns

void

Inherited from

Base.ready

Defined in

packages/core/types/models/base.d.ts:5

---

refresh

▸ refresh(): void

Returns

void

Defined in

packages/designer/types/framework/simulator.d.ts:43

---

resetReady

▸ resetReady(): void

Returns

void

Inherited from

Base.resetReady

Defined in

packages/core/types/models/base.d.ts:6

---

triggerReady

▸ triggerReady(): void

Returns

void

Inherited from

Base.triggerReady

Defined in

packages/core/types/models/base.d.ts:4