Struct fj_kernel::local::Local

pub struct Local<T: LocalForm> { /* private fields */ }

A wrapper around the local and global forms of a type

The local form is whatever representation of the value that is most appropriate in a given local context, which might be a curve or surface. The global form is the global 3D form of the same value.

The purpose of storing both forms is to be able to losslessly convert between them. Even if this conversion can be computed on the fly, it might be lossy due to floating point accuracy issues.

Implementations

impl<T: LocalForm> Local<T>

pub fn new(local: impl Into<T>, global: impl Into<T::GlobalForm>) -> Self

Construct a new instance

It is the caller’s responsibility to make sure that the local and global forms passed into this constructor match.

pub fn local(&self) -> T

Access the local form of the value

pub fn global(&self) -> T::GlobalForm

Access the global form of the value

Trait Implementations

impl<T: Clone + LocalForm> Clone for Local<T> where
    T::GlobalForm: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + LocalForm> Debug for Local<T> where
    T::GlobalForm: Debug, 

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

Formats the value using the given formatter.

impl HasPosition for Local<Point<2>>

type Scalar = Scalar

The number type used by this coordinate type.

fn position(&self) -> Point2<Self::Scalar>

Returns the position of this object.

impl<T: Hash + LocalForm> Hash for Local<T> where
    T::GlobalForm: 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, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord + LocalForm> Ord for Local<T> where
    T::GlobalForm: Ord, 

fn cmp(&self, other: &Local<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq + LocalForm> PartialEq<Local<T>> for Local<T> where
    T::GlobalForm: PartialEq, 

fn eq(&self, other: &Local<T>) -> bool

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

fn ne(&self, other: &Local<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + LocalForm> PartialOrd<Local<T>> for Local<T> where
    T::GlobalForm: PartialOrd, 

fn partial_cmp(&self, other: &Local<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: Copy + LocalForm> Copy for Local<T> where
    T::GlobalForm: Copy, 

impl<T: Eq + LocalForm> Eq for Local<T> where
    T::GlobalForm: Eq, 

impl<T: LocalForm> StructuralEq for Local<T>

impl<T: LocalForm> StructuralPartialEq for Local<T>