Enum fretboard_layout::Variant

pub enum Variant {
    Monoscale,
    Multiscale {
        scale: f64,
        handedness: Handedness,
        pfret: f64,
    },
}

Whether to output a traditional Monoscale style neck with the same scale across it’s entire width, or a modern Multiscale neck, with a shorter scale along the treble side, also known as fan fret.

Variants

Monoscale

A traditional fretbaord where the same scale length is used all of the way across the fretboard.

Multiscale

Fields

scale: f64

The scale length along the treble side of the neck

handedness: Handedness

Right or left handed output

pfret: f64

Which fret is perpendicular to the centerline

A modern style of neck where there is a longer scale length along the bass side of the neck and a shorter scale along the treble side of the neck, allowing for more natural string tension, greater flexibility in tuning, and better ergonomics.

Implementations

impl Variant

pub fn multi() -> Self

pub fn scale(&self) -> Option<f64>

Return the treble side scale length if the neck is Multiscale, or else None

pub fn handedness(&self) -> Option<Handedness>

Returns whether the resulting neck is right or left handed, or None if the neck is Monoscale

pub fn pfret(&self) -> Option<f64>

Returns which fret is perpendicular to the centerline, or None if the fretboard is Monoscale

Trait Implementations

impl Clone for Variant

fn clone(&self) -> Variant

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Variant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Variant

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Variant

fn eq(&self, other: &Variant) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Variant

impl StructuralPartialEq for Variant