editor › Globals › AssemblyInstructionHints

Class: AssemblyInstructionHints

Hierarchy

• AssemblyInstructionHints

Index

Constructors

• constructor

Properties

• assemblyInstructions

Methods

• _addJointHints
• _addSurfaceJointHints
• _getCellMembraneJointHintText
• _getEdgeJointHintText
• _getJointHintText
• _getSectionJointHintPosition
• _getTeeJointHintText
• _mirrorCoordinates
• _mirrorDirection
• _offsetPolygon
• _positionTextAlongSection
• addGroupID
• addHintsForGroup
• addJointId
• _getCentralPositionWithinPolygon
• _mirrorDirection
• determineArrowAndDirection

Constructors

constructor

+ new AssemblyInstructionHints(assemblyInstructions: SubassemblyInstruction): AssemblyInstructionHints

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:52

Parameters:

Name	Type
assemblyInstructions	SubassemblyInstruction

Returns: AssemblyInstructionHints

Properties

Private assemblyInstructions

• assemblyInstructions: SubassemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:52

Methods

Private _addJointHints

▸ _addJointHints(svgBuilder: SvgBuilder, plate: any, group: PlateGroup, groupPolygon: any, offsetGroupPolygon: MultiPolygon, mirrorGroup: any, svgNode: any, svgStylizer: AbstractSvgStylizer): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:183

Parameters:

Name	Type
svgBuilder	SvgBuilder
plate	any
group	PlateGroup
groupPolygon	any
offsetGroupPolygon	MultiPolygon
mirrorGroup	any
svgNode	any
svgStylizer	AbstractSvgStylizer

Returns: void

---

Private _addSurfaceJointHints

▸ _addSurfaceJointHints(svgBuilder: SvgBuilder, plate: any, group: any, groupPolygon: MultiPolygon, offsetGroupPolygon: MultiPolygon, mirrorGroup: boolean, svgNode: any, svgStylizer: AbstractSvgStylizer): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:270

Parameters:

Name	Type
svgBuilder	SvgBuilder
plate	any
group	any
groupPolygon	MultiPolygon
offsetGroupPolygon	MultiPolygon
mirrorGroup	boolean
svgNode	any
svgStylizer	AbstractSvgStylizer

Returns: void

---

Private _getCellMembraneJointHintText

▸ _getCellMembraneJointHintText(joint: CellMembraneJoint, plate: any): string

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:396

Parameters:

Name	Type
joint	CellMembraneJoint
plate	any

Returns: string

---

Private _getEdgeJointHintText

▸ _getEdgeJointHintText(edgeJoint: any, section: any, plate: any, plateSide: any): string

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:335

Parameters:

Name	Type
edgeJoint	any
section	any
plate	any
plateSide	any

Returns: string

---

Private _getJointHintText

▸ _getJointHintText(joint: any, plate: any): string

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:386

Parameters:

Name	Type
joint	any
plate	any

Returns: string

---

Private _getSectionJointHintPosition

▸ _getSectionJointHintPosition(section: any, plateMatrix: Matrix4, mirrorGroup: any, groupPolygon: MultiPolygon, offsetGroupPolygon: MultiPolygon): any

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:359

Parameters:

Name	Type
section	any
plateMatrix	Matrix4
mirrorGroup	any
groupPolygon	MultiPolygon
offsetGroupPolygon	MultiPolygon

Returns: any

---

Private _getTeeJointHintText

▸ _getTeeJointHintText(teeJoint: any, plate: any): string

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:354

Parameters:

Name	Type
teeJoint	any
plate	any

Returns: string

---

Private _mirrorCoordinates

▸ _mirrorCoordinates(point: Vector3, groupPolygon: MultiPolygon, mirrorX: boolean, mirrorY: boolean): Vector3‹›

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:409

Parameters:

Name	Type	Default
point	Vector3	-
groupPolygon	MultiPolygon	-
mirrorX	boolean	false
mirrorY	boolean	true

Returns: Vector3‹›

---

Private _mirrorDirection

▸ _mirrorDirection(direction: Vector3, mirror: boolean): Vector3‹›

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:402

