Struct picocadrs::assets::point::Point3D

pub struct Point3D<T> {
    pub x: T,
    pub y: T,
    pub z: T,
}

Represents a 3-dimensional point in space. In this crates context mostly used for displaying points of vertices.

It can be either created by using the method new or by using the point! macro.

Example

use picocadrs::assets::Point3D;
use picocadrs::point;

let mut point = Point3D::new(2, 4, -1);

assert_eq!(point.x, 2);
assert_eq!(point.y, 4);
assert_eq!(point.z, -1);

assert_eq!(point, point!(2, 4, -1));

point.set(1, 2, 3);
assert_eq!(point, point!(1, 2, 3));

assert_eq!(point + point, point!(2, 4, 6));
assert_eq!(point - point, point!(0, 0, 0));

Fields

x: T

y: T

z: T

Implementations

impl<T> Point3D<T>

pub fn new(x: T, y: T, z: T) -> Point3D<T>

Used to create new points in a 3-dimensional space. Takes the points x, y and z coordinates as arguments.

A simpler way to create new Point3Ds is to use the point! macro.

Example

use picocadrs::assets::Point3D;
use picocadrs::point;

let point = Point3D::new(2, 4, -1);

assert_eq!(point.x, 2);
assert_eq!(point.y, 4);
assert_eq!(point.z, -1);

assert_eq!(point, point!(2, 4, -1));

pub fn set(&mut self, x: T, y: T, z: T)

Sets the points coordinates to the ones given.

Example

use picocadrs::assets::Point3D;

let mut point = Point3D::new(2, 4, -1);

assert_eq!(point.x, 2);
assert_eq!(point.y, 4);
assert_eq!(point.z, -1);

point.set(-3, 4, 2);

assert_eq!(point.x, -3);
assert_eq!(point.y, 4);
assert_eq!(point.z, 2);

pub fn map(&mut self, f: fn(_: &T) -> T)

Used to apply functions on every coordinate.

Example

use picocadrs::assets::Point3D;

let mut point = Point3D::new(2, 3, -1);

assert_eq!(point, Point3D::new(2, 3, -1));
point.map(|c| {
   c * 2
});
assert_eq!(point, Point3D::new(4, 6, -2));

Trait Implementations

impl<T: Add<Output = T>> Add for Point3D<T>

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

Adds points together.

Example

use picocadrs::assets::Point3D;

let p1 = Point3D::new(1, 4, -2);
let p2 = Point3D::new(2, -2, 3);

assert_eq!(p1 + p2, Point3D::new(3, 2, 1));

type Output = Point3D<T>

The resulting type after applying the + operator.

impl<T: Clone> Clone for Point3D<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Point3D<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Point3D<T>

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

Formats the value using the given formatter.

impl FromStr for Point3D<f64>

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a Point3D from a string representing a lua table with 3 float values. Fails if table does not have 3 fields or they cant be parsed into f64.

Example

use picocadrs::assets::Point3D;

assert_eq!(
    "0,-1.5,2.2",
    "{0,-1.5,2.2}".parse::<Point3D<f64>>().unwrap().to_string()
)

type Err = PicoError

The associated error which can be returned from parsing.

impl<T: PartialEq> PartialEq for Point3D<T>

fn eq(&self, other: &Point3D<T>) -> 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<T: Sub<Output = T>> Sub for Point3D<T>

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

Subtracts points from each other.

Example

use picocadrs::assets::Point3D;

let p1 = Point3D::new(1, 4, 2);
let p2 = Point3D::new(2, 1, -4);

assert_eq!(p1 - p2, Point3D::new(-1, 3, 6));

type Output = Point3D<T>

The resulting type after applying the - operator.

impl TryFrom<Table<'_>> for Point3D<f64>

fn try_from(value: Table<'_>) -> Result<Self, Self::Error>

Tries to create a Point3D from a lua table. Only succeeds if the table has 3 fields that can be parsed into a f64. Partly used as a helper method to parse from a string.

type Error = PicoError

The type returned in the event of a conversion error.

impl<T: Copy> Copy for Point3D<T>

impl<T: Eq> Eq for Point3D<T>

impl<T> StructuralPartialEq for Point3D<T>