editor › Globals › SurfaceDisabledAnnotation

Class: SurfaceDisabledAnnotation

Hierarchy

• MeshAnnotation

↳ SurfaceDisabledAnnotation

Index

Properties

• changeEventEmitter

Methods

• _cloneWith
• destroy
• getAnchor
• getChangeEventEmitter
• getInMeshTarget
• setAnchor
• fromSurface

Properties

Protected Readonly changeEventEmitter

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

Inherited from MeshAnnotation.changeEventEmitter

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 _cloneWith

▸ _cloneWith(newAnchor: MeshSurfaceAnchor): MeshAnnotation

Overrides MeshAnnotation._cloneWith

Defined in src/model/data/Concepts/Mesh/SurfaceDisabledAnnotation.ts:15

Parameters:

Name	Type
newAnchor	MeshSurfaceAnchor

Returns: MeshAnnotation

---

destroy

▸ destroy(): void

Inherited from MeshAnnotation.destroy

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

Returns: void

---

getAnchor

▸ getAnchor(): IMeshAnchor

Inherited from MeshAnnotation.getAnchor

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

Returns: IMeshAnchor

the anchor that points to the target

---

getChangeEventEmitter

▸ getChangeEventEmitter(): IPublicEventEmitterInterface‹void›

Inherited from MeshAnnotation.getChangeEventEmitter

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

Returns: IPublicEventEmitterInterface‹void›

---

getInMeshTarget

▸ getInMeshTarget(): MeshElement

Inherited from MeshAnnotation.getInMeshTarget

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

Inherited from MeshAnnotation.setAnchor

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

Parameters:

Name	Type
anchor	IMeshAnchor

Returns: void

---

Static fromSurface

▸ fromSurface(mesh: Mesh, meshSurface: MeshSurface): SurfaceDisabledAnnotation

Defined in src/model/data/Concepts/Mesh/SurfaceDisabledAnnotation.ts:7

Parameters:

Name	Type
mesh	Mesh
meshSurface	MeshSurface

Returns: SurfaceDisabledAnnotation