Parameters:

Name	Type	Default
direction	Vector3	-
mirror	boolean	false

Returns: Vector3‹›

---

Private _offsetPolygon

▸ _offsetPolygon(multiPolygon: MultiPolygon, offset: number): MultiPolygon

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:163

Offsets the polygon to the inside by offset, i.e. the polygon gets smaller if you pass a positive number, holes get bigger.

Parameters:

Name	Type	Description
multiPolygon	MultiPolygon	-
offset	number	-

Returns: MultiPolygon

a new MultiPolygon offset by offset.

---

Private _positionTextAlongSection

▸ _positionTextAlongSection(svgBuilder: SvgBuilder, textNode: any, section: any, plateMatrix: Matrix4, mirrorGroup: boolean, groupPolygon: MultiPolygon, offsetGroupPolygon: MultiPolygon): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:244

Parameters:

Name	Type
svgBuilder	SvgBuilder
textNode	any
section	any
plateMatrix	Matrix4
mirrorGroup	boolean
groupPolygon	MultiPolygon
offsetGroupPolygon	MultiPolygon

Returns: void

---

addGroupID

▸ addGroupID(svgBuilder: SvgBuilder, group: PlateGroup, groupPolygon: MultiPolygon, mirrorGroup: boolean, svgNode: any, svgStylizer: AbstractSvgStylizer, customNumber: number): XMLElement

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:96

Adds the group ID text to the svg

Parameters:

Name	Type	Default	Description
svgBuilder	SvgBuilder	-	-
group	PlateGroup	-	The group to add the id text to
groupPolygon	MultiPolygon	-	The polygon of the group
mirrorGroup	boolean	-	Whether the group is mirrored around the x axis in the export
svgNode	any	-	The svgNode to add the text to
svgStylizer	AbstractSvgStylizer	-	decides how to render the id into the svg
customNumber	number	this.assemblyInstructions.getGroupIdByGroup(group)	-

Returns: XMLElement

---

addHintsForGroup

▸ addHintsForGroup(svgBuilder: SvgBuilder, group: PlateGroup, groupPolygon: MultiPolygon, mirrorGroup: any, svgNode: any, svgStylizer: AbstractSvgStylizer): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:63

Parameters:

Name	Type
svgBuilder	SvgBuilder
group	PlateGroup
groupPolygon	MultiPolygon
mirrorGroup	any
svgNode	any
svgStylizer	AbstractSvgStylizer

Returns: void

---

addJointId

▸ addJointId(svgBuilder: SvgBuilder, group: PlateGroup, identifier: string, center: Vector3, textAngle: number, svgNode: any, svgStylizer: AbstractSvgStylizer): XMLElement

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:134

Adds the joint-connection identifier (usually char) to the svg

Parameters:

Name	Type	Description
svgBuilder	SvgBuilder	-
group	PlateGroup	The group to add the id text to
identifier	string	The text that goes next to the joint (usually one char)
center	Vector3	The center position of the joint
textAngle	number	The angle of the normal of the joint (degrees)
svgNode	any	The svgNode to add the text to
svgStylizer	AbstractSvgStylizer	decides how to render the id into the svg

Returns: XMLElement

---

Static _getCentralPositionWithinPolygon

▸ _getCentralPositionWithinPolygon(multiPolygon: MultiPolygon): Vector3

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:20

Parameters:

Name	Type
multiPolygon	MultiPolygon

Returns: Vector3

---

Static Private _mirrorDirection

▸ _mirrorDirection(direction: Vector3, mirror: boolean): Vector3‹›

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:45

Parameters:

Name	Type	Default
direction	Vector3	-
mirror	boolean	false

Returns: Vector3‹›

---

Static determineArrowAndDirection

▸ determineArrowAndDirection(plate: any, mirrorGroup: boolean): object

Defined in src/modules/kyub.core.svgObjExporter/src/export/AssemblyInstructionHints.ts:26

Parameters:

Name	Type
plate	any
mirrorGroup	boolean

Returns: object

• textAngle: number

• textPrefix: string