BREP_cam 0.6.0

CAM toolpath engine contracts and geometric core for the BREP CAD kernel: setups, tools, operations, typed motion streams, cutter profiles, mesh snapshots and triangle spatial indexing
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

//! Contact diagnostics attached to cutter-location points.

use super::Point3;
use serde::{Deserialize, Serialize};

/// Which part of the mesh and the cutter met.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum ContactType {
    #[default]
    None,
    Vertex,
    Facet,
    Edge,
    Shaft,
    ToolProfile,
    NumericFallback,
}

/// The winning contact of a cutter-location solve.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Contact {
    #[serde(rename = "type")]
    pub contact_type: ContactType,
    /// Contact point on the mesh, in machine coordinates.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub point: Option<Point3>,
    /// Triangle id in the mesh snapshot.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub triangle_id: Option<u32>,
    /// Distance from the cutter reference to the contact, when the solver reports one.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub distance: Option<f64>,
    /// Free-form solver detail (e.g. the fallback used).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub detail: Option<String>,
}

/// A cutter-location point: the tool reference point in machine coordinates
/// plus the contact that fixed its height.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ClPoint {
    pub x: f64,
    pub y: f64,
    pub z: f64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub contact: Option<Contact>,
}

impl ClPoint {
    pub fn new(x: f64, y: f64, z: f64) -> Self {
        Self { x, y, z, contact: None }
    }

    pub fn position(&self) -> Point3 {
        Point3::new(self.x, self.y, self.z)
    }

    pub fn is_finite(&self) -> bool {
        self.position().is_finite()
    }
}