Core3D

Design class

The Design class handles Design Document manipulation.

Signature:

declare class Design extends EventEmitter<DesignEvents>

Extends: EventEmitter<DesignEvents>

This object offers a way to build, modify, and export Design Documents (which are JSON documents that describe how to build a Design).

Constructor	Modifiers	Description
(constructor)(ctx)		Design constructor.

Property	Modifiers	Type	Description
model	`readonly`	ModelInterface \| undefined	The currently associated ModelInterface.
modifiers	`readonly`	ModifierInterface[]	A list of modifiers.
resources	`readonly`	ResourceInterface[]	A list of resources.

Method	Modifiers	Description
add(modifier)		Add a modifier to the design.
add(resource)		Add a resource to the design.
apply(resource, nodeOrData, data)		Apply an ResourceInterface to the design.
apply(resource, node, data)		Apply a GraphicResource to the design.
apply(resource, node, data)		Apply a MaterialResource to the design.
apply(resource, node, data)		Apply a PatternResource to the design.
apply(resource, data)		Apply a ZoneResource to the design.
apply(resource, node, data)		Apply an AssignableInterface to the design.
apply(resource, data)		Apply an AttachableInterface to the design.
dispose()		Destroy the design.
listMeshes()		List all meshes in the design. https://github.com/microsoft/rushstack/issues/4507
listNodes()		List all nodes in the design.
listZones()		List all zones in the design.
load(data)		Load any unloaded resources and modifiers.
move(modifier, target)		Move a modifier to a different position in the material stack.
remove(modifier)		Remove a modifier from the design.
remove(resource)		Remove a resource from the design.
render()		Render the design.
reset()		Reset the design to a baseline state.
setModel(model)		Set the model for this design.
toJSON()		Serialize this design to a JSON design document.