Skip to content

editor › Globals › EdgeUnfoldingAnnotation

Class: EdgeUnfoldingAnnotation

Holds information used by the HullPlateRealizer to display and to serialize the unfoldings of a Mesh.

Hierarchy

↳ EdgeUnfoldingAnnotation

Index

Properties

Methods

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.

Private isConnection

• isConnection: boolean = EdgeUnfoldingAnnotation.getDefaultUnfoldingProperties().isConnection

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:33

Private isInvalid

• isInvalid: boolean = EdgeUnfoldingAnnotation.getDefaultUnfoldingProperties().isInvalid

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:34

Methods

Protected _cloneWith

▸ _cloneWith(newAnchor: MeshEdgeAnchor): MeshAnnotation

Overrides MeshAnnotation._cloneWith

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:69

Parameters:

Name Type
newAnchor MeshEdgeAnchor

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

getIsConnection

▸ getIsConnection(): boolean

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:47

Returns: boolean

getIsInvalid

▸ getIsInvalid(): boolean

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:58

Returns: boolean

getProperties

▸ getProperties(): IEdgeUnfoldingProperties

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:36

Returns: IEdgeUnfoldingProperties

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

setIsConnection

▸ setIsConnection(isConnection: boolean): void

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:51

Parameters:

Name Type
isConnection boolean

Returns: void

setIsInvalid

▸ setIsInvalid(isInvalid: boolean): void

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:62

Parameters:

Name Type
isInvalid boolean

Returns: void

toggleIsConnection

▸ toggleIsConnection(): void

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:43

Returns: void

Static fromEdge

▸ fromEdge(mesh: Mesh, edge: MeshHalfEdge): EdgeUnfoldingAnnotation‹›

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:19

Parameters:

Name Type Description
mesh Mesh the mesh containing the annotated edge
edge MeshHalfEdge the edge that either is connected in the unfolding or not

Returns: EdgeUnfoldingAnnotation‹›

Static getDefaultUnfoldingProperties

▸ getDefaultUnfoldingProperties(): IEdgeUnfoldingProperties

Defined in src/model/data/Concepts/Mesh/EdgeUnfoldingAnnotation.ts:26

Returns: IEdgeUnfoldingProperties