Struct PcbEditSession 

pub struct PcbEditSession {
    pub doc: PcbDoc,
    /* private fields */
}

PCB editing session for comprehensive document modification.

Fields

doc: PcbDoc

The PCB document being edited.

Implementations

impl PcbEditSession

pub fn new() -> Self

Create a new empty editing session.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open an existing PCB file for editing.

pub fn save<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Save the PCB document to a file.

pub fn save_to_original(&mut self) -> Result<()>

Save to the original file (if opened from file).

pub fn is_modified(&self) -> bool

Check if the document has been modified.

pub fn source_path(&self) -> Option<&str>

Get the source file path.

pub fn set_grid(&mut self, grid: Grid)

Set the grid configuration.

pub fn set_grid_mm(&mut self, spacing_mm: f64)

Set grid from spacing in mm.

pub fn set_default_track_width(&mut self, width: Coord)

Set the default track width.

pub fn set_default_via_diameter(&mut self, diameter: Coord)

Set the default via diameter.

pub fn set_default_via_hole(&mut self, hole: Coord)

Set the default via hole size.

pub fn set_default_layer(&mut self, layer: Layer)

Set the default layer for new primitives.

pub fn default_layer(&self) -> Layer

Get the default layer.

pub fn resolve_position(&self, pos: &Position) -> Result<CoordPoint>

Resolve a Position to an absolute CoordPoint.

pub fn get_board_bounds(&self) -> CoordRect

Get the board bounds.

pub fn add_track( &mut self, start: CoordPoint, end: CoordPoint, width: Option<Coord>, layer: Option<Layer>, net: Option<&str>, ) -> Result<usize>

Add a single track segment.

pub fn add_track_positioned( &mut self, start: &Position, end: &Position, width: Option<Coord>, layer: Option<Layer>, net: Option<&str>, ) -> Result<usize>

Add a track using Position specifications.

pub fn add_track_path( &mut self, vertices: &[CoordPoint], width: Option<Coord>, layer: Option<Layer>, net: Option<&str>, ) -> Result<Vec<usize>>

Add multiple connected track segments forming a path.

pub fn add_track_routed( &mut self, path: &TrackPath, width: Option<Coord>, layer: Option<Layer>, net: Option<&str>, ) -> Result<Vec<usize>>

Add a track path using the TrackPath specification.

pub fn add_via( &mut self, location: CoordPoint, diameter: Option<Coord>, hole_size: Option<Coord>, from_layer: Option<Layer>, to_layer: Option<Layer>, net: Option<&str>, ) -> Result<usize>

Add a via at a specific location.

pub fn add_via_positioned( &mut self, position: &Position, diameter: Option<Coord>, hole_size: Option<Coord>, from_layer: Option<Layer>, to_layer: Option<Layer>, net: Option<&str>, ) -> Result<usize>

Add a via using Position specification.

pub fn add_blind_via( &mut self, location: CoordPoint, from_layer: Layer, to_layer: Layer, diameter: Option<Coord>, hole_size: Option<Coord>, net: Option<&str>, ) -> Result<usize>

Add a blind via (connects top/bottom to inner layer).

pub fn add_through_hole_pad( &mut self, location: CoordPoint, designator: &str, hole_size: Coord, pad_size: CoordPoint, shape: PcbPadShape, net: Option<&str>, ) -> Result<usize>

Add a through-hole pad.

pub fn add_smd_pad( &mut self, location: CoordPoint, designator: &str, size: CoordPoint, shape: PcbPadShape, layer: Layer, net: Option<&str>, ) -> Result<usize>

Add an SMD pad (surface mount).

pub fn add_arc( &mut self, center: CoordPoint, radius: Coord, start_angle: f64, end_angle: f64, width: Option<Coord>, layer: Option<Layer>, net: Option<&str>, ) -> Result<usize>

Add an arc.

pub fn add_circle( &mut self, center: CoordPoint, radius: Coord, width: Option<Coord>, layer: Option<Layer>, ) -> Result<usize>

Add a full circle arc.

pub fn add_arc_positioned( &mut self, center: &Position, radius: Coord, start_angle: f64, end_angle: f64, width: Option<Coord>, layer: Option<Layer>, net: Option<&str>, ) -> Result<usize>

