Enum fj_kernel::objects::Surface

source · [−]

pub enum Surface {
    SweptCurve(SweptCurve),
}

Expand description

A two-dimensional shape

Variants

`SweptCurve(SweptCurve)`

A swept curve

Implementations

source

impl Surface

source

pub fn xy_plane() -> Self

Construct a Surface that represents the xy-plane

source

pub fn xz_plane() -> Self

Construct a Surface that represents the xz-plane

source

pub fn yz_plane() -> Self

Construct a Surface that represents the yz-plane

source

pub fn plane_from_points(points: [impl Into<Point<3>>; 3]) -> Self

Construct a plane from 3 points

source

pub fn point_from_surface_coords(&self, point: impl Into<Point<2>>) -> Point<3>

Convert a point in surface coordinates to model coordinates

source

pub fn vector_from_surface_coords(
&self,
vector: impl Into<Vector<2>>
) -> Vector<3>

Convert a vector in surface coordinates to model coordinates

Trait Implementations

source

impl Clone for Surface

source

fn clone(&self) -> Surface

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 Surface

source

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

Formats the value using the given formatter. Read more

source

impl Hash for Surface

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 Surface

source

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

Return all objects that this one references

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 curve_iter(&'r self) -> Iter<&'r Curve>ⓘ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 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 global_curve_iter(&'r self) -> Iter<&'r GlobalCurve>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all global curves

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 shell_iter(&'r self) -> Iter<&'r Shell>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

Iterate over all shells

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 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 Surface

source

fn cmp(&self, other: &Surface) -> 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) -> Selfwhere
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

impl PartialEq<Surface> for Surface

source

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

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

1.0.0 · source

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

source

impl PartialOrd<Surface> for Surface

source

fn partial_cmp(&self, other: &Surface) -> 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 Reverse for Surface

source

fn reverse(self) -> Self

Reverse the surface

Implementation Note

Right now, the orientation of a face is defined by the orientation of its surface. This leads to some complications. See this issue for context: https://github.com/hannobraun/Fornjot/issues/695

It would probably be much better, if Surfaces were without orientation, and the orientation of a face were defined by the direction of the half-edges that bound it.

Please note that, as of this writing, half-edges don’t really exist as a concept in the kernel. We kind of treat Edge as a half-edge, but in an inconsistent way that causes problems. This issue has some context on that: https://github.com/hannobraun/Fornjot/issues/993

So, in conclusion, in a perfect world, this implementation would not exist.

source

impl TransformObject for Surface

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 StructuralPartialEq for Surface

Auto Trait Implementations

impl RefUnwindSafe for Surface

impl Send for Surface

impl Sync for Surface

impl Unpin for Surface

impl UnwindSafe for Surface

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast for Twhere
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 Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + '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 Twhere
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 SPwhere
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 Twhere
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 Twhere
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 Twhere
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

impl<T> Validate for Twhere
T: for<'r> ObjectIters<'r>,

source

fn validate_with_config(
self,
config: &ValidationConfig
) -> Result<Validated<T>, ValidationError>

Validate the object

source

fn validate(self) -> Result<Validated<Self>, ValidationError>

Validate the object using default configuration Read more

source

Enum fj_kernel::objects::Surface

Variants

SweptCurve(SweptCurve)

Implementations

impl Surface

pub fn xy_plane() -> Self

pub fn xz_plane() -> Self

pub fn yz_plane() -> Self

pub fn plane_from_points(points: [impl Into<Point<3>>; 3]) -> Self

pub fn point_from_surface_coords(&self, point: impl Into<Point<2>>) -> Point<3>

pub fn vector_from_surface_coords( &self, vector: impl Into<Vector<2>>) -> Vector<3>

Trait Implementations

impl Clone for Surface

fn clone(&self) -> Surface

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

impl Debug for Surface

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

impl Hash for Surface

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 Surface

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

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

fn curve_iter(&'r self) -> Iter<&'r Curve>ⓘ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 face_iter(&'r self) -> Iter<&'r Face>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

fn global_curve_iter(&'r self) -> Iter<&'r GlobalCurve>ⓘ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 shell_iter(&'r self) -> Iter<&'r Shell>ⓘ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 vertex_iter(&'r self) -> Iter<&'r Vertex>ⓘNotable traits for Iter<T>impl<T> Iterator for Iter<T> type Item = T;

impl Ord for Surface

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

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

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

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

impl PartialEq<Surface> for Surface

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

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

impl PartialOrd<Surface> for Surface

fn partial_cmp(&self, other: &Surface) -> 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 Reverse for Surface

fn reverse(self) -> Self

impl TransformObject for Surface

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 Copy for Surface

impl Eq for Surface

impl StructuralEq for Surface

impl StructuralPartialEq for Surface

Auto Trait Implementations

impl RefUnwindSafe for Surface

impl Send for Surface

impl Sync for Surface

impl Unpin for Surface

impl UnwindSafe for Surface

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for Twhere 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 Twhere T: Any + Send + Sync,

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

impl<T> From<T> for T

fn from(t: T) -> T

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

`SweptCurve(SweptCurve)`

pub fn vector_from_surface_coords(
&self,
vector: impl Into<Vector<2>>
) -> Vector<3>

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

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

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

fn curve_iter(&'r self) -> Iter<&'r Curve>ⓘ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 face_iter(&'r self) -> Iter<&'r Face>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

fn global_curve_iter(&'r self) -> Iter<&'r GlobalCurve>ⓘ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 shell_iter(&'r self) -> Iter<&'r Shell>ⓘ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 vertex_iter(&'r self) -> Iter<&'r Vertex>ⓘNotable traits for Iter<T>`impl<T> Iterator for Iter<T> type Item = T;`

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

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

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

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

impl<T> Downcast for Twhere
T: Any,

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

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

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

impl<T> Validate for Twhere
T: for<'r> ObjectIters<'r>,

fn validate_with_config(
self,
config: &ValidationConfig
) -> Result<Validated<T>, ValidationError>

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