editor › Globals › HintHelper

Class: HintHelper

Hierarchy

• HintHelper

Index

Properties

• groupId

Methods

• _addEdgeAngleHintToEdge
• _addSurfaceAngleHintToEdge
• _addToManager
• _createAngleHintForMakerAsset
• _createLengthEdgeHintsForAssembly
• _createLengthEdgeHintsForDummyMesh
• _createLengthEdgeHintsForPhysicalObject
• _createLengthEdgeHintsForPlate
• _createLengthHintsForAssembly
• _createLengthHintsForPhysicalObject
• _createLengthHintsForPlate
• _createLengthHintsForRod
• _createMakerAssetAngleHintsForAssembly
• _createTessellationSeamHintsForAssembly
• _createVertexHintsForAssembly
• _generateHintAt
• clearHints
• filterHints
• groupHints
• highlightHintColor
• showAllHints
• showEdgeAngleHintsForMovingEdge
• showHintsForPlate
• showLengthEdgeHints
• showLengthEdgeHintsForAssembly
• showLengthHints
• showMakerAssetAngleHints
• showPlateNameHints
• showRoundEdgeRadiusHints
• showSurfaceAngleHintsForMovingEdge
• showTessellationSeamHints
• showVertexHints
• ungroupHints
• unhighlightHintColor

Properties

Static Private groupId

▪ groupId: number = 0

Defined in src/renderContext/hints/HintHelper.ts:51

Methods

Static Private _addEdgeAngleHintToEdge

▸ _addEdgeAngleHintToEdge(edge: MeshHalfEdge, mesh: any, hintManager: HintManager): void

Defined in src/renderContext/hints/HintHelper.ts:301

Parameters:

Name	Type
edge	MeshHalfEdge
mesh	any
hintManager	HintManager

Returns: void

---

Static Private _addSurfaceAngleHintToEdge

▸ _addSurfaceAngleHintToEdge(edge: MeshHalfEdge, mesh: any, hintManager: HintManager): AngleAnnotationHint‹›

Defined in src/renderContext/hints/HintHelper.ts:315

Parameters:

Name	Type
edge	MeshHalfEdge
mesh	any
hintManager	HintManager

Returns: AngleAnnotationHint‹›

---

Static Private _addToManager

▸ _addToManager(renderContext: RenderContext, hints: FilterableHint[]): PriorityHintFilterStrategy | null

Defined in src/renderContext/hints/HintHelper.ts:364

Parameters:

Name	Type
renderContext	RenderContext
hints	FilterableHint[]

Returns: PriorityHintFilterStrategy | null

---

Static Private _createAngleHintForMakerAsset

▸ _createAngleHintForMakerAsset(makerAsset: MakerAsset): object

Defined in src/renderContext/hints/HintHelper.ts:449

Parameters:

Name	Type
makerAsset	MakerAsset

Returns: object

• hints: AngleAnnotationHint[]

• rotationHelpers: AssetRotationHelper[]

---

Static Private _createLengthEdgeHintsForAssembly

▸ _createLengthEdgeHintsForAssembly(assembly: Assembly, filter?: function, hintGenerator?: function): LengthAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:424

Parameters:

▪ assembly: Assembly

▪Optional filter: function

▸ (outlineEdge: MeshHalfEdge): boolean

Parameters:

Name	Type
outlineEdge	MeshHalfEdge

▪Optional hintGenerator: function

▸ (plate: Plate, outlineEdge: MeshHalfEdge): EdgeHint[]

Parameters:

Name	Type
plate	Plate
outlineEdge	MeshHalfEdge

Returns: LengthAnnotationHint[]

---

Static Private _createLengthEdgeHintsForDummyMesh

▸ _createLengthEdgeHintsForDummyMesh(dummyMesh: DummyMesh): DummyMeshEdgeLengthHint[]

Defined in src/renderContext/hints/HintHelper.ts:508

Parameters:

Name	Type
dummyMesh	DummyMesh

Returns: DummyMeshEdgeLengthHint[]

---

Static Private _createLengthEdgeHintsForPhysicalObject

▸ _createLengthEdgeHintsForPhysicalObject(physicalObject: any, filter?: function, hintGenerator?: function): LengthAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:436

Parameters:

▪ physicalObject: any

▪Optional filter: function

▸ (outlineEdge: MeshHalfEdge): boolean

Parameters:

Name	Type
outlineEdge	MeshHalfEdge

▪Optional hintGenerator: function

▸ (plate: Plate, outlineEdge: MeshHalfEdge): EdgeHint[]

Parameters:

Name	Type
plate	Plate
outlineEdge	MeshHalfEdge

Returns: LengthAnnotationHint[]

---

Static Private _createLengthEdgeHintsForPlate

▸ _createLengthEdgeHintsForPlate(plate: Plate, filter: function, hintGenerator: function): EdgeHint[]

Defined in src/renderContext/hints/HintHelper.ts:477

Parameters:

▪ plate: Plate

▪Default value filter: function= outlineEdge => true

▸ (outlineEdge: MeshHalfEdge): boolean

