editor › Globals › MeshAnnotation

Class: MeshAnnotation

An annotation annotates something on a Mesh's surface, edge or points, using specialized anchors for localization.

In contrast to concepts, annotations won't be realized and are solely relevant as additional data for the mesh's realizer.

Hierarchy

• MeshAnnotation

↳ SurfaceDisabledAnnotation

↳ EdgeUnfoldingAnnotation

↳ SurfaceDisplayAnnotation

Index

Properties

• anchor
• changeEventEmitter

Methods

• _cloneWith
• _onAnchorChange
• destroy
• getAnchor
• getChangeEventEmitter
• getInMeshTarget
• setAnchor

Properties

Private anchor

• anchor: IMeshAnchor

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:22

---

Protected Readonly changeEventEmitter

• changeEventEmitter: EventEmitter‹void› = new EventEmitter()

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:20

Child classes should fire this event if their values changed and the mesh should know about it.

Methods

Protected Abstract _cloneWith

▸ _cloneWith(newAnchor: IMeshAnchor): MeshAnnotation

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:71

When the anchor splits, we need to clone the annotation for each split result

Parameters:

Name	Type	Description
newAnchor	IMeshAnchor	the clone should utilize the newAnchor

Returns: MeshAnnotation

---

Private _onAnchorChange

▸ _onAnchorChange(event: IMeshAnchorChangeEvent): void

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:73

Parameters:

Name	Type
event	IMeshAnchorChangeEvent

Returns: void

---

destroy

▸ destroy(): void

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:45

Returns: void

---

getAnchor

▸ getAnchor(): IMeshAnchor

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:52

Returns: IMeshAnchor

the anchor that points to the target

---

getChangeEventEmitter

▸ getChangeEventEmitter(): IPublicEventEmitterInterface‹void›

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:56

Returns: IPublicEventEmitterInterface‹void›

---

getInMeshTarget

▸ getInMeshTarget(): MeshElement

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:63

Returns: MeshElement

what this annotation points to inside the mesh

---

setAnchor

▸ setAnchor(anchor: IMeshAnchor): void

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:24

Parameters:

Name	Type
anchor	IMeshAnchor

Returns: void