Enum fj_kernel::partial::MaybePartial

pub enum MaybePartial<T: HasPartial> {
    Full(Handle<T>),
    Partial(T::Partial),
}

Can be used everywhere either a partial or full objects are accepted

Some convenience methods are available for specific instances of MaybePartial (like, MaybePartial<Curve>, or MaybePartial<Vertex>).

Implementation Note

The set of available convenience methods is far from complete. Please feel free to just add more, if you need them.

Variants

Full(Handle<T>)

A full object

Partial(T::Partial)

A partial object

Implementations

impl<T: HasPartial> MaybePartial<T>

pub fn is_full(&self) -> bool

Indicate whether this is a full object

pub fn is_partial(&self) -> bool

Indicate whether this is a partial object

pub fn update_partial(self, f: impl FnOnce(T::Partial) -> T::Partial) -> Self

If this is a partial object, update it

This is useful whenever a partial object can infer something about its parts from other parts, and wants to update what was inferred, in case it can be updated.

pub fn into_full(self, objects: &Objects) -> Result<Handle<T>, ValidationError>where
    T: Insert,
    ValidationError: From<<T as Validate>::Error>,

Return or build a full object

If this already is a full object, it is returned. If this is a partial object, the full object is built from it, using Partial::build.

pub fn into_partial(self) -> T::Partial

Return or convert a partial object

If this already is a partial object, is is returned. If this is a full object, it is converted into a partial object using HasPartial::to_partial.

impl MaybePartial<Curve>

pub fn path(&self) -> Option<SurfacePath>

Access the path

pub fn surface(&self) -> Option<Handle<Surface>>

Access the surface

pub fn global_form(&self) -> MaybePartial<GlobalCurve>

Access the global form

impl MaybePartial<GlobalEdge>

pub fn curve(&self) -> MaybePartial<GlobalCurve>

Access the curve

pub fn vertices(&self) -> [MaybePartial<GlobalVertex>; 2]

Access the vertices

impl MaybePartial<GlobalVertex>

pub fn position(&self) -> Option<Point<3>>

Access the position

impl MaybePartial<HalfEdge>

pub fn curve(&self) -> MaybePartial<Curve>

Access the curve

pub fn front(&self) -> MaybePartial<Vertex>

Access the front vertex

pub fn vertices(&self) -> [MaybePartial<Vertex>; 2]

Access the vertices

impl MaybePartial<Surface>

pub fn geometry(&self) -> Option<SurfaceGeometry>

Access the geometry

impl MaybePartial<SurfaceVertex>

pub fn position(&self) -> Option<Point<2>>

Access the position

pub fn surface(&self) -> Option<Handle<Surface>>

Access the surface

pub fn global_form(&self) -> MaybePartial<GlobalVertex>

Access the global form

impl MaybePartial<Vertex>

pub fn surface_form(&self) -> MaybePartial<SurfaceVertex>

Access the surface form

Trait Implementations

impl<T: Clone + HasPartial> Clone for MaybePartial<T>where
    T::Partial: Clone,

fn clone(&self) -> MaybePartial<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + HasPartial> Debug for MaybePartial<T>where
    T::Partial: Debug,

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

Formats the value using the given formatter.

impl<T> Default for MaybePartial<T>where
    T: HasPartial,
    T::Partial: Default,

fn default() -> Self

Returns the “default value” for a 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 From<PartialCurve> for MaybePartial<Curve>

fn from(partial: PartialCurve) -> Self

Converts to this type from the input type.

impl From<PartialCycle> for MaybePartial<Cycle>

fn from(partial: PartialCycle) -> Self

Converts to this type from the input type.

impl From<PartialFace> for MaybePartial<Face>

fn from(partial: PartialFace) -> Self

Converts to this type from the input type.

impl From<PartialGlobalCurve> for MaybePartial<GlobalCurve>

fn from(partial: PartialGlobalCurve) -> Self

Converts to this type from the input type.

impl From<PartialGlobalEdge> for MaybePartial<GlobalEdge>

fn from(partial: PartialGlobalEdge) -> Self

Converts to this type from the input type.

impl From<PartialGlobalVertex> for MaybePartial<GlobalVertex>

fn from(partial: PartialGlobalVertex) -> Self

Converts to this type from the input type.

impl From<PartialHalfEdge> for MaybePartial<HalfEdge>

fn from(partial: PartialHalfEdge) -> Self

Converts to this type from the input type.

impl From<PartialSurface> for MaybePartial<Surface>

fn from(partial: PartialSurface) -> Self

Converts to this type from the input type.

impl From<PartialSurfaceVertex> for MaybePartial<SurfaceVertex>

fn from(partial: PartialSurfaceVertex) -> Self

Converts to this type from the input type.

impl From<PartialVertex> for MaybePartial<Vertex>

fn from(partial: PartialVertex) -> Self

Converts to this type from the input type.

impl<T: Hash + HasPartial> Hash for MaybePartial<T>where
    T::Partial: 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<T> MergeWith for MaybePartial<T>where
    T: HasPartial,
    T::Partial: MergeWith,

fn merge_with(self, other: impl Into<Self>) -> Self

Merge this object with another

impl<T: Ord + HasPartial> Ord for MaybePartial<T>where
    T::Partial: Ord,

fn cmp(&self, other: &MaybePartial<T>) -> 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 + HasPartial> PartialEq<MaybePartial<T>> for MaybePartial<T>where
    T::Partial: PartialEq,

fn eq(&self, other: &MaybePartial<T>) -> 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 + HasPartial> PartialOrd<MaybePartial<T>> for MaybePartial<T>where
    T::Partial: PartialOrd,

fn partial_cmp(&self, other: &MaybePartial<T>) -> 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<T, R> Replace<R> for MaybePartial<T>where
    T: HasPartial + Get<R>,
    T::Partial: Replace<R>,

fn replace(&mut self, object: Handle<R>) -> &mut Self

Recursively replace the referenced object

impl<T> TransformObject for MaybePartial<T>where
    T: HasPartial,
    Handle<T>: TransformObject,
    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 + HasPartial> Eq for MaybePartial<T>where
    T::Partial: Eq,

impl<T: HasPartial> StructuralEq for MaybePartial<T>

impl<T: HasPartial> StructuralPartialEq for MaybePartial<T>