editor › Globals › ExternalObjectVisualization
Class: ExternalObjectVisualization
Hierarchy
↳ ExternalObjectVisualization
Index
Constructors
Properties
Methods
- _cloneThreeObject
- _initializeWithResources
- _visualize
- destroy
- getAsyncUpdateEventEmitter
- getPhysicalObject
- getRepresentationFinishedPromise
- getThreeNode
- isValid
- visualize
- canRepresent
- isExclusive
Constructors
constructor
+ new ExternalObjectVisualization(physicalObject: PhysicalObject): ExternalObjectVisualization
Inherited from ObjectRepresentation.constructor
Defined in src/model/ObjectRepresentation.ts:14
Parameters:
| Name | Type |
|---|---|
physicalObject |
PhysicalObject |
Returns: ExternalObjectVisualization
Properties
Protected Readonly asyncUpdateEventEmitter
• asyncUpdateEventEmitter: EventEmitter‹void› = new EventEmitter
Inherited from ObjectVisualization.asyncUpdateEventEmitter
Defined in src/model/visualization/ObjectVisualization.ts:20
Protected Readonly physicalObject
• physicalObject: PhysicalObject
Inherited from ObjectRepresentation.physicalObject
Defined in src/model/ObjectRepresentation.ts:14
Methods
Private _cloneThreeObject
▸ _cloneThreeObject‹T›(threeObject: T): T
Defined in src/model/visualization/ExternalObjectVisualization.ts:85
Type parameters:
▪ T: BufferGeometry | Geometry | Material | Mesh | Object3D
Parameters:
| Name | Type |
|---|---|
threeObject |
T |
Returns: T
Private _initializeWithResources
▸ _initializeWithResources(resources: any, threeNode: any): void
Defined in src/model/visualization/ExternalObjectVisualization.ts:33
Parameters:
| Name | Type |
|---|---|
resources |
any |
threeNode |
any |
Returns: void
Protected _visualize
▸ _visualize(threeNode: Object3D): Object3D
Overrides ObjectVisualization._visualize
Defined in src/model/visualization/ExternalObjectVisualization.ts:22
Parameters:
| Name | Type |
|---|---|
threeNode |
Object3D |
Returns: Object3D
destroy
▸ destroy(): void
Overrides ObjectVisualization.destroy
Defined in src/model/visualization/ExternalObjectVisualization.ts:16
Returns: void
getAsyncUpdateEventEmitter
▸ getAsyncUpdateEventEmitter(): IPublicEventEmitterInterface‹void›
Inherited from ObjectVisualization.getAsyncUpdateEventEmitter
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
Inherited from ObjectVisualization.getThreeNode
Defined in src/model/visualization/ObjectVisualization.ts:57
Returns an instance to the THREE.Object3D created during visualize()
Returns: Object3D
isValid
▸ isValid(): boolean
Inherited from ObjectVisualization.isValid
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
Inherited from ObjectVisualization.visualize
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
Overrides ObjectRepresentation.canRepresent
Defined in src/model/visualization/ExternalObjectVisualization.ts:12
Parameters:
| Name | Type |
|---|---|
physicalObject |
PhysicalObject |
Returns: boolean
Static isExclusive
▸ isExclusive(): boolean
Inherited from ObjectVisualization.isExclusive
Defined in src/model/visualization/ObjectVisualization.ts:16
Determines whether other visualizations may visualize the same object.
Returns: boolean