Struct fj_kernel::storage::Handle

source · 
pub struct Handle<T> { /* private fields */ }
Expand description

A handle for an object

You can get an instance of Handle by inserting an object into a store. A handle dereferences to the object it points to, via its Deref implementation.

Equality and Identity

Equality of Handles is defined via the objects they reference. If those objects are equal, the Handles are considered equal.

This is distinct from the identity of the referenced objects. Two objects might be equal, but they might be have been created at different times, for different reasons, and thus live in different slots in the storage. This is a relevant distinction when validating objects, as equal but not identical objects might be a sign of a bug.

You can compare the identity of two objects through their Handles, by comparing the values returned by Handle::id.

Implementations§

Access this pointer’s unique id

Examples found in repository?
src/partial/wrapper.rs (line 210)
206
207
208
209
210
211
212
213
214
215
216
217
218

    fn get<T>(&mut self, handle: &Handle<T>) -> Option<Inner<T>>
    where
        T: HasPartial + 'static,
    {
        self.map().get(&handle.id()).cloned()
    }

    fn insert<T>(&mut self, handle: &Handle<T>, inner: Inner<T>)
    where
        T: HasPartial + 'static,
    {
        self.map().insert(handle.id(), inner);
    }
More examples
Hide additional examples
src/iter.rs (line 343)
341
342
343
344
345
346
347
348
349

    fn with_handles(mut self, other: Self) -> Self {
        for handle in other {
            if !self.0.iter().any(|h| h.id() == handle.id()) {
                self.0.push_back(handle);
            }
        }

        self
    }
src/algorithms/transform/mod.rs (line 114)
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

    fn get<T: 'static>(&mut self, key: &Handle<T>) -> Option<&Handle<T>> {
        let map = self
            .0
            .entry::<BTreeMap<ObjectId, Handle<T>>>()
            .or_insert_with(BTreeMap::new);

        map.get(&key.id())
    }

    fn insert<T: 'static>(&mut self, key: Handle<T>, value: Handle<T>) {
        let map = self
            .0
            .entry::<BTreeMap<ObjectId, Handle<T>>>()
            .or_insert_with(BTreeMap::new);

        map.insert(key.id(), value);
    }
src/algorithms/approx/curve.rs (line 174)
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

    pub fn insert(
        &mut self,
        handle: Handle<GlobalCurve>,
        range: RangeOnPath,
        approx: GlobalCurveApprox,
    ) -> GlobalCurveApprox {
        self.inner.insert((handle.id(), range), approx.clone());
        approx
    }

    /// Access the approximation for the given [`GlobalCurve`], if available
    pub fn get(
        &self,
        handle: Handle<GlobalCurve>,
        range: RangeOnPath,
    ) -> Option<GlobalCurveApprox> {
        self.inner.get(&(handle.id(), range)).cloned()
    }
src/validate/edge.rs (line 119)
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

    fn check_curve_identity(half_edge: &HalfEdge) -> Result<(), Self> {
        let back_curve = half_edge.back().curve();
        let front_curve = half_edge.front().curve();

        if back_curve.id() != front_curve.id() {
            return Err(Self::CurveMismatch {
                back_curve: back_curve.clone(),
                front_curve: front_curve.clone(),
            });
        }

        Ok(())
    }

    fn check_global_curve_identity(half_edge: &HalfEdge) -> Result<(), Self> {
        let global_curve_from_curve = half_edge.curve().global_form();
        let global_curve_from_global_form = half_edge.global_form().curve();

        if global_curve_from_curve.id() != global_curve_from_global_form.id() {
            return Err(Self::GlobalCurveMismatch {
                global_curve_from_curve: global_curve_from_curve.clone(),
                global_curve_from_global_form: global_curve_from_global_form
                    .clone(),
            });
        }

        Ok(())
    }

    fn check_global_vertex_identity(half_edge: &HalfEdge) -> Result<(), Self> {
        let global_vertices_from_vertices = {
            let (global_vertices_from_vertices, _) =
                VerticesInNormalizedOrder::new(
                    half_edge
                        .vertices()
                        .each_ref_ext()
                        .map(|vertex| vertex.global_form().clone()),
                );

            global_vertices_from_vertices.access_in_normalized_order()
        };
        let global_vertices_from_global_form = half_edge
            .global_form()
            .vertices()
            .access_in_normalized_order();

        let ids_from_vertices = global_vertices_from_vertices
            .each_ref_ext()
            .map(|global_vertex| global_vertex.id());
        let ids_from_global_form = global_vertices_from_global_form
            .each_ref_ext()
            .map(|global_vertex| global_vertex.id());

        if ids_from_vertices != ids_from_global_form {
            return Err(Self::GlobalVertexMismatch {
                global_vertices_from_vertices,
                global_vertices_from_global_form,
            });
        }

        Ok(())
    }
src/validate/face.rs (line 68)
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

    fn check_surface_identity(face: &Face) -> Result<(), Self> {
        let surface = face.surface();

        for interior in face.interiors() {
            if surface.id() != interior.surface().id() {
                return Err(Self::SurfaceMismatch {
                    surface: surface.clone(),
                    interior: interior.clone(),
                    face: face.clone(),
                });
            }
        }

        Ok(())
    }
Additional examples can be found in:

Return a clone of the object this handle refers to

