Class PreviewModel

Hierarchy (View Summary)

Deletable
- PreviewModel

Index

Constructors

Properties

color? cubes id model_3d onUpdate? plugin? render_side shading texture? texture_size models

Methods

buildModel delete disable enable update getActiveModels

Constructors

constructor

new PreviewModel(id: string, options: PreviewModelOptions): PreviewModel
Parameters
- id: string
- options: PreviewModelOptions
Returns PreviewModel
Overrides Deletable.constructor
- Defined in types/custom/preview_scene.d.ts:41

Properties

`Optional`color

color?: string

cubes

cubes: PreviewModelCubeTemplate[]

id

id: string

model_3d

model_3d: Object3D

`Optional`onUpdate

onUpdate?: () => void

`Optional`plugin

plugin?: string

The ID of the plugin that created the object

render_side

render_side: number

shading

shading: boolean

`Optional`texture

texture?: string

texture_size

texture_size: [number, number]

`Static`models

models: (id: string) => PreviewModel

Methods

buildModel

buildModel(): void
Returns void
- Defined in types/custom/preview_scene.d.ts:69

delete

delete(): void
Returns void
Inherited from Deletable.delete
- Defined in types/custom/misc.d.ts:8

disable

disable(): boolean
Disables the model in the preview

Returns boolean
- Defined in types/custom/preview_scene.d.ts:64

enable

enable(): void
Enables the model in the preview

Returns void
- Defined in types/custom/preview_scene.d.ts:60

update

update(): void
Update the appearance and visibility of the model

Returns void
- Defined in types/custom/preview_scene.d.ts:68

`Static`getActiveModels

getActiveModels(): PreviewModel[]
Returns PreviewModel[]
- Defined in types/custom/preview_scene.d.ts:46