Struct fretboard_layout::Specs

pub struct Specs {
    pub scale: f64,
    pub count: u32,
    pub variant: Variant,
    pub nut: f64,
    pub bridge: f64,
    pub pfret: f64,
}

This struct contains the user data used to create the svg output file

Fields

scale: f64

Scale length. For multiscale designs this is the bass side scale length.

count: u32

Number of frets to render

variant: Variant

Monoscale or Multiscale Right orLeft handed

nut: f64

The width of the fretboard at the nut.

bridge: f64

The string spacing at the bridge. Note that this is not the physical width of the bridge, but the distance perpendicular to the centerline between the outer two strings.

pfret: f64

The fret that is perpendicular to the centerline.

Implementations

impl Specs

pub fn multi() -> Specs

Returns a multiscale Specs struct

pub fn set_scale(&mut self, scale: f64)

pub fn set_count(&mut self, count: u32)

pub fn set_multi(&mut self, scale: Option<f64>)

pub fn set_nut(&mut self, nut: f64)

pub fn set_bridge(&mut self, bridge: f64)

pub fn set_pfret(&mut self, pfret: f64)

pub fn get_fret_lengths(&self, fret: u32) -> Lengths

Returns the length from bridge to fret for a given fret number, along both bass and treble sides of the board.

pub fn get_all_lengths(&self) -> Vec<Lengths>

Returns a vector containing the lengths from bridge to fret for all of the frets to be rendered.

pub fn create_document(&self, conf: Option<Config>) -> Document

Returns the complete svg Document

Example

use fretboard_layout::{Config, Specs};

fn run() {
    let specs = Specs::default();
    let doc = specs.create_document(Some(Config::default()));
}

Trait Implementations

impl Default for Specs

fn default() -> Self

Returns the “default value” for a type.