Parameters:

Name	Type
outlineEdge	MeshHalfEdge

▪Default value hintGenerator: function= (plate, outlineEdge) => { const hints: EdgeHint[] = []; const realizer = plate.getRealizer() as HullPlateRealizer; const mesh = realizer.getModelElement(); const lengthSemantic = Config.get("hints.defaultSectionLengthSemantic", "innerLength"); let anchor = new MeshEdgeAnchor(); anchor.initializeFromElement(mesh, outlineEdge); hints.push(new EdgeHint(anchor, realizer, mesh.getAssembly(), lengthSemantic, Alignment.LEFT)); anchor = new MeshEdgeAnchor(); anchor.initializeFromElement(mesh, outlineEdge); hints.push(new EdgeHint(anchor, realizer, mesh.getAssembly(), lengthSemantic, Alignment.RIGHT)); return hints; }

▸ (plate: Plate, outlineEdge: MeshHalfEdge): EdgeHint[]

Parameters:

Name	Type
plate	Plate
outlineEdge	MeshHalfEdge

Returns: EdgeHint[]

---

Static Private _createLengthHintsForAssembly

▸ _createLengthHintsForAssembly(assembly: Assembly): LengthAnnotationHint‹›[]

Defined in src/renderContext/hints/HintHelper.ts:405

Parameters:

Name	Type
assembly	Assembly

Returns: LengthAnnotationHint‹›[]

---

Static Private _createLengthHintsForPhysicalObject

▸ _createLengthHintsForPhysicalObject(physicalObject: PhysicalObject): LengthAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:413

Parameters:

Name	Type
physicalObject	PhysicalObject

Returns: LengthAnnotationHint[]

---

Static Private _createLengthHintsForPlate

▸ _createLengthHintsForPlate(plate: Plate): LengthAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:465

Parameters:

Name	Type
plate	Plate

Returns: LengthAnnotationHint[]

---

Static Private _createLengthHintsForRod

▸ _createLengthHintsForRod(rod: any): LengthAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:540

Parameters:

Name	Type
rod	any

Returns: LengthAnnotationHint[]

---

Static Private _createMakerAssetAngleHintsForAssembly

▸ _createMakerAssetAngleHintsForAssembly(assembly: Assembly): Array‹object›

Defined in src/renderContext/hints/HintHelper.ts:397

Parameters:

Name	Type
assembly	Assembly

Returns: Array‹object›

---

Static Private _createTessellationSeamHintsForAssembly

▸ _createTessellationSeamHintsForAssembly(assembly: Assembly): FilterableHtmlAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:329

Parameters:

Name	Type
assembly	Assembly

Returns: FilterableHtmlAnnotationHint[]

---

Static Private _createVertexHintsForAssembly

▸ _createVertexHintsForAssembly(assembly: Assembly): FilterableHint[]

Defined in src/renderContext/hints/HintHelper.ts:544

Parameters:

Name	Type
assembly	Assembly

Returns: FilterableHint[]

---

Static Private _generateHintAt

▸ _generateHintAt(meshPosition: Vector3, assembly: Assembly, tessellationDescriptor: TessellationDescriptor): FilterableHtmlAnnotationHint

Defined in src/renderContext/hints/HintHelper.ts:348

Parameters:

Name	Type
meshPosition	Vector3
assembly	Assembly
tessellationDescriptor	TessellationDescriptor

Returns: FilterableHtmlAnnotationHint

---

Static clearHints

▸ clearHints(hintsToRemove: Hint[], renderContext: any): void

Defined in src/renderContext/hints/HintHelper.ts:243

Removes the given hints and destroys them

Parameters:

Name	Type	Description
hintsToRemove	Hint[]	-
renderContext	any	-

Returns: void

---

Static filterHints

▸ filterHints(renderContext: any, filterFunction: function): void

Defined in src/renderContext/hints/HintHelper.ts:208

Parameters:

▪ renderContext: any

▪ filterFunction: function

▸ (Hint: any): boolean

Parameters:

Name	Type
Hint	any

Returns: void

---

Static groupHints

▸ groupHints(hints: FilterableHint[]): void

Defined in src/renderContext/hints/HintHelper.ts:218

Grouping hints will cause them to only be deduplicated within their group. This overrides any previous groupings.

Parameters:

Name	Type	Description
hints	FilterableHint[]	the hints to group

Returns: void

---

Static highlightHintColor

▸ highlightHintColor(renderContext: any, hints: Hint[]): void

Defined in src/renderContext/hints/HintHelper.ts:228

Parameters:

Name	Type
renderContext	any
hints	Hint[]

Returns: void

---

Static showAllHints

▸ showAllHints(renderContext: any, compositeModel: CompositeModel): void

Defined in src/renderContext/hints/HintHelper.ts:53

Parameters:

Name	Type
renderContext	any
compositeModel	CompositeModel

Returns: void

---

Static showEdgeAngleHintsForMovingEdge

▸ showEdgeAngleHintsForMovingEdge(renderContext: RenderContext, edge: MeshHalfEdge, mesh: Mesh): void

