@vtj • Docs

---

@vtj / designer / Simulator

Class: Simulator

Extends

• Base

Constructors

new Simulator()

new Simulator(options): Simulator

Parameters

• options: SimulatorOptions

Returns

Simulator

Overrides

Base.constructor

Defined in

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

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

---

devtools

devtools: DevTools

Defined in

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

---

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

---

rendered

rendered: Ref<symbol, symbol>

Defined in

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

---

renderer

renderer: null | Renderer

Defined in

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

Methods

createEnv()

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

Parameters

• libraryExports?: string[]

• materialMapLibrary?: Record<string, string>

• materials?: Material[]

• libraryLocaleMap?: Record<string, string>

Returns

SimulatorEnv

Defined in

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

---

dispose()

dispose(): void

Returns

void

Defined in

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

---

emitReady()

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

Parameters

• libraryExports?: string[]

• materialExports?: string[]

• materialMapLibrary?: Record<string, string>

• libraryLocaleMap?: Record<string, string>

Returns

Promise<void>

Defined in

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

---

init()

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

Parameters

• iframe: Ref<undefined | HTMLIFrameElement, undefined | HTMLIFrameElement>

• deps: Ref<Dependencie[], Dependencie[]>

• apis: Ref<ApiSchema[], ApiSchema[]>

• meta: Ref<MetaSchema[], MetaSchema[]>

• config: Ref<ProjectConfig, ProjectConfig>

Returns

void

Defined in

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

---

ready()

ready(callback): void

Parameters

• callback

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

---

resetReady()

resetReady(): void

Returns

void

Inherited from

Base.resetReady

Defined in

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

---

triggerReady()

protected triggerReady(): void

Returns

void

Inherited from

Base.triggerReady

Defined in

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