Struct Square

#[repr(C)]
pub struct Square<T> {
    pub x: T,
    pub y: T,
    pub s: T,
}

A square is a special case of a rectangle_2d, where the width and height are equal.

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Square::new(0.0, 0.0, 1.0);

Fields

x: T

The origin x points of the square.

y: T

The origin y points of the square.

s: T

The side length of the square.

Implementations

impl<T> Square<T>

where T: Num + Clone,

pub fn new(x: T, y: T, side: T) -> Self

Create a square_2d from 3 properties

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Square::new(0.0, 0.0, 1.0);

pub fn from_anchor<P>(anchor: P, side: T) -> Self

where P: Into<Point<T>>,

Create a square_2d from origin and side

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Square::from_anchor((0.0, 0.0), 1.0);

pub fn from_center<P>(center: P, side: T) -> Self

where P: Into<Point<T>>,

Create a rectangle_2d from center and side

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Square::from_center((0.0, 0.0), 1.0);

impl<T> Square<T>

pub fn origin(&self) -> Point<&T>

where T: Clone,

Get the origin of the square.

Trait Implementations

impl<T: Clone> Clone for Square<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Square<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Square<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for Square<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Square<T>

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<T: PartialEq> PartialEq for Square<T>

fn eq(&self, other: &Square<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> Serialize for Square<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Shape2D for Square<T>

where T: Signed + Clone + PartialOrd,

type Value = T

The value type of the shape.

type VertexIterator<'a> = IntoIter<Point<T>> where T: 'a

The value type of the shape.

type LineIterator<'a> = IntoIter<Line<T>> where T: 'a

The value type of the shape.

fn is_valid(&self) -> bool

Returns true if the shape is valid and in normal form.

fn normalize(&mut self) -> bool

Returns true if the shape successfully normalized.

fn boundary(&self) -> Rectangle<Self::Value>

Returns the boundary of the shape.

fn vertices<'a>(&'a self, _: usize) -> Self::VertexIterator<'a>

Returns the owned vertices of the shape.

fn edges<'a>(&'a self, _: usize) -> Self::LineIterator<'a>

Returns the owned edges of the shape.

impl<T: Copy> Copy for Square<T>

impl<T: Eq> Eq for Square<T>

impl<T> StructuralPartialEq for Square<T>