Skip to content

editor › Globals › PolygonOrnamentDescriptorRealizer

Class: PolygonOrnamentDescriptorRealizer

Realizes (creates/updates) a PolygonOrnamentDescriptor (like LocalOrnamentDescriptorRealizer) When ornament is setPermanent (when a tool is finished) it does calculations onto the corresponding PolygonOrnamentDescriptor like (a) calculating the scale of the ornament onto its polygon (b) merging polygons that overlap (e.g. after moving) (c) specific distance calculations (d) showing the outline of the polygon descriptors polygon grids

Hierarchy

↳ LocalOrnamentDescriptorRealizer

↳ PolygonOrnamentDescriptorRealizer

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

+ new PolygonOrnamentDescriptorRealizer(ornamentDescriptor: PolygonOrnamentDescriptor): PolygonOrnamentDescriptorRealizer

Overrides LocalOrnamentDescriptorRealizer.constructor

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:26

Parameters:

Name Type
ornamentDescriptor PolygonOrnamentDescriptor

Returns: PolygonOrnamentDescriptorRealizer

Properties

Protected assembly

• assembly: Assembly

Inherited from OrnamentDescriptorRealizer.assembly

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:26

Protected ornament

• ornament: Ornament | null = null

Inherited from OrnamentDescriptorRealizer.ornament

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:23

Protected ornamentDescriptor

• ornamentDescriptor: PolygonOrnamentDescriptor

Overrides LocalOrnamentDescriptorRealizer.ornamentDescriptor

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:26

Protected plate

• plate: Plate

Inherited from OrnamentDescriptorRealizer.plate

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:25

Methods

Protected _addOrnament

▸ _addOrnament(): Promise‹void›

Inherited from OrnamentDescriptorRealizer._addOrnament

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:185

Returns: Promise‹void›

Protected _clearOrnament

▸ _clearOrnament(): void

Inherited from OrnamentDescriptorRealizer._clearOrnament

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:178

Returns: void

Protected _createOrnament

▸ _createOrnament(): Promise‹void›

Overrides LocalOrnamentDescriptorRealizer._createOrnament

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:104

creates an ornament that can have a cutout and an engraving at the same time based on the ornamentDescriptors content and engravingContent

Returns: Promise‹void›

Protected _distanceToAssemblyPoint

▸ _distanceToAssemblyPoint(assemblyPoint: Vector3): number

Overrides OrnamentDescriptorRealizer._distanceToAssemblyPoint

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:125

Parameters:

Name Type Description
assemblyPoint Vector3 in assemblies coordinate system

Returns: number

distance to its closest polygon (not polygon graphic/cutout)

Protected _getAnchorAngle

▸ _getAnchorAngle(): number

Inherited from OrnamentDescriptorRealizer._getAnchorAngle

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:326

Returns: number

Private _getPolygonOrnament

▸ _getPolygonOrnament(content: string | ArrayBuffer | null, engravingContent: string | null): Ornament

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:136

Parameters:

Name Type
content string | ArrayBuffer | null
engravingContent string | null

Returns: Ornament

an ornament that can contain a cutout and an engraving at the same time

Protected _hasAnyContent

▸ _hasAnyContent(): boolean

Overrides LocalOrnamentDescriptorRealizer._hasAnyContent

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:129

Returns: boolean

Protected _hasOrnamentDescriptorContentBeenUpdated

▸ _hasOrnamentDescriptorContentBeenUpdated(): boolean

Inherited from LocalOrnamentDescriptorRealizer._hasOrnamentDescriptorContentBeenUpdated

Defined in src/model/data/Concepts/Realization/LocalOrnamentDescriptorRealizer.ts:55

Returns: boolean

Protected _removeDueToOtherOrnaments

▸ _removeDueToOtherOrnaments(): boolean

Inherited from OrnamentDescriptorRealizer._removeDueToOtherOrnaments

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:299

If an ornament covers the whole plate, it should remove itself in every case except when there is no other ornament or when there is only one ornament and this ornament doesn't cover the whole plate. If an ornament doesn't cover the whole plate, it shouldn't remove itself in every case except when there is an ornament covering the whole plate and there isn't another single ornament. This leads to realization of either all ornaments not covering the whole plate (when there are at least two of them or there is no plate covering one) or the last plate covering one.

Returns: boolean

if the ornament should remove itself

Protected _setOrnamentDescriptorContentAsRead

▸ _setOrnamentDescriptorContentAsRead(): void

Inherited from LocalOrnamentDescriptorRealizer._setOrnamentDescriptorContentAsRead

Defined in src/model/data/Concepts/Realization/LocalOrnamentDescriptorRealizer.ts:59

Returns: void

Protected _updateOrnament

▸ _updateOrnament(): Promise‹void›

Overrides LocalOrnamentDescriptorRealizer._updateOrnament

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:86

Returns: Promise‹void›

