editor › Globals › ExternalObjectDescriptorRealizer
Class: ExternalObjectDescriptorRealizer
Realizes a mesh by transforming the surfaces 1:1 to plates
Hierarchy
- ExternalObjectDescriptorRealizer
Implements
Index
Constructors
Properties
- assembly
- debouncedRealizeOrnaments
- descriptor
- externalObject
- ornamentPromise
- platePositionMap
- realizedOrnaments
Methods
- _realizeOrnaments
- _relativePositionChanged
- _removeOrnaments
- _setRelativePositions
- _startUpdatingOrnaments
- beforeExport
- checkValidityAndCleanUp
- findModelElement
- getAdditionalExportSvg
- getExternalObject
- getModelElement
- onRemove
- realize
- recreateWith
- setAssembly
- setPermanent
Constructors
constructor
+ new ExternalObjectDescriptorRealizer(descriptor: ExternalObjectDescriptor): ExternalObjectDescriptorRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:38
Parameters:
| Name | Type |
|---|---|
descriptor |
ExternalObjectDescriptor |
Returns: ExternalObjectDescriptorRealizer
Properties
Private assembly
• assembly: Assembly
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:23
Private Readonly debouncedRealizeOrnaments
• debouncedRealizeOrnaments: DebouncedFuncLeading‹_realizeOrnaments› = debounce(this._realizeOrnaments, 400, { leading: true })
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:37
Private Readonly descriptor
• descriptor: ExternalObjectDescriptor
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:40
Private externalObject
• externalObject: ExternalObject
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:22
Private ornamentPromise
• ornamentPromise: ICancellablePromise‹void›
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:32
Private platePositionMap
• platePositionMap: Map‹string, [Vector3, Quaternion]› = new Map()
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:38
Private realizedOrnaments
• realizedOrnaments: Ornament[] = []
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:31
If csgCutoutsEnabled is activated on the ExternalObjectDescriptor, this realizer runs the CSGCutoutGenerator to create cutouts where the external object intersects with a plate. These cutouts are described by the realizedOrnaments here.
Methods
Private _realizeOrnaments
▸ _realizeOrnaments(onPlates: Plate[], cancelToken: CancelToken): Promise‹void›
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:149
Parameters:
| Name | Type |
|---|---|
onPlates |
Plate[] |
cancelToken |
CancelToken |
Returns: Promise‹void›
Private _relativePositionChanged
▸ _relativePositionChanged(plate: Plate, newPosition: Vector3, newRotation: Quaternion): object
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:188
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
newPosition |
Vector3 |
newRotation |
Quaternion |
Returns: object
-
hasChanged: boolean
-
oldPositionAndRotation? : [Vector3, Quaternion]
Private _removeOrnaments
▸ _removeOrnaments(fromThesePlates: Plate[]): void
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:135
Parameters:
| Name | Type | Default |
|---|---|---|
fromThesePlates |
Plate[] | this.externalObject.getAssembly().getPlates() |
Returns: void
Private _setRelativePositions
▸ _setRelativePositions(): void
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:220
Returns: void
Private _startUpdatingOrnaments
▸ _startUpdatingOrnaments(): Promise‹void›
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:243
Returns: Promise‹void›
beforeExport
▸ beforeExport(): Promise‹void› | void
Implementation of IModelElementRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:127
Returns: Promise‹void› | void
checkValidityAndCleanUp
▸ checkValidityAndCleanUp(): void
Implementation of IModelElementRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:107
Returns: void
findModelElement
▸ findModelElement‹DesiredType›(desiredType: any, interactionData: IInteractionData, maxDistance: number, strategy: FindModelElementReturnStrategy): FoundModelElements‹DesiredType›
Implementation of IModelElementRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:42
Type parameters:
▪ DesiredType
Parameters:
| Name | Type | Default |
|---|---|---|
desiredType |
any | - |
interactionData |
IInteractionData | - |
maxDistance |
number | 20 |
strategy |
FindModelElementReturnStrategy | FindModelElementReturnStrategy.FIRST |
Returns: FoundModelElements‹DesiredType›
getAdditionalExportSvg
▸ getAdditionalExportSvg(): Promise‹string | null›
Implementation of IModelElementRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:123
Returns: Promise‹string | null›
getExternalObject
▸ getExternalObject(): ExternalObject
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:131
Returns: ExternalObject
getModelElement
▸ getModelElement(): ExternalObjectDescriptor
Implementation of IModelElementRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:62
Returns: ExternalObjectDescriptor
onRemove
▸ onRemove(): void
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:66
Returns: void
realize
▸ realize(targets: Array‹object›, lastChangeEvent: IModelElementEvent, lastTransformsChangeEvent: ITransformsChangeEvent): Promise‹void›
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:72
Parameters:
| Name | Type |
|---|---|
targets |
Array‹object› |
lastChangeEvent |
IModelElementEvent |
lastTransformsChangeEvent |
ITransformsChangeEvent |
Returns: Promise‹void›
recreateWith
▸ recreateWith(otherModelElement: ExternalObjectDescriptor): IModelElementRealizer‹ExternalObjectDescriptor›
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:99
Parameters:
| Name | Type |
|---|---|
otherModelElement |
ExternalObjectDescriptor |
Returns: IModelElementRealizer‹ExternalObjectDescriptor›
setAssembly
▸ setAssembly(assembly: Assembly): void
Implementation of IModelElementRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:103
Parameters:
| Name | Type |
|---|---|
assembly |
Assembly |
Returns: void
setPermanent
▸ setPermanent(): void
Implementation of IModelElementRealizer
Defined in src/model/data/Concepts/Realization/ExternalObjectDescriptorRealizer.ts:117
Returns: void