Struct fj_kernel::objects::Vertex

pub struct Vertex { /* private fields */ }

A vertex

Vertex is defined in terms of a 1-dimensional position on a curve. If you need the 3D position of a vertex, you can use Vertex::global_form, to get access of the global form of a vertex (GlobalVertex).

Implementations

impl Vertex

pub fn new(
    position: impl Into<Point<1>>,
    curve: Handle<Curve>,
    surface_form: Handle<SurfaceVertex>
) -> Self

Construct an instance of Vertex

Panics, if curve and surface_form are not defined on the same surface.

pub fn position(&self) -> Point<1>

Access the position of the vertex on the curve

pub fn curve(&self) -> &Handle<Curve>

Access the curve that the vertex is defined on

pub fn surface_form(&self) -> &Handle<SurfaceVertex>

Access the surface form of this vertex

pub fn global_form(&self) -> &Handle<GlobalVertex>

Access the global form of this vertex

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 From<&Vertex> for PartialVertex

fn from(vertex: &Vertex) -> Self

Converts to this type from the input type.

impl HasPartial for Vertex

type Partial = PartialVertex

The type representing the partial variant of this object

fn partial() -> Self::Partial

Create an empty partial variant of this object

fn to_partial(&self) -> Self::Partial

Convert this object into its partial variant

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,
    Self: Sized,

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) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Vertex> for Vertex

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

type Error = VertexValidationError

The error that validation of the implementing type can result in

fn validate_with_config(
    &self,
    config: &ValidationConfig
) -> Result<(), Self::Error>

Validate the object

fn validate(&self) -> Result<(), Self::Error>

Validate the object using default configuration

impl Eq for Vertex

impl StructuralEq for Vertex

impl StructuralPartialEq for Vertex