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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
use fj_math::Winding;

use crate::objects::Face;

use super::{Validate, ValidationConfig, ValidationError};

impl Validate for Face {
    fn validate_with_config(
        &self,
        _: &ValidationConfig,
        errors: &mut Vec<ValidationError>,
    ) {
        FaceValidationError::check_boundary(self, errors);
        FaceValidationError::check_interior_winding(self, errors);
    }
}

/// [`Face`] validation error
#[derive(Clone, Debug, thiserror::Error)]
pub enum FaceValidationError {
    /// The [`Face`] has no exterior cycle
    #[error("The `Face` has no exterior cycle")]
    MissingBoundary,

    /// Interior of [`Face`] has invalid winding; must be opposite of exterior
    #[error(
        "Interior of `Face` has invalid winding; must be opposite of exterior\n\
        - Winding of exterior cycle: {exterior_winding:#?}\n\
        - Winding of interior cycle: {interior_winding:#?}\n\
        - `Face`: {face:#?}"
    )]
    InvalidInteriorWinding {
        /// The winding of the [`Face`]'s exterior cycle
        exterior_winding: Winding,

        /// The winding of the invalid interior cycle
        interior_winding: Winding,

        /// The face
        face: Face,
    },
}

impl FaceValidationError {
    fn check_boundary(face: &Face, errors: &mut Vec<ValidationError>) {
        if face.region().exterior().half_edges().is_empty() {
            errors.push(ValidationError::from(Self::MissingBoundary));
        }

        // Checking *that* a boundary exists is enough. There are validation
        // checks for `Cycle` to make sure that the cycle is closed properly.
    }

    fn check_interior_winding(face: &Face, errors: &mut Vec<ValidationError>) {
        if face.region().exterior().half_edges().is_empty() {
            // Can't determine winding, if the cycle has no edges. Sounds like a
            // job for a different validation check.
            return;
        }

        let exterior_winding = face.region().exterior().winding();

        for interior in face.region().interiors() {
            if interior.half_edges().is_empty() {
                // Can't determine winding, if the cycle has no edges. Sounds
                // like a job for a different validation check.
                continue;
            }
            let interior_winding = interior.winding();

            if exterior_winding == interior_winding {
                errors.push(
                    Self::InvalidInteriorWinding {
                        exterior_winding,
                        interior_winding,
                        face: face.clone(),
                    }
                    .into(),
                );
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        assert_contains_err,
        objects::{Cycle, Face, HalfEdge, Region},
        operations::{
            build::{BuildCycle, BuildFace, BuildHalfEdge},
            insert::Insert,
            reverse::Reverse,
            update::{UpdateCycle, UpdateFace, UpdateRegion},
        },
        services::Services,
        validate::{FaceValidationError, Validate, ValidationError},
    };

    #[test]
    fn boundary() -> anyhow::Result<()> {
        let mut services = Services::new();

        let invalid =
            Face::unbound(services.objects.surfaces.xy_plane(), &mut services);
        let valid = invalid.update_region(|region| {
            region
                .update_exterior(|cycle| {
                    cycle
                        .add_half_edges([HalfEdge::circle(
                            [0., 0.],
                            1.,
                            &mut services,
                        )
                        .insert(&mut services)])
                        .insert(&mut services)
                })
                .insert(&mut services)
        });

        valid.validate_and_return_first_error()?;
        assert_contains_err!(
            invalid,
            ValidationError::Face(FaceValidationError::MissingBoundary)
        );

        Ok(())
    }

    #[test]
    fn interior_winding() -> anyhow::Result<()> {
        let mut services = Services::new();

        let valid =
            Face::unbound(services.objects.surfaces.xy_plane(), &mut services)
                .update_region(|region| {
                    region
                        .update_exterior(|_| {
                            Cycle::polygon(
                                [[0., 0.], [3., 0.], [0., 3.]],
                                &mut services,
                            )
                            .insert(&mut services)
                        })
                        .add_interiors([Cycle::polygon(
                            [[1., 1.], [1., 2.], [2., 1.]],
                            &mut services,
                        )
                        .insert(&mut services)])
                        .insert(&mut services)
                });
        let invalid = {
            let interiors = valid
                .region()
                .interiors()
                .iter()
                .cloned()
                .map(|cycle| cycle.reverse(&mut services).insert(&mut services))
                .collect::<Vec<_>>();

            let region = Region::new(
                valid.region().exterior().clone(),
                interiors,
                valid.region().color(),
            )
            .insert(&mut services);

            Face::new(valid.surface().clone(), region)
        };

        valid.validate_and_return_first_error()?;
        assert_contains_err!(
            invalid,
            ValidationError::Face(
                FaceValidationError::InvalidInteriorWinding { .. }
            )
        );

        Ok(())
    }
}