Struct Vertex2

pub struct Vertex2<T: CoordsFloat>(pub T, pub T);

2D vertex representation

Generics

• T: CoordsFloat – Generic type for coordinates representation.

Example

use honeycomb_core::prelude::{Vector2, Vertex2};

let v1 = Vertex2(1.0, 0.0);
let v2 = Vertex2(1.0, 1.0);

assert_eq!(v1.x(), 1.0);
assert_eq!(v1.y(), 0.0);

let two: f64 = 2.0;
// vectorAB = vertexB - vertexA
let v2_minus_v1: Vector2<f64> = v2 - v1;

assert_eq!(v2_minus_v1.norm(), 1.0);
assert_eq!(v2_minus_v1.unit_dir()?, Vector2::unit_y());

let mut v3 = Vertex2(0.0, 1.0);
// vertexA + vectorB = vertexA'
v3 += v2_minus_v1;

assert_eq!(v3.x(), 0.0);
assert_eq!(v3.y(), 2.0);

Tuple Fields

0: T

1: T

Implementations

impl<T: CoordsFloat> Vertex2<T>

pub fn into_inner(self) -> (T, T)

Consume self to return inner value

Return

Return coordinate values as a simple tuple.

pub fn x(&self) -> T

Getter

Return

Return the value of the x coordinate of the vertex.

pub fn y(&self) -> T

Getter

Return

Return the value of the y coordinate of the vertex.

pub fn average(lhs: &Vertex2<T>, rhs: &Vertex2<T>) -> Vertex2<T>

Compute the mid-point between two vertices.

Return

Return the mid-point as a new Vertex2 object.

Panics

This function may panic if it cannot initialize an object T: CoordsFloat from the value 2.0. The chance of this happening when using T = f64 or T = f32 is most likely zero.

Example

use honeycomb_core::prelude::Vertex2;

let far_far_away: Vertex2<f64> = Vertex2(2.0, 2.0);
let origin: Vertex2<f64> = Vertex2::default();

assert_eq!(Vertex2::average(&origin, &far_far_away), Vertex2(1.0, 1.0));

Trait Implementations

impl<T: CoordsFloat> Add<&Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vector2<T>) -> Self::Output

Performs the + operation.

impl<T: CoordsFloat> Add<Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2<T>) -> Self::Output

Performs the + operation.

impl<T: CoordsFloat> AddAssign<&Vector2<T>> for Vertex2<T>

fn add_assign(&mut self, rhs: &Vector2<T>)

Performs the += operation.

impl<T: CoordsFloat> AddAssign<Vector2<T>> for Vertex2<T>

fn add_assign(&mut self, rhs: Vector2<T>)

Performs the += operation.

impl<T: CoordsFloat> AttributeBind for Vertex2<T>

Attribute support definitions

• BINDS TO 0-CELLS

const BIND_POLICY: OrbitPolicy = OrbitPolicy::Vertex

OrbitPolicy determining the kind of topological entity to which the attribute is associated.

type StorageType = AttrSparseVec<Vertex2<T>>

Storage type used for the attribute.

type IdentifierType = u32

Identifier type of the entity the attribute is bound to.

impl<T: CoordsFloat> AttributeUpdate for Vertex2<T>

Attribute logic definitions

• MERGING POLICY - The new vertex is placed at the midpoint between the two existing ones.
• SPLITTING POLICY - The current vertex is duplicated.
• (PARTIALLY) UNDEFINED ATTRIBUTES MERGING - The default implementations are used.

fn merge(attr1: Self, attr2: Self) -> Self

Merging routine, i.e. how to obtain the new attribute value from the two existing ones.

fn split(attr: Self) -> (Self, Self)

Splitting routine, i.e. how to obtain the two attributes from a single one.

fn merge_incomplete(attr: Self) -> Self

Fallback merging routine, i.e. how to obtain the new attribute value from a single existing value.

fn merge_from_none() -> Option<Self>

Fallback merging routine, i.e. how to obtain the new attribute value from no existing value.

impl<T: Clone + CoordsFloat> Clone for Vertex2<T>

fn clone(&self) -> Vertex2<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + CoordsFloat> Debug for Vertex2<T>

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

Formats the value using the given formatter.

impl<T: Default + CoordsFloat> Default for Vertex2<T>

fn default() -> Vertex2<T>

Returns the “default value” for a type.

impl<T: CoordsFloat> From<(T, T)> for Vertex2<T>

fn from((x, y): (T, T)) -> Self

Converts to this type from the input type.

impl<T: CoordsFloat> From<Vertex2<T>> for Vertex3<T>

fn from(v: Vertex2<T>) -> Self

Converts to this type from the input type.

impl<T: PartialEq + CoordsFloat> PartialEq for Vertex2<T>

fn eq(&self, other: &Vertex2<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: CoordsFloat> Sub<&Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vector2<T>) -> Self::Output

Performs the - operation.

impl<T: CoordsFloat> Sub<Vector2<T>> for Vertex2<T>

type Output = Vertex2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2<T>) -> Self::Output

Performs the - operation.

impl<T: CoordsFloat> Sub for Vertex2<T>

type Output = Vector2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vertex2<T>) -> Self::Output

Performs the - operation.

impl<T: CoordsFloat> SubAssign<&Vector2<T>> for Vertex2<T>

fn sub_assign(&mut self, rhs: &Vector2<T>)

Performs the -= operation.

impl<T: CoordsFloat> SubAssign<Vector2<T>> for Vertex2<T>

fn sub_assign(&mut self, rhs: Vector2<T>)

Performs the -= operation.

impl<T: Copy + CoordsFloat> Copy for Vertex2<T>

impl<T: CoordsFloat> Send for Vertex2<T>

impl<T: CoordsFloat> StructuralPartialEq for Vertex2<T>

impl<T: CoordsFloat> Sync for Vertex2<T>