Struct fj_kernel::topology::Vertex

pub struct Vertex {
    pub point: Handle<Point<3>>,
}

A vertex

This struct exists to distinguish between vertices and points at the type level. This is a relevant distinction, as vertices are part of a shape that help define its topology.

Points, on the other hand, might be used to approximate a shape for various purposes, without presenting any deeper truth about the shape’s structure.

Equality

Please refer to [crate::kernel::topology] for documentation on the equality of topological objects.

Validation

A vertex that is part of a Shape must be structurally sound. That means the point it refers to must be part of the same shape.

Vertices must be unique within a shape, meaning another vertex defined by the same shape must not exist. In the context of vertex uniqueness, points that are close to each other are considered identical. The minimum distance between distinct vertices can be configured using [Shape::with_minimum_distance].

Fields

point: Handle<Point<3>>

The point that defines the location of the vertex

Implementations

impl Vertex

pub fn builder(shape: &mut Shape) -> VertexBuilder<'_>

Build a vertex using the VertexBuilder API

pub fn point(&self) -> Point<3>

Access the point that the vertex refers to

This is a convenience method that saves the caller from dealing with the Handle.

Trait Implementations

impl Clone for Vertex

fn clone(&self) -> Vertex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vertex

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

Formats the value using the given formatter.

impl Hash for Vertex

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 Ord for Vertex

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

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<Vertex> for Vertex

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

impl Object for Vertex

impl StructuralEq for Vertex