Struct fj_kernel::objects::Sketch

source · [−]

pub struct Sketch { /* private fields */ }

Expand description

A 2-dimensional shape

Implementation Note

The faces that make up the sketch must be in the same surface. This is not currently validated.

Implementations

source

impl Sketch

source

pub fn builder(stores: &Stores, surface: Handle<Surface>) -> SketchBuilder<'_>

Build a Sketch using SketchBuilder

source

pub fn new() -> Self

Construct an empty instance of Sketch

source

pub fn with_faces(self, faces: impl IntoIterator<Item = impl Into<Face>>) -> Self

Add faces to the sketch

Consumes the sketch and returns the updated instance.

source

pub fn faces(&self) -> &Faces

Access the sketch’s faces

source

pub fn into_faces(self) -> Faces

Convert the sketch into a list of faces

Trait Implementations

source

impl Approx for &Sketch

type Approximation = BTreeSet<FaceApprox, Global>

The approximation of the object

type Cache = CurveCache

The cache used to cache approximation results

source

fn approx_with_cache(
 self,
 tolerance: impl Into<Tolerance>,
 cache: &mut Self::Cache
) -> Self::Approximation

Approximate the object, using the provided cache Read more

source

fn approx(self, tolerance: impl Into<Tolerance>) -> Self::Approximation

Approximate the object Read more

source

impl Clone for Sketch

source

fn clone(&self) -> Sketch

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 Sketch

source

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

Formats the value using the given formatter. Read more

source

impl Default for Sketch

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl Hash for Sketch

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 Sketch

source

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

Return all objects that this one references

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

Iterate over all half-edges

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

source

fn cmp(&self, other: &Sketch) -> 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<Sketch> for Sketch

source

fn eq(&self, other: &Sketch) -> 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<Sketch> for Sketch

source

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

type Swept = Solid

The object that is created by sweeping the implementing object

source

fn sweep(self, path: impl Into<Vector<3>>, stores: &Stores) -> Self::Swept

Sweep the object along the given path

source

impl TransformObject for Sketch

source

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

Transform the object

source

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

Translate the object Read more

source

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

Rotate the object Read more

source

impl Eq for Sketch

source

impl StructuralEq for Sketch

source

impl StructuralPartialEq for Sketch

Auto Trait Implementations

impl !RefUnwindSafe for Sketch

impl Send for Sketch

impl Sync for Sketch

impl Unpin for Sketch

impl !UnwindSafe for Sketch

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

Struct fj_kernel::objects::Sketch

Implementation Note

Implementations

impl Sketch

pub fn builder(stores: &Stores, surface: Handle<Surface>) -> SketchBuilder<'_>

pub fn new() -> Self

pub fn with_faces(self, faces: impl IntoIterator<Item = impl Into<Face>>) -> Self

pub fn faces(&self) -> &Faces

pub fn into_faces(self) -> Faces

Trait Implementations

impl Approx for &Sketch

type Approximation = BTreeSet<FaceApprox, Global>

type Cache = CurveCache

fn approx_with_cache( self, tolerance: impl Into<Tolerance>, cache: &mut Self::Cache) -> Self::Approximation

fn approx(self, tolerance: impl Into<Tolerance>) -> Self::Approximation

impl Clone for Sketch

fn clone(&self) -> Sketch

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

impl Debug for Sketch

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

impl Default for Sketch

fn default() -> Self

impl Hash for Sketch

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 Sketch

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

fn sketch_iter(&'r self) -> Iter<&'r Sketch>ⓘ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 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 Handle<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 half_edge_iter(&'r self) -> Iter<&'r HalfEdge>ⓘ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 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 Sketch

fn cmp(&self, other: &Sketch) -> 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<Sketch> for Sketch

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

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

impl PartialOrd<Sketch> for Sketch

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

type Swept = Solid

fn sweep(self, path: impl Into<Vector<3>>, stores: &Stores) -> Self::Swept

impl TransformObject for Sketch

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

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

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

impl Eq for Sketch

impl StructuralEq for Sketch

impl StructuralPartialEq for Sketch

Auto Trait Implementations

impl !RefUnwindSafe for Sketch

impl Send for Sketch

impl Sync for Sketch

impl Unpin for Sketch

impl !UnwindSafe for Sketch

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)

fn approx_with_cache(
self,
tolerance: impl Into<Tolerance>,
cache: &mut Self::Cache
) -> Self::Approximation

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

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

fn sketch_iter(&'r self) -> Iter<&'r Sketch>ⓘ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 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 Handle<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 half_edge_iter(&'r self) -> Iter<&'r HalfEdge>ⓘ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 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;`

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,