Struct nannou::geom::graph::edge::Edge

pub struct Edge<S = DefaultScalar> {
    pub kind: Kind,
    pub weight: S,
}

Describes an edge within the geometry graph.

Fields

kind: Kind

The unique kind of edge.

Represents the combination of Axis and Relative association described by the edge.

weight: S

A weight whose value's meaning depends on the edge's Relative association.

For Position kind edges this represents a relative scalar value. For Orientation kind edges this represents a relative angle in radians. For Scale kind edges this represents the relative scale.

Methods

impl<S> Edge<S>

pub fn new(kind: Kind, weight: S) -> Self

Simple constructor for an Edge.

pub fn x(relative: Relative, weight: S) -> Self

Simple constructor for an Edge describing a relative association over the X axis.

pub fn y(relative: Relative, weight: S) -> Self

Simple constructor for an Edge describing a relative association over the Y axis.

pub fn z(relative: Relative, weight: S) -> Self

Simple constructor for an Edge describing a relative association over the Z axis.

pub fn position(axis: Axis, weight: S) -> Self

Simple constructor for an Edge describing a relative position over the given axis.

pub fn orientation(axis: Axis, weight: S) -> Self

Simple constructor for an Edge describing a relative orientation over the given axis.

pub fn scale(axis: Axis, weight: S) -> Self

Simple constructor for an Edge describing a relative scale over the given axis.

pub fn x_position(weight: S) -> Self

Simple constructor for an Edge describing a relative position over the X axis.

pub fn x_orientation(weight: S) -> Self

Simple constructor for an Edge describing a relative orientation over the X axis.

pub fn x_scale(weight: S) -> Self

Simple constructor for an Edge describing a relative scale over the X axis.

pub fn y_position(weight: S) -> Self

Simple constructor for an Edge describing a relative position over the Y axis.

pub fn y_orientation(weight: S) -> Self

Simple constructor for an Edge describing a relative orientation over the Y axis.

pub fn y_scale(weight: S) -> Self

Simple constructor for an Edge describing a relative scale over the Y axis.

pub fn z_position(weight: S) -> Self

Simple constructor for an Edge describing a relative position over the Z axis.

pub fn z_orientation(weight: S) -> Self

Simple constructor for an Edge describing a relative orientation over the Z axis.

pub fn z_scale(weight: S) -> Self

Simple constructor for an Edge describing a relative scale over the Z axis.

Trait Implementations

impl<S: Copy> Copy for Edge<S>

impl<S: Clone> Clone for Edge<S>

fn clone(&self) -> Edge<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Edge<S>

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

Formats the value using the given formatter.

impl<S: PartialEq> PartialEq for Edge<S>

fn eq(&self, other: &Edge<S>) -> bool

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

fn ne(&self, other: &Edge<S>) -> bool

This method tests for !=.