Defined in src/renderContext/hints/HintHelper.ts:276

Parameters:

Name	Type
renderContext	RenderContext
edge	MeshHalfEdge
mesh	Mesh

Returns: void

---

Static showHintsForPlate

▸ showHintsForPlate(hintManager: any, plate: Plate): LengthAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:189

Show length hints for a specific plate

Parameters:

Name	Type	Description
hintManager	any	-
plate	Plate	-

Returns: LengthAnnotationHint[]

---

Static showLengthEdgeHints

▸ showLengthEdgeHints(renderContext: any, compositeModel: CompositeModel, filter?: function, hintGenerator?: function): EdgeHint[]

Defined in src/renderContext/hints/HintHelper.ts:107

Shows edge hints for all edges

Parameters:

▪ renderContext: any

-

▪ compositeModel: CompositeModel

-

▪Optional filter: function

-

▸ (outlineEdge: MeshHalfEdge): boolean

Parameters:

Name	Type
outlineEdge	MeshHalfEdge

▪Optional hintGenerator: function

-

▸ (plate: Plate, outlineEdge: MeshHalfEdge): EdgeHint[]

Parameters:

Name	Type
plate	Plate
outlineEdge	MeshHalfEdge

Returns: EdgeHint[]

---

Static showLengthEdgeHintsForAssembly

▸ showLengthEdgeHintsForAssembly(renderContext: any, compositeModel: CompositeModel, assembly: Assembly): LengthAnnotationHint[]

Defined in src/renderContext/hints/HintHelper.ts:195

Parameters:

Name	Type
renderContext	any
compositeModel	CompositeModel
assembly	Assembly

Returns: LengthAnnotationHint[]

---

Static showLengthHints

▸ showLengthHints(renderContext: any, compositeModel: CompositeModel): any[]

Defined in src/renderContext/hints/HintHelper.ts:91

Shows length hints for all sections

Parameters:

Name	Type	Description
renderContext	any	-
compositeModel	CompositeModel	-

Returns: any[]

---

Static showMakerAssetAngleHints

▸ showMakerAssetAngleHints(renderContext: any, compositeModel: CompositeModel): Array‹object›

Defined in src/renderContext/hints/HintHelper.ts:124

Shows AngleAnnotationHints for all Maker Assets in the composite model

Parameters:

Name	Type
renderContext	any
compositeModel	CompositeModel

Returns: Array‹object›

---

Static showPlateNameHints

▸ showPlateNameHints(hintManager: HintManager, canvasDimensions: Vector3, plateNames: Map‹Plate, string›): void

Defined in src/renderContext/hints/HintHelper.ts:249

Parameters:

Name	Type
hintManager	HintManager
canvasDimensions	Vector3
plateNames	Map‹Plate, string›

Returns: void

---

Static showRoundEdgeRadiusHints

▸ showRoundEdgeRadiusHints(renderContext: any, roundEdge: RoundEdgeDescriptor, realizer: RoundEdgeDescriptorRealizer): Hint[]

Defined in src/renderContext/hints/HintHelper.ts:159

Parameters:

Name	Type
renderContext	any
roundEdge	RoundEdgeDescriptor
realizer	RoundEdgeDescriptorRealizer

Returns: Hint[]

---

Static showSurfaceAngleHintsForMovingEdge

▸ showSurfaceAngleHintsForMovingEdge(renderContext: RenderContext, edge: MeshHalfEdge, mesh: Mesh): AngleAnnotationHint‹›

Defined in src/renderContext/hints/HintHelper.ts:288

Parameters:

Name	Type
renderContext	RenderContext
edge	MeshHalfEdge
mesh	Mesh

Returns: AngleAnnotationHint‹›

---

Static showTessellationSeamHints

▸ showTessellationSeamHints(renderContext: any, compositeModel: CompositeModel, previousHintFilterStrategy: PriorityHintFilterStrategy): PriorityHintFilterStrategy‹›

Defined in src/renderContext/hints/HintHelper.ts:58

Parameters:

Name	Type
renderContext	any
compositeModel	CompositeModel
previousHintFilterStrategy	PriorityHintFilterStrategy

Returns: PriorityHintFilterStrategy‹›

---

Static showVertexHints

▸ showVertexHints(renderContext: any, compositeModel: CompositeModel): Hint[]

Defined in src/renderContext/hints/HintHelper.ts:143

Show hints for all vertexPositions

Parameters:

Name	Type	Description
renderContext	any	-
compositeModel	CompositeModel	-

Returns: Hint[]

---

Static ungroupHints

▸ ungroupHints(hints: FilterableHint[]): void

Defined in src/renderContext/hints/HintHelper.ts:224

Parameters:

Name	Type
hints	FilterableHint[]

Returns: void

---

Static unhighlightHintColor

▸ unhighlightHintColor(renderContext: any, hints: Hint[]): void

Defined in src/renderContext/hints/HintHelper.ts:233

Parameters:

Name	Type
renderContext	any
hints	Hint[]

Returns: void