Skip to content

editor › Globals › LocalOrnamentDescriptorRealizer

Class: LocalOrnamentDescriptorRealizer

Realizes (creates/updates) an ornament based on information from an OrnamentDescriptor on the plates of the realized mesh

Hierarchy

↳ LocalOrnamentDescriptorRealizer

↳ PolygonOrnamentDescriptorRealizer

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

+ new LocalOrnamentDescriptorRealizer(ornamentDescriptor: LocalOrnamentDescriptor): LocalOrnamentDescriptorRealizer

Overrides OrnamentDescriptorRealizer.constructor

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

Parameters:

Name Type
ornamentDescriptor LocalOrnamentDescriptor

Returns: LocalOrnamentDescriptorRealizer

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: LocalOrnamentDescriptor

Overrides OrnamentDescriptorRealizer.ornamentDescriptor

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

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 OrnamentDescriptorRealizer._createOrnament

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

Returns: Promise‹void›

Protected _distanceToAssemblyPoint

▸ _distanceToAssemblyPoint(assemblyPoint: Vector3): number

Inherited from OrnamentDescriptorRealizer._distanceToAssemblyPoint

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

Parameters:

Name Type
assemblyPoint Vector3

Returns: number

Protected _getAnchorAngle

▸ _getAnchorAngle(): number

Inherited from OrnamentDescriptorRealizer._getAnchorAngle

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

Returns: number

Private _getOrnament

▸ _getOrnament(content: string | ArrayBuffer): Ornament

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

Parameters:

Name Type
content string | ArrayBuffer

Returns: Ornament

Protected _hasAnyContent

▸ _hasAnyContent(): boolean

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

Returns: boolean

Protected _hasOrnamentDescriptorContentBeenUpdated

▸ _hasOrnamentDescriptorContentBeenUpdated(): boolean

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

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

Returns: void

Protected _updateOrnament

▸ _updateOrnament(): Promise‹void›

Overrides OrnamentDescriptorRealizer._updateOrnament

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

Returns: Promise‹void›

Protected _updateOrnamentFromContent

▸ _updateOrnamentFromContent(): Promise‹void›

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

Inherited from OrnamentDescriptorRealizer.findModelElement

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

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

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

Inherited from OrnamentDescriptorRealizer.onRemove

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

Parameters:

Name Type
removePhysicalObjects boolean

Returns: void

realize

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

Inherited from OrnamentDescriptorRealizer.realize

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

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

Inherited from OrnamentDescriptorRealizer.setPermanent

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

Returns: void