Add an arc using Position specification.

pub fn add_fill( &mut self, corner1: CoordPoint, corner2: CoordPoint, layer: Option<Layer>, rotation: Option<f64>, net: Option<&str>, ) -> Result<usize>

Add a solid fill (copper rectangle).

pub fn add_fill_positioned( &mut self, corner1: &Position, corner2: &Position, layer: Option<Layer>, rotation: Option<f64>, net: Option<&str>, ) -> Result<usize>

Add a fill with Position specifications.

pub fn add_text( &mut self, text: &str, location: CoordPoint, height: Coord, layer: Option<Layer>, rotation: Option<f64>, _justification: Option<PcbTextJustification>, ) -> Result<usize>

Add text annotation.

pub fn add_text_positioned( &mut self, text: &str, position: &Position, height: Coord, layer: Option<Layer>, rotation: Option<f64>, justification: Option<PcbTextJustification>, ) -> Result<usize>

Add text using Position specification.

pub fn add_region( &mut self, vertices: &[CoordPoint], layer: Layer, is_keepout: bool, net: Option<&str>, ) -> Result<usize>

Add a region (copper area or keepout).

pub fn add_rectangular_region( &mut self, corner1: CoordPoint, corner2: CoordPoint, layer: Layer, is_keepout: bool, net: Option<&str>, ) -> Result<usize>

Add a rectangular region.

pub fn add_polygon( &mut self, vertices: &[CoordPoint], layer: Layer, net_name: &str, hatch_style: HatchStyle, pour_over_same_net: bool, remove_dead_copper: bool, ) -> Result<usize>

Add a polygon (copper pour).

pub fn add_rectangular_polygon( &mut self, corner1: CoordPoint, corner2: CoordPoint, layer: Layer, net_name: &str, hatch_style: HatchStyle, ) -> Result<usize>

Add a rectangular copper pour.

pub fn delete_primitive(&mut self, index: usize) -> Result<()>

Delete a primitive by index.

pub fn delete_primitives_where<F>(&mut self, filter: F) -> Result<usize>

where F: Fn(&PcbRecord) -> bool,

Delete all primitives matching a filter.

pub fn delete_tracks_on_layer(&mut self, layer: Layer) -> Result<usize>

Delete all tracks on a layer.

pub fn delete_all_vias(&mut self) -> Result<usize>

Delete all vias.

pub fn ensure_net_exists(&mut self, net_name: &str)

Ensure a net exists in the document.

pub fn add_net(&mut self, net_name: &str) -> Result<()>

Add a new net.

pub fn nets(&self) -> &[String]

Get all nets in the document.

pub fn tracks(&self) -> impl Iterator<Item = (usize, &PcbTrack)>

Get all tracks.

pub fn vias(&self) -> impl Iterator<Item = (usize, &PcbVia)>

Get all vias.

pub fn pads(&self) -> impl Iterator<Item = (usize, &PcbPad)>

Get all pads.

pub fn arcs(&self) -> impl Iterator<Item = (usize, &PcbArc)>

Get all arcs.

pub fn fills(&self) -> impl Iterator<Item = (usize, &PcbFill)>

Get all fills.

pub fn texts(&self) -> impl Iterator<Item = (usize, &PcbText)>

Get all text annotations.

pub fn regions(&self) -> impl Iterator<Item = (usize, &PcbRegion)>

Get all regions.

pub fn polygons(&self) -> impl Iterator<Item = (usize, &PcbPolygon)>

Get all polygons.

pub fn tracks_on_layer( &self, layer: Layer, ) -> impl Iterator<Item = (usize, &PcbTrack)>

Get tracks on a specific layer.

pub fn count_primitives(&self) -> PrimitiveCount

Count primitives by type.

pub fn undo(&mut self) -> Result<()>

Undo the last operation.

pub fn redo(&mut self) -> Result<()>

Redo the last undone operation.

pub fn clear_history(&mut self)

Clear all history.

Trait Implementations

impl Default for PcbEditSession

fn default() -> Self

Returns the “default value” for a type.