editor › Globals › VerticalConfig

Class: VerticalConfig

Hierarchy

• VerticalConfig

Index

Constructors

• constructor

Properties

• additionEnd
• additionStart
• applySandingElongation
• cutoutEnd
• cutoutStart

Methods

• getAdditionConfig
• getAdditionLength
• getApplySandingElongation
• getCutoutConfig
• getCutoutLength
• getMaxAddedMaterial
• getMaxRemovedMaterial
• getOutlineDisposition
• offsetAddition
• offsetCutout
• setAdditionConfig
• setApplySandingElongation
• setCutoutConfig

Constructors

constructor

+ new VerticalConfig(additionStart: number, additionEnd: number, cutoutStart: number, cutoutEnd: number): VerticalConfig

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:31

Parameters:

Name	Type
additionStart	number
additionEnd	number
cutoutStart	number
cutoutEnd	number

Returns: VerticalConfig

Properties

Private additionEnd

• additionEnd: number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:24

---

Private additionStart

• additionStart: number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:23

---

Private applySandingElongation

• applySandingElongation: boolean = true

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:31

Whether the sandingElongation should explicitly be applied for this VerticalConfig.

---

Private cutoutEnd

• cutoutEnd: number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:26

---

Private cutoutStart

• cutoutStart: number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:25

Methods

getAdditionConfig

▸ getAdditionConfig(): object

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:43

Returns: object

• end: number

• start: number

---

getAdditionLength

▸ getAdditionLength(): number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:47

Returns: number

---

getApplySandingElongation

▸ getApplySandingElongation(): boolean

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:105

Returns: boolean

---

getCutoutConfig

▸ getCutoutConfig(): object

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:56

Returns: object

• end: number

• start: number

---

getCutoutLength

▸ getCutoutLength(): number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:60

Returns: number

---

getMaxAddedMaterial

▸ getMaxAddedMaterial(fabricationConfig: FabricationConfig): number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:69

Parameters:

Name	Type	Description
fabricationConfig	FabricationConfig	optional, if specified, specific fabrication artifacts such as sanding and kerf will be considered for the overall result value

Returns: number

The distance (from the outline section along its normal) to the physical border of the plate.

---

getMaxRemovedMaterial

▸ getMaxRemovedMaterial(fabricationConfig?: FabricationConfig): number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:81

Parameters:

Name	Type
fabricationConfig?	FabricationConfig

Returns: number

---

getOutlineDisposition

▸ getOutlineDisposition(): number

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:94

Returns: number

---

offsetAddition

▸ offsetAddition(distance: number): void

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:113

Offsets addition by the given distance. Positive distance will extend the additions.

Parameters:

Name	Type	Description
distance	number	the distance of the offset

Returns: void

---

offsetCutout

▸ offsetCutout(distance: number): void

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:122

Offsets cutout by the given distance. Positive distance will extend the additions.

Parameters:

Name	Type	Description
distance	number	the distance of the offset

Returns: void

---

setAdditionConfig

▸ setAdditionConfig(start: number, end: number): void

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:38

Parameters:

Name	Type
start	number
end	number

Returns: void

---

setApplySandingElongation

▸ setApplySandingElongation(applySandingElongation: boolean): void

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:101

Parameters:

Name	Type
applySandingElongation	boolean

Returns: void

---

setCutoutConfig

▸ setCutoutConfig(start: number, end: number): void

Defined in src/model/visualization/Joints/Renderer/FingerRendering/VerticalConfig.ts:51

Parameters:

Name	Type
start	number
end	number

Returns: void