Struct fretboard_layout::Factors

pub struct Factors {
    pub x_ratio: f64,
    pub y_ratio: f64,
    pub treble_offset: f64,
}

This struct contains multiplication factors used to convert the raw lengths from bridge to fret into x,y coordinates. It also contains an offset distance used to correctly orient the two scales in a multiscale design so that the desired fret is perpendicular to the centerline.

Fields

x_ratio: f64

y_ratio: f64

This ratio is half the difference between the nut and bridge divided by the scale and is used in determining the X ratio

treble_offset: f64

How far forward the treble side of the bridge should start with respect to the trable side

Implementations

impl Factors

pub fn init(scale: f64, variant: &Variant, nut: f64, bridge: f64) -> Self

Uses trigonometry to place the fret ends, based on visualizing their locations as a triangle where the hypotenuse is the string, and the opposite is the distance from the bridge parallel to the centerline.

Trait Implementations

impl Default for Factors

fn default() -> Self

Returns the “default value” for a type.