Protected _updateOrnamentFromContent

▸ _updateOrnamentFromContent(): Promise‹void›

Inherited from LocalOrnamentDescriptorRealizer._updateOrnamentFromContent

Defined in src/model/data/Concepts/Realization/LocalOrnamentDescriptorRealizer.ts:25

Returns: Promise‹void›

Protected _updateOrnamentOffset

▸ _updateOrnamentOffset(): void

Inherited from OrnamentDescriptorRealizer._updateOrnamentOffset

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:272

Returns: void

Protected _updateOrnamentRotation

▸ _updateOrnamentRotation(): void

Inherited from OrnamentDescriptorRealizer._updateOrnamentRotation

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:252

Returns: void

Protected _updateOrnamentScale

▸ _updateOrnamentScale(): void

Inherited from OrnamentDescriptorRealizer._updateOrnamentScale

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:260

Returns: void

Protected _updateOrnamentSync

▸ _updateOrnamentSync(): void

Inherited from OrnamentDescriptorRealizer._updateOrnamentSync

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:246

Returns: void

beforeExport

▸ beforeExport(): void

Implementation of IModelElementRealizer

Inherited from OrnamentDescriptorRealizer.beforeExport

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:127

Returns: void

checkValidityAndCleanUp

▸ checkValidityAndCleanUp(): void

Implementation of IModelElementRealizer

Inherited from OrnamentDescriptorRealizer.checkValidityAndCleanUp

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:58

Returns: void

findModelElement

▸ findModelElement‹DesiredType›(desiredType: any, interactionData: IInteractionData, maxDistance?: number, strategy?: FindModelElementReturnStrategy): FoundModelElements‹DesiredType›

Implementation of IModelElementRealizer

Overrides OrnamentDescriptorRealizer.findModelElement

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:55

Type parameters:

▪ DesiredType

Parameters:

Name Type
desiredType any
interactionData IInteractionData
maxDistance? number
strategy? FindModelElementReturnStrategy

Returns: FoundModelElements‹DesiredType›

getAdditionalExportSvg

▸ getAdditionalExportSvg(): Promise‹string | null›

Implementation of IModelElementRealizer

Inherited from OrnamentDescriptorRealizer.getAdditionalExportSvg

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:115

Returns: Promise‹string | null›

getModelElement

▸ getModelElement(): OrnamentDescriptor

Implementation of IModelElementRealizer

Inherited from OrnamentDescriptorRealizer.getModelElement

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:34

Returns: OrnamentDescriptor

getScaledSizeOfOrnament

▸ getScaledSizeOfOrnament(target: Vector3‹›): Vector3 | null

Inherited from OrnamentDescriptorRealizer.getScaledSizeOfOrnament

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:170

Parameters:

Name Type Default
target Vector3‹› new Vector3()

Returns: Vector3 | null

getSizeOfOrnament

▸ getSizeOfOrnament(): Vector3 | null

Inherited from OrnamentDescriptorRealizer.getSizeOfOrnament

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:174

Returns: Vector3 | null

onRemove

▸ onRemove(removePhysicalObjects: boolean): void

Implementation of IModelElementRealizer

Overrides OrnamentDescriptorRealizer.onRemove

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:42

Parameters:

Name Type
removePhysicalObjects boolean

Returns: void

realize

▸ realize(targets: Array‹object›, lastChangeEvent: IModelElementEvent, lastTransformsChangeEvent: ITransformsChangeEvent): Promise‹void›

Overrides OrnamentDescriptorRealizer.realize

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:32

Parameters:

Name Type
targets Array‹object›
lastChangeEvent IModelElementEvent
lastTransformsChangeEvent ITransformsChangeEvent

Returns: Promise‹void›

recreateWith

▸ recreateWith(otherModelElement: OrnamentDescriptor): OrnamentDescriptorRealizer

Inherited from OrnamentDescriptorRealizer.recreateWith

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:119

Parameters:

Name Type
otherModelElement OrnamentDescriptor

Returns: OrnamentDescriptorRealizer

setAssembly

▸ setAssembly(assembly: Assembly): void

Implementation of IModelElementRealizer

Inherited from OrnamentDescriptorRealizer.setAssembly

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:123

Parameters:

Name Type
assembly Assembly

Returns: void

setLowQualityRendering

▸ setLowQualityRendering(newValue: boolean): void

Inherited from OrnamentDescriptorRealizer.setLowQualityRendering

Defined in src/model/data/Concepts/Realization/OrnamentDescriptorRealizer.ts:131

Parameters:

Name Type
newValue boolean

Returns: void

setPermanent

▸ setPermanent(): void

Implementation of IModelElementRealizer

Overrides OrnamentDescriptorRealizer.setPermanent

Defined in src/model/data/Concepts/Realization/PolygonOrnamentDescriptorRealizer.ts:48

Returns: void