Struct fj_kernel::storage::Handle

pub struct Handle<T> { /* private fields */ }

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

impl<T> Handle<T>

pub fn id(&self) -> ObjectId

Access this pointer’s unique id

pub fn clone_object(&self) -> Twhere
    T: Clone,

Return a clone of the object this handle refers to

Trait Implementations

impl<T> Clone for Handle<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Handle<T>where
    T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for Handle<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Extend<Handle<Face>> for FaceSet

fn extend<T: IntoIterator<Item = Handle<Face>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> From<Handle<T>> for HandleWrapper<T>

fn from(handle: Handle<T>) -> Self

Converts to this type from the input type.

impl<T> From<Handle<T>> for MaybePartial<T>where
    T: HasPartial,

fn from(full: Handle<T>) -> Self

Converts to this type from the input type.

impl<T> From<HandleWrapper<T>> for Handle<T>

fn from(wrapper: HandleWrapper<T>) -> Self

Converts to this type from the input type.

impl FromIterator<Handle<Face>> for FaceSet

fn from_iter<T: IntoIterator<Item = Handle<Face>>>(iter: T) -> Self

Creates a value from an iterator.

impl<T> Hash for Handle<T>where
    T: Hash,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'r> ObjectIters<'r> for Handle<Curve>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<Cycle>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<Face>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<GlobalCurve>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<GlobalVertex>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<HalfEdge>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<Shell>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<Surface>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl<'r> ObjectIters<'r> for Handle<Vertex>

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

impl<T> Ord for Handle<T>where
    T: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T> PartialEq<Handle<T>> for Handle<T>where
    T: PartialEq,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd<Handle<T>> for Handle<T>where
    T: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Reverse for Handle<Cycle>

fn reverse(self, objects: &Objects) -> Result<Self, ValidationError>

Reverse the direction/orientation of the object

impl Reverse for Handle<Face>

fn reverse(self, objects: &Objects) -> Result<Self, ValidationError>

Reverse the direction/orientation of the object

impl Reverse for Handle<HalfEdge>

fn reverse(self, objects: &Objects) -> Result<Self, ValidationError>

Reverse the direction/orientation of the object

impl Sweep for Handle<Curve>

type Swept = Handle<Surface>

The object that is created by sweeping the implementing object

fn sweep_with_cache(
    self,
    path: impl Into<Vector<3>>,
    _: &mut SweepCache,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path, using the provided cache

fn sweep(
    self,
    path: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path

impl Sweep for Handle<Face>

type Swept = Handle<Shell>

The object that is created by sweeping the implementing object

fn sweep_with_cache(
    self,
    path: impl Into<Vector<3>>,
    cache: &mut SweepCache,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path, using the provided cache

fn sweep(
    self,
    path: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path

impl Sweep for Handle<GlobalVertex>

type Swept = (Handle<GlobalEdge>, [Handle<GlobalVertex>; 2])

The object that is created by sweeping the implementing object

fn sweep_with_cache(
    self,
    path: impl Into<Vector<3>>,
    cache: &mut SweepCache,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path, using the provided cache

fn sweep(
    self,
    path: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path

impl Sweep for Handle<Sketch>

type Swept = Handle<Solid>

The object that is created by sweeping the implementing object

fn sweep_with_cache(
    self,
    path: impl Into<Vector<3>>,
    cache: &mut SweepCache,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path, using the provided cache

fn sweep(
    self,
    path: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self::Swept, ValidationError>

Sweep the object along the given path

impl TransformObject for Handle<Face>

fn transform(
    self,
    transform: &Transform,
    objects: &Objects
) -> Result<Self, ValidationError>

Transform the object

fn translate(
    self,
    offset: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Translate the object

fn rotate(
    self,
    axis_angle: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Rotate the object

impl TransformObject for Handle<Shell>

fn transform(
    self,
    transform: &Transform,
    objects: &Objects
) -> Result<Self, ValidationError>

Transform the object

fn translate(
    self,
    offset: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Translate the object

fn rotate(
    self,
    axis_angle: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Rotate the object

impl TransformObject for Handle<Sketch>

fn transform(
    self,
    transform: &Transform,
    objects: &Objects
) -> Result<Self, ValidationError>

Transform the object

fn translate(
    self,
    offset: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Translate the object

fn rotate(
    self,
    axis_angle: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Rotate the object

impl TransformObject for Handle<Solid>

fn transform(
    self,
    transform: &Transform,
    objects: &Objects
) -> Result<Self, ValidationError>

Transform the object

fn translate(
    self,
    offset: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Translate the object

fn rotate(
    self,
    axis_angle: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Rotate the object

impl TransformObject for Handle<Surface>

fn transform(
    self,
    transform: &Transform,
    objects: &Objects
) -> Result<Self, ValidationError>

Transform the object

fn translate(
    self,
    offset: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Translate the object

fn rotate(
    self,
    axis_angle: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Rotate the object

impl<T> TransformObject for Handle<T>where
    T: HasPartial,
    T::Partial: TransformObject,

fn transform(
    self,
    transform: &Transform,
    objects: &Objects
) -> Result<Self, ValidationError>

Transform the object

fn translate(
    self,
    offset: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Translate the object

fn rotate(
    self,
    axis_angle: impl Into<Vector<3>>,
    objects: &Objects
) -> Result<Self, ValidationError>

Rotate the object

impl<T> Eq for Handle<T>where
    T: Eq,

impl<T> Send for Handle<T>

impl<T> Sync for Handle<T>