altium-format 0.1.7

Core altium-cli library for reading and writing Altium Designer files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! SchPolyline - Schematic polyline (Record 6).

use crate::error::Result;
use crate::traits::{FromParams, ToParams};
use crate::types::{Coord, CoordRect, ParameterCollection, UnknownFields};
use altium_format_derive::AltiumRecord;

use super::{LineStyle, LineWidth, SchGraphicalBase, SchPrimitive};

/// Schematic polyline primitive.
#[derive(Debug, Clone, Default, AltiumRecord)]
#[altium(record_id = 6, format = "params")]
pub struct SchPolyline {
    /// Graphical base (location, color).
    #[altium(flatten)]
    pub graphical: SchGraphicalBase,

    /// Line width.
    #[altium(param = "LINEWIDTH", default)]
    pub line_width: LineWidth,

    /// Line style.
    #[altium(param = "LINESTYLE", default)]
    pub line_style: LineStyle,

    /// Whether it's solid (filled - mainly for polygon compatibility).
    #[altium(param = "ISSOLID", default)]
    pub is_solid: bool,

    /// Vertices as (x, y) raw coord pairs.
    #[altium(
        indexed_coords,
        prefix_x = "X",
        prefix_y = "Y",
        count = "LOCATIONCOUNT"
    )]
    pub vertices: Vec<(i32, i32)>,

    /// Unknown parameters (preserved for non-destructive editing).
    #[altium(unknown)]
    pub unknown_params: UnknownFields,
}

// Provide polygon field for compatibility with existing code
impl SchPolyline {
    /// Get a polygon-like view for compatibility.
    pub fn polygon(&self) -> PolygonView<'_> {
        PolygonView { polyline: self }
    }
}

/// View into polyline's polygon-like data.
pub struct PolygonView<'a> {
    polyline: &'a SchPolyline,
}

impl<'a> PolygonView<'a> {
    pub fn vertices(&self) -> &[(i32, i32)] {
        &self.polyline.vertices
    }

    pub fn graphical(&self) -> &SchGraphicalBase {
        &self.polyline.graphical
    }
}

impl SchPrimitive for SchPolyline {
    const RECORD_ID: i32 = 6;

    fn location(&self) -> Option<crate::types::CoordPoint> {
        Some(crate::types::CoordPoint::from_raw(
            self.graphical.location_x,
            self.graphical.location_y,
        ))
    }

    fn record_type_name(&self) -> &'static str {
        "Polyline"
    }

    fn import_from_params(params: &ParameterCollection) -> Result<Self> {
        Self::from_params(params)
    }

    fn export_to_params(&self) -> ParameterCollection {
        self.to_params()
    }

    fn owner_index(&self) -> i32 {
        self.graphical.base.owner_index
    }

    fn calculate_bounds(&self) -> CoordRect {
        let Some(&(first_x, first_y)) = self.vertices.first() else {
            return CoordRect::empty();
        };

        let (min_x, max_x, min_y, max_y) = self.vertices.iter().skip(1).fold(
            (first_x, first_x, first_y, first_y),
            |(min_x, max_x, min_y, max_y), &(x, y)| {
                (min_x.min(x), max_x.max(x), min_y.min(y), max_y.max(y))
            },
        );

        CoordRect::from_points(
            Coord::from_raw(min_x),
            Coord::from_raw(min_y),
            Coord::from_raw(max_x),
            Coord::from_raw(max_y),
        )
    }
}