Examples found in repository?
src/algorithms/transform/mod.rs (line 91)
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

    fn transform_with_cache(
        self,
        transform: &Transform,
        objects: &mut Service<Objects>,
        cache: &mut TransformCache,
    ) -> Self {
        if let Some(object) = cache.get(&self) {
            return object.clone();
        }

        let transformed = self
            .clone_object()
            .transform_with_cache(transform, objects, cache)
            .insert(objects);

        cache.insert(self.clone(), transformed.clone());

        transformed
    }
More examples
Hide additional examples
src/validate/vertex.rs (line 118)
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

    fn check_position(
        vertex: &Vertex,
        config: &ValidationConfig,
    ) -> Result<(), Self> {
        let curve_position_as_surface = vertex
            .curve()
            .path()
            .point_from_path_coords(vertex.position());
        let surface_position = vertex.surface_form().position();

        let distance = curve_position_as_surface.distance_to(&surface_position);

        if distance > config.identical_max_distance {
            return Err(Self::PositionMismatch {
                vertex: vertex.clone(),
                surface_vertex: vertex.surface_form().clone_object(),
                curve_position_as_surface,
                distance,
            });
        }

        Ok(())
    }
}

/// [`SurfaceVertex`] validation error
#[derive(Clone, Debug, thiserror::Error)]
pub enum SurfaceVertexValidationError {
    /// Mismatch between position and position of global form
    #[error(
        "`SurfaceVertex` position doesn't match position of its global form\n\
    - `SurfaceVertex`: {surface_vertex:#?}\n\
    - `GlobalVertex`: {global_vertex:#?}\n\
    - `SurfaceVertex` position as global: {surface_position_as_global:?}\n\
    - Distance between the positions: {distance}"
    )]
    PositionMismatch {
        /// The surface vertex
        surface_vertex: SurfaceVertex,

        /// The mismatched global vertex
        global_vertex: GlobalVertex,

        /// The surface position converted into a global position
        surface_position_as_global: Point<3>,

        /// The distance between the positions
        distance: Scalar,
    },
}

impl SurfaceVertexValidationError {
    fn check_position(
        surface_vertex: &SurfaceVertex,
        config: &ValidationConfig,
    ) -> Result<(), Self> {
        let surface_position_as_global = surface_vertex
            .surface()
            .geometry()
            .point_from_surface_coords(surface_vertex.position());
        let global_position = surface_vertex.global_form().position();

        let distance = surface_position_as_global.distance_to(&global_position);

        if distance > config.identical_max_distance {
            return Err(Self::PositionMismatch {
                surface_vertex: surface_vertex.clone(),
                global_vertex: surface_vertex.global_form().clone_object(),
                surface_position_as_global,
                distance,
            });
        }

        Ok(())
    }

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
The resulting type after dereferencing.
Dereferences the value.
Extends a collection with the contents of an iterator. Read more
🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Creates a value from an iterator. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
Return all objects that this one references
Iterate over all curves
Iterate over all cycles
Iterate over all faces
Iterate over all global curves
Iterate over all global vertices
Iterate over all half-edges
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
Iterator over all vertices
Return all objects that this one references
Iterate over all cycles
Iterate over all curves
Iterate over all faces
Iterate over all global curves
Iterate over all global vertices
Iterate over all half-edges
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
Iterator over all vertices
Return all objects that this one references
Iterate over all faces
Iterate over all curves
Iterate over all cycles
Iterate over all global curves
Iterate over all global vertices
Iterate over all half-edges
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
Iterator over all vertices
Return all objects that this one references
Iterate over all global curves
Iterate over all curves
Iterate over all cycles
Iterate over all faces
Iterate over all global vertices
Iterate over all half-edges
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
Iterator over all vertices
Return all objects that this one references
Iterate over all global vertices
Iterate over all curves
Iterate over all cycles
Iterate over all faces
Iterate over all global curves
Iterate over all half-edges
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
Iterator over all vertices
Return all objects that this one references
Iterate over all half-edges
Iterate over all curves
Iterate over all cycles
Iterate over all faces
Iterate over all global curves
Iterate over all global vertices
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
Iterator over all vertices
Return all objects that this one references
Iterate over all shells
Iterate over all curves
Iterate over all cycles
Iterate over all faces
Iterate over all global curves
Iterate over all global vertices
Iterate over all half-edges
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
Iterator over all vertices
Return all objects that this one references
Iterate over all surfaces
Iterate over all curves
Iterate over all cycles
Iterate over all faces
Iterate over all global curves
Iterate over all global vertices
Iterate over all half-edges
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterator over all vertices
Return all objects that this one references
Iterator over all vertices
Iterate over all curves
Iterate over all cycles
Iterate over all faces
Iterate over all global curves
Iterate over all global vertices
Iterate over all half-edges
Iterate over all shells
Iterate over all sketches
Iterate over all solids
Iterate over all surfaces
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Reverse the direction/orientation of the object
Reverse the direction/orientation of the object
Reverse the direction/orientation of the object
The object that is created by sweeping the implementing object
Sweep the object along the given path, using the provided cache
Sweep the object along the given path
The object that is created by sweeping the implementing object
Sweep the object along the given path, using the provided cache
Sweep the object along the given path
The object that is created by sweeping the implementing object
Sweep the object along the given path, using the provided cache
Sweep the object along the given path
The object that is created by sweeping the implementing object
Sweep the object along the given path, using the provided cache
Sweep the object along the given path
Transform the object using the provided cache
Transform the object
Translate the object Read more
Rotate the object Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.