@vtj

---

@vtj / designer / Simulator

Class: Simulator

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

Extends

• Base

Constructors

Constructor

new Simulator(options): Simulator

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

Parameters

options

SimulatorOptions

Returns

Simulator

Overrides

Base.constructor

Properties

contentWindow

contentWindow: Window | null

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

---

designer

designer: ShallowRef<Designer | null>

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

---

engine

engine: Engine

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

---

enhance?

optional enhance: EnhanceConfig

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

---

isReady

isReady: boolean

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

Inherited from

Base.isReady

---

listeners

protected listeners: () => void[]

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

Returns

void

Inherited from

Base.listeners

---

materialPath

materialPath: string

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

---

rendered

rendered: Ref<symbol>

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

---

renderer

renderer: Renderer | null

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

Methods

capture()

capture(): Promise<unknown>

Defined in: packages/designer/types/framework/simulator.d.ts:52

Returns

Promise<unknown>

---

createEnv()

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

Defined in: packages/designer/types/framework/simulator.d.ts:50

Parameters

libraryExports?

string[]

materialMapLibrary?

Record<string, string>

materials?

Material[]

libraryLocaleMap?

Record<string, string>

Returns

SimulatorEnv

---

dispose()

dispose(): void

Defined in: packages/designer/types/framework/simulator.d.ts:53

Returns

void

---

emitReady()

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

Defined in: packages/designer/types/framework/simulator.d.ts:49

Parameters

libraryExports?

string[]

materialExports?

string[]

materialMapLibrary?

Record<string, string>

libraryLocaleMap?

Record<string, string>

Returns

Promise<void>

---

init()

init(iframe, deps, apis, meta, config, uniConfig, global, i18n): void

Defined in: packages/designer/types/framework/simulator.d.ts:45

Parameters

iframe

Ref<HTMLIFrameElement | undefined>

deps

Ref<Dependencie[]>

apis

Ref<ApiSchema[]>

meta

Ref<MetaSchema[]>

config

Ref<ProjectConfig>

uniConfig

Ref<UniConfig>

global

Ref<GlobalConfig>

i18n

Ref<I18nConfig>

Returns

void

---

ready()

ready(callback): void

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

Parameters

callback

() => void

Returns

void

Inherited from

Base.ready

---

refresh()

refresh(): void

Defined in: packages/designer/types/framework/simulator.d.ts:51

Returns

void

---

resetReady()

resetReady(): void

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

Returns

void

Inherited from

Base.resetReady

---

triggerReady()

protected triggerReady(): void

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

Returns

void

Inherited from

Base.triggerReady