Struct fj_kernel::objects::Edge

pub struct Edge { /* private fields */ }

An edge

Implementations

impl Edge

pub fn build() -> EdgeBuilder

Build an edge using EdgeBuilder

pub fn new(
    curve: Curve,
    vertices: VerticesOfEdge<Vertex>,
    global: GlobalEdge
) -> Self

Create a new instance of Edge

If you only have a curve and the edge vertices, please check out Edge::from_curve_and_vertices, which is a convenience wrapper around this method, which creates an instance of GlobalEdge.

Panics

Panics, if the provided GlobalEdge instance doesn’t refer to the same GlobalCurve and GlobalVertex instances that the other objects that are passed refer to.

pub fn from_curve_and_vertices(
    curve: Curve,
    vertices: VerticesOfEdge<Vertex>
) -> Self

Create a new instance of Edge from a curve and vertices

The GlobalEdge instance is created from the provided curve and vertices. Please refer to Edge::new, if you already have a GlobalEdge instance that you can provide.

pub fn curve(&self) -> &Curve

Access the curve that defines the edge’s geometry

The edge can be a segment of the curve that is bounded by two vertices, or if the curve is continuous (i.e. connects to itself), the edge could be defined by the whole curve, and have no bounding vertices.

pub fn vertices(&self) -> &VerticesOfEdge<Vertex>

Access the vertices that bound the edge on the curve

An edge has either two bounding vertices or none. The latter is possible if the edge’s curve is continuous (i.e. connects to itself), and defines the whole edge.

pub fn global(&self) -> &GlobalEdge

Access the global form of this edge

Trait Implementations

impl Approx for Edge

type Approximation = Vec<Local<Point<1>>, Global>

The approximation of the object

fn approx(&self, tolerance: Tolerance) -> Self::Approximation

Approximate the object

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl Display for Edge

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

Formats the value using the given formatter.

impl Hash for Edge

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<'r> ObjectIters<'r> for Edge

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

Return all objects that this one references

fn edge_iter(&'r self) -> Iter<&'r Edge>

Iterate over all edges

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r GlobalCurve>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Vertex>

Iterator over all vertices

impl Ord for Edge

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

Restrict a value to a certain interval.

impl PartialEq<Edge> for Edge

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

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

type Swept = Face

The object that is created by sweeping the implementing object

fn sweep(
    self,
    path: impl Into<Path>,
    tolerance: impl Into<Tolerance>,
    color: Color
) -> Self::Swept

Sweep the object along the given path

impl TransformObject for Edge

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

Transform the object

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

Translate the object

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

Rotate the object

impl Copy for Edge

impl Eq for Edge

impl StructuralEq for Edge

impl StructuralPartialEq for Edge