Struct Sheet 

pub struct Sheet {

    pub id: String,
    pub name: String,
    pub size: String,
    pub width_mm: f64,
    pub height_mm: f64,
    pub border: bool,
    pub border_inset_mm: f64,
    pub title_block: bool,
    pub notes: String,
    pub views: Vec<PlacedView>,
    pub dimensions: Vec<SheetDimension>,
    pub ordinates: Vec<SheetOrdinate>,
    pub revisions: Vec<Revision>,
    pub bom_table: Option<BomTable>,
}

One sheet of paper.

Fields

id: String

name: String

size: String

A PAPER_SIZES key, or CUSTOM.

width_mm: f64

height_mm: f64

border: bool

Draw the BORDER: the rectangle inset from the paper’s edge that the drawing lives inside. On by default; a sheet may switch it off.

border_inset_mm: f64

How far the border sits from the paper’s edge, millimetres. It is also the margin the TITLE BLOCK is placed against, so a sheet with no border still has a margin.

title_block: bool

Draw the TITLE BLOCK in the paper’s bottom-right corner, inside the border. On by default.

notes: String

The title block’s free text field — whatever the drawing has to say.

views: Vec<PlacedView>

dimensions: Vec<SheetDimension>

The sheet’s OWN dimensions — drawn on the paper, anchored to the projected geometry of the placements above (dimension). A sheet saved before they existed simply has none.

ordinates: Vec<SheetOrdinate>

The sheet’s ORDINATE SETS (ordinate) — a datum and a run of members, each reading its signed distance from the datum. Beside the dimensions rather than among them: a set measures any number of points against one origin and draws no dimension line, which is a different object and not a fifth kind.

revisions: Vec<Revision>

The sheet’s REVISIONS, oldest first as the user keeps them — drawn as the revision table beside the title block (frame). A sheet saved before they existed has none, and a sheet with none draws no table.

bom_table: Option<BomTable>

Implementations

impl Sheet

pub fn millimetres(&self) -> (f64, f64)

The paper’s millimetres: the preset’s when size names one (so a preset sheet cannot drift), else the stored custom pair.

pub fn border_inset(&self) -> f64

The border’s inset, clamped to something the paper can carry: a sheet whose inset ate the page would have no drawing area at all.

pub fn find_view(&self, id: &str) -> Option<&PlacedView>

pub fn find_view_mut(&mut self, id: &str) -> Option<&mut PlacedView>

pub fn find_dimension(&self, id: &str) -> Option<&SheetDimension>

pub fn find_ordinate(&self, id: &str) -> Option<&SheetOrdinate>

pub fn next_view_letter(&self, views: &[PmiView]) -> String

The next view LETTER this sheet has not handed out, for a section or a detail alike: the two draw from ONE run of letters, because a drawing with a SECTION A—A and a DETAIL A names two different views with one letter. A sheet past Z reuses the last one rather than refusing the view: two views sharing a letter is a drawing-office mistake, not a broken document, and the form is where it is corrected. views are the document’s PMI views: a placement of a SECTIONED saved view holds a letter too (Self::view_letters).

pub fn view_letters(&self, views: &[PmiView]) -> Vec<Option<String>>

Each placement’s letter, in placement order. A section or a detail carries its own. A plain placement of a saved view that is itself SECTIONED (its PMI view’s display has a section) is captioned SECTION A—A too, and takes the first letter nothing stored holds and no earlier such placement took — so it is the same letter every time the sheet is drawn, and a section or detail added later skips it.

impl Sheet

pub fn params(&self) -> Value

The params the Sheet form edits, as the schema shapes them.

pub fn apply(&mut self, params: &Value) -> Result<(), String>

Apply an edited Sheet form. id is identity and is never taken from the form.

Trait Implementations

impl Clone for Sheet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sheet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sheet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sheet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Sheet

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sheet