editor › Globals › OrnamentDescriptorRealizer

Class: OrnamentDescriptorRealizer

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

Hierarchy

• OrnamentDescriptorRealizer

↳ LocalOrnamentDescriptorRealizer

Implements

• IModelElementRealizer‹OrnamentDescriptor›

Index

Constructors

• constructor

Properties

• assembly
• ornament
• ornamentDescriptor
• ornamentLoading
• plate

Methods

• _addOrnament
• _clearOrnament
• _createOrnament
• _distanceToAssemblyPoint
• _getAnchorAngle
• _removeDueToOtherOrnaments
• _updateOrnament
• _updateOrnamentOffset
• _updateOrnamentRotation
• _updateOrnamentScale
• _updateOrnamentSync
• beforeExport
• checkValidityAndCleanUp
• findModelElement
• getAdditionalExportSvg
• getModelElement
• getScaledSizeOfOrnament
• getSizeOfOrnament
• onRemove
• realize
• recreateWith
• setAssembly
• setLowQualityRendering
• setPermanent

Constructors

constructor

+ new OrnamentDescriptorRealizer(ornamentDescriptor: OrnamentDescriptor): OrnamentDescriptorRealizer

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

Parameters:

Name	Type
ornamentDescriptor	OrnamentDescriptor

Returns: OrnamentDescriptorRealizer

Properties

Protected assembly

• assembly: Assembly

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

---

Protected ornament

• ornament: Ornament | null = null

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

---

Protected ornamentDescriptor

• ornamentDescriptor: OrnamentDescriptor | null

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

---

Private ornamentLoading

• ornamentLoading: boolean = false

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

---

Protected plate

• plate: Plate

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

Methods

Protected _addOrnament

▸ _addOrnament(): Promise‹void›

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

Returns: Promise‹void›

---

Protected _clearOrnament

▸ _clearOrnament(): void

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

Returns: void

---

Protected _createOrnament

▸ _createOrnament(): Promise‹void›

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

Returns: Promise‹void›

---

Protected _distanceToAssemblyPoint

▸ _distanceToAssemblyPoint(assemblyPoint: Vector3): number

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

Parameters:

Name	Type
assemblyPoint	Vector3

Returns: number

---

Protected _getAnchorAngle

▸ _getAnchorAngle(): number

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

Returns: number

---

Protected _removeDueToOtherOrnaments

▸ _removeDueToOtherOrnaments(): boolean

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 _updateOrnament

▸ _updateOrnament(): Promise‹void›

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

Returns: Promise‹void›

---

Protected _updateOrnamentOffset

▸ _updateOrnamentOffset(): void

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

Returns: void

---

Protected _updateOrnamentRotation

▸ _updateOrnamentRotation(): void

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

Returns: void

---

Protected _updateOrnamentScale

▸ _updateOrnamentScale(): void

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

Returns: void

---

Protected _updateOrnamentSync

▸ _updateOrnamentSync(): void

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

Returns: void

---

beforeExport

▸ beforeExport(): void

Implementation of IModelElementRealizer

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

Returns: void

---

checkValidityAndCleanUp

▸ checkValidityAndCleanUp(): void

Implementation of IModelElementRealizer

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

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

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

Returns: Promise‹string | null›

---

getModelElement

▸ getModelElement(): OrnamentDescriptor

Implementation of IModelElementRealizer

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

Returns: OrnamentDescriptor

---

getScaledSizeOfOrnament

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

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

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

Returns: Vector3 | null

---

onRemove

▸ onRemove(removePhysicalObjects: boolean): void

Implementation of IModelElementRealizer

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›

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

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

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

Parameters:

Name	Type
assembly	Assembly

Returns: void

---

setLowQualityRendering

▸ setLowQualityRendering(newValue: boolean): void

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

Parameters:

Name	Type
newValue	boolean

Returns: void

---

setPermanent

▸ setPermanent(): void

Implementation of IModelElementRealizer

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

Returns: void