Struct fj_kernel::objects::Face

source · [−]

pub struct Face { /* private fields */ }

Expand description

A face of a shape

Implementations

source

impl Face

source

pub fn new(surface: Surface) -> Self

Construct a new instance of Face

Creates the face with no exteriors, no interiors and the default color. This can be overridden using the with_ methods.

source

pub fn from_triangles(triangles: Vec<(Triangle<3>, Color)>) -> Self

Contact an instance that uses triangle representation

source

pub fn with_exteriors(self, exteriors: impl IntoIterator<Item = Cycle>) -> Self

Add exterior cycles to the face

Consumes the face and returns the updated instance.

source

pub fn with_interiors(self, interiors: impl IntoIterator<Item = Cycle>) -> Self

Add interior cycles to the face

Consumes the face and returns the updated instance.

source

pub fn with_color(self, color: Color) -> Self

Update the color of the face

Consumes the face and returns the updated instance.

source

pub fn build(surface: Surface) -> FaceBuilder

Build a face using FaceBuilder

source

pub fn surface(&self) -> &Surface

Access this face’s surface

source

pub fn exteriors(&self) -> impl Iterator<Item = &Cycle> + '_

Access the cycles that bound the face on the outside

source

pub fn interiors(&self) -> impl Iterator<Item = &Cycle> + '_

Access the cycles that bound the face on the inside

Each of these cycles defines a hole in the face.

source

pub fn all_cycles(&self) -> impl Iterator<Item = &Cycle> + '_

Access all cycles of this face

This is equivalent to chaining the iterators returned by Face::exteriors and Face::interiors.

source

pub fn color(&self) -> Color

Access the color of the face

source

pub fn triangles(&self) -> Option<&Vec<(Triangle<3>, Color)>>

Access triangles, if this face uses triangle representation

Only some faces still use triangle representation. At some point, none will. This method exists as a workaround, while the transition is still in progress.

Trait Implementations

source

impl Clone for Face

source

fn clone(&self) -> Face

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Face

source

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

Formats the value using the given formatter. Read more

source

impl From<FacePolygon> for Face

source

fn from(polygon: FacePolygon) -> Self

Converts to this type from the input type.

source

impl Hash for Face

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

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

source

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

Return all objects being referenced

source

fn face_iter(&'r self) -> Iter<&'r Face>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all faces

source

fn curve_iter(&'r self) -> Iter<&'r Curve<3>>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all curves

source

fn cycle_iter(&'r self) -> Iter<&'r Cycle>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all cycles

source

fn edge_iter(&'r self) -> Iter<&'r Edge>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all edges

source

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all global vertices

source

fn sketch_iter(&'r self) -> Iter<&'r Sketch>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all sketches

source

fn solid_iter(&'r self) -> Iter<&'r Solid>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all solids

source

fn surface_iter(&'r self) -> Iter<&'r Surface>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all surfaces

source

fn vertex_iter(&'r self) -> Iter<&'r Vertex>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterator over all vertices

source

impl Ord for Face

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<Face> for Face

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<Face> for Face

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl TransformObject for Face

source

fn transform(self, transform: &Transform) -> Self

Transform the object

source

fn translate(self, offset: impl Into<Vector<3>>) -> Self

Translate the object

source

fn rotate(self, axis_angle: impl Into<Vector<3>>) -> Self

Rotate the object

source

impl Eq for Face

source

impl StructuralEq for Face

source

impl StructuralPartialEq for Face

Auto Trait Implementations

impl RefUnwindSafe for Face

impl Send for Face

impl Sync for Face

impl Unpin for Face

impl UnwindSafe for Face

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct fj_kernel::objects::Face

Implementations

impl Face

pub fn new(surface: Surface) -> Self

pub fn from_triangles(triangles: Vec<(Triangle<3>, Color)>) -> Self

pub fn with_exteriors(self, exteriors: impl IntoIterator<Item = Cycle>) -> Self

pub fn with_interiors(self, interiors: impl IntoIterator<Item = Cycle>) -> Self

pub fn with_color(self, color: Color) -> Self

pub fn build(surface: Surface) -> FaceBuilder

pub fn surface(&self) -> &Surface

pub fn exteriors(&self) -> impl Iterator<Item = &Cycle> + '_

pub fn interiors(&self) -> impl Iterator<Item = &Cycle> + '_

pub fn all_cycles(&self) -> impl Iterator<Item = &Cycle> + '_

pub fn color(&self) -> Color

pub fn triangles(&self) -> Option<&Vec<(Triangle<3>, Color)>>

Trait Implementations

impl Clone for Face

fn clone(&self) -> Face

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

impl Debug for Face

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

impl From<FacePolygon> for Face

fn from(polygon: FacePolygon) -> Self

impl Hash for Face

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

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

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

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

fn face_iter(&'r self) -> Iter<&'r Face>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn curve_iter(&'r self) -> Iter<&'r Curve<3>>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn cycle_iter(&'r self) -> Iter<&'r Cycle>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn edge_iter(&'r self) -> Iter<&'r Edge>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn sketch_iter(&'r self) -> Iter<&'r Sketch>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn solid_iter(&'r self) -> Iter<&'r Solid>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn surface_iter(&'r self) -> Iter<&'r Surface>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn vertex_iter(&'r self) -> Iter<&'r Vertex>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

impl Ord for Face

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

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

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

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

impl PartialEq<Face> for Face

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

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

impl PartialOrd<Face> for Face

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

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

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

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

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

impl TransformObject for Face

fn transform(self, transform: &Transform) -> Self

fn translate(self, offset: impl Into<Vector<3>>) -> Self

fn rotate(self, axis_angle: impl Into<Vector<3>>) -> Self

impl Eq for Face

impl StructuralEq for Face

impl StructuralPartialEq for Face

Auto Trait Implementations

impl RefUnwindSafe for Face

impl Send for Face

impl Sync for Face

impl Unpin for Face

impl UnwindSafe for Face

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

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

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

fn face_iter(&'r self) -> Iter<&'r Face>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn curve_iter(&'r self) -> Iter<&'r Curve<3>>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn cycle_iter(&'r self) -> Iter<&'r Cycle>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn edge_iter(&'r self) -> Iter<&'r Edge>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn sketch_iter(&'r self) -> Iter<&'r Sketch>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn solid_iter(&'r self) -> Iter<&'r Solid>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn surface_iter(&'r self) -> Iter<&'r Surface>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn vertex_iter(&'r self) -> Iter<&'r Vertex>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> Scalar for T where
T: 'static + Clone + PartialEq<T> + Debug,