editor › Globals › ObjectVisualization

Class: ObjectVisualization

Abstract class for visualization of a PhysicalObject. Add to AssemblyVisualization.availableObjectVisualizations to use.

Hierarchy

• ObjectRepresentation

↳ ObjectVisualization

↳ IkeaShelfVisualization

↳ DummyMeshVisualization

↳ ExternalObjectVisualization

↳ PlateOutlineVisualization

↳ PlateVisualization

Index

Constructors

• constructor

Properties

• asyncUpdateEventEmitter
• physicalObject
• threeNode

Methods

• _displayDebugInformation
• _visualize
• destroy
• getAsyncUpdateEventEmitter
• getPhysicalObject
• getRepresentationFinishedPromise
• getThreeNode
• isValid
• visualize
• canRepresent
• isExclusive

Constructors

constructor

+ new ObjectVisualization(physicalObject: PhysicalObject): ObjectVisualization

Inherited from ObjectRepresentation.constructor

Defined in src/model/ObjectRepresentation.ts:14

Parameters:

Name	Type
physicalObject	PhysicalObject

Returns: ObjectVisualization

Properties

Protected Readonly asyncUpdateEventEmitter

• asyncUpdateEventEmitter: EventEmitter‹void› = new EventEmitter()

Defined in src/model/visualization/ObjectVisualization.ts:20

---

Protected Readonly physicalObject

• physicalObject: PhysicalObject

Inherited from ObjectRepresentation.physicalObject

Defined in src/model/ObjectRepresentation.ts:14

---

Private threeNode

• threeNode: Object3D | null = null

Defined in src/model/visualization/ObjectVisualization.ts:21

Methods

Private _displayDebugInformation

▸ _displayDebugInformation(): void

Defined in src/model/visualization/ObjectVisualization.ts:67

Returns: void

---

Protected Abstract _visualize

▸ _visualize(threeNode: Object3D): Object3D

Defined in src/model/visualization/ObjectVisualization.ts:65

Creates the object's visualization for the first time

Parameters:

Name	Type
threeNode	Object3D

Returns: Object3D

the generated visualization

---

destroy

▸ destroy(): void

Defined in src/model/visualization/ObjectVisualization.ts:42

Returns: void

---

getAsyncUpdateEventEmitter

▸ getAsyncUpdateEventEmitter(): IPublicEventEmitterInterface‹void›

Defined in src/model/visualization/ObjectVisualization.ts:23

Returns: IPublicEventEmitterInterface‹void›

---

getPhysicalObject

▸ getPhysicalObject(): PhysicalObject‹›

Inherited from ObjectRepresentation.getPhysicalObject

Defined in src/model/ObjectRepresentation.ts:30

Returns: PhysicalObject‹›

Associated physical object

---

getRepresentationFinishedPromise

▸ getRepresentationFinishedPromise(): Promise‹void›

Inherited from ObjectRepresentation.getRepresentationFinishedPromise

Defined in src/model/ObjectRepresentation.ts:23

Returns: Promise‹void›

---

getThreeNode

▸ getThreeNode(): Object3D

Defined in src/model/visualization/ObjectVisualization.ts:57

Returns an instance to the THREE.Object3D created during visualize()

Returns: Object3D

---

isValid

▸ isValid(): boolean

Defined in src/model/visualization/ObjectVisualization.ts:50

Offers possibility for the visualization to invalidate itself.

Returns: boolean

false if objectVisualization should be rebuilt, true if it's still valid.

---

visualize

▸ visualize(): Object3D

Defined in src/model/visualization/ObjectVisualization.ts:31

Generate the visualization to add to the scene graph

Returns: Object3D

the generated visualization

---

Static canRepresent

▸ canRepresent(physicalObject: PhysicalObject): boolean

Inherited from ObjectRepresentation.canRepresent

Defined in src/model/ObjectRepresentation.ts:10

Parameters:

Name	Type
physicalObject	PhysicalObject

Returns: boolean

Whether this class can represent this physicalObject

---

Static isExclusive

▸ isExclusive(): boolean

Defined in src/model/visualization/ObjectVisualization.ts:16

Determines whether other visualizations may visualize the same object.

Returns: boolean