Struct Point3

source

pub struct Point3(/* private fields */);

Expand description

A point in 3D space.

This type is used to disambiguate geometric uses of “points” representing explicit points in space from “vectors” representing displacements or directions.

Points can implicitly deref into Vec3 to allow for easily using points in places where vectors are expected.

Implementations§

source §

impl Point3

source

pub const ORIGIN: Point3 = _

The origin point

source

pub const fn new(x: f32, y: f32, z: f32) -> Self

Create a new point

source

pub const fn from_vec3(v: &Vec3) -> Self

Create a new point from a vector

§Parameters

v - The vector to create the point from

source

pub const fn from_vec4(v: &Vec4) -> Self

Create a new point from a 4-component vector

This discards the w coordinate.

§Parameters

v - The vector to create the point from

source

pub const fn to_vector3(&self) -> Vector3

Convert the point to a vector

source §

impl Point3

source

pub const fn as_vec3(&self) -> &Vec3

Get the x-coordinate of the point

source

pub fn as_mut_vec3(&mut self) -> &mut Vec3

Get the x-coordinate of the point

source §

impl Point3

source

pub fn min(&self, other: &Point3) -> Point3

Get the minimum values between two points

§Parameters

other - The other point to compare against

source

pub fn max(&self, other: &Point3) -> Point3

Get the maximum values between two points

§Parameters

other - The other point to compare against

source

pub fn distance_to(&self, other: &Point3) -> f32

Get the distance between two points

§Parameters

other - The other point to get the distance to

source

pub fn square_distance_to(&self, other: &Point3) -> f32

Get the square distance between two points

§Parameters

other - The other point to get the square distance to

Methods from Deref<Target = Vec3>§

source

pub fn as_slice(&self) -> &[f32]

Returns this Vec3 as a slice of f32.

source

pub fn as_mut_slice(&mut self) -> &mut [f32]

Returns this Vec3 as a mutable slice of f32.

source

pub fn as_ptr(&self) -> *const f32

Returns this vector as a ptr of f32.

source

pub fn as_mut_ptr(&mut self) -> *mut f32

Returns this vector as a mutable ptr of f32.

source

pub fn iter(&self) -> impl Iterator<Item = &f32>

Returns an iterator over the vector.

source

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut f32>

Returns a mutable iterator over the vector.

source

pub fn x(&self) -> f32

Returns the X-coordinate of this 3-component vector.

source

pub fn y(&self) -> f32

Returns the Y-coordinate of this 3-component vector.

source

pub fn z(&self) -> f32

Returns the Z-coordinate of this 3-component vector.

source

pub fn xy(&self) -> &Vec2

Returns the xy coordinates of this vector as a Vec3.

source

pub fn yz(&self) -> &Vec2

Returns the yz coordinates of this vector as a Vec3.

source

pub fn x_mut(&mut self) -> &mut f32

Returns a mutable reference to the X-coordinate of this 3-component vector.

source

pub fn y_mut(&mut self) -> &mut f32

Returns a mutable reference to the Y-coordinate of this 3-component vector.

source

pub fn z_mut(&mut self) -> &mut f32

Returns a mutable reference to the Z-coordinate of this 3-component vector.

source

pub fn xy_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the xy coordinates of this vector.

source

pub fn yz_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the yz coordinates of this vector.

source

pub fn set_x(&mut self, x: f32)

Sets the x-component

§Parameters

x - the X-component

source

pub fn set_y(&mut self, y: f32)

Sets the y-component

§Parameters

y - the Y-component

source

pub fn set_z(&mut self, z: f32)

Sets the z-component

§Parameters

z - the Z-component

source

pub fn set_xy(&mut self, xy: &Vec2)

Sets the X and Y components of this vector

§Parameters

xy - the X and Y components o

source

pub fn set_yz(&mut self, xy: &Vec2)

Sets the Y and Z components of this vector

§Parameters

yz - the Y and Z components of the Vec3

source

pub fn set(&mut self, other: &Vec3)

Sets all the components of this vector the values from other.

§Parameters

other - the other Vec3 to set.

source

pub fn square_magnitude(&self) -> f32

Computes the square magnitude of this two-component vector.

source

pub fn magnitude(&self) -> f32

Computes the magnitude of this vector.

Where possible, consider using Vec3::square_magnitude as this will avoid the need to compute the square-root.

source

pub fn is_normalized(&self) -> bool

Queries whether this vector is normalized (e.g. has a magnitude of 1).

source

pub fn normalize(&mut self)

Normalizes this vector.

source

pub fn normalized(&self) -> Vector3

Returns normalized vector.

source

pub fn rotate_x<A: Angle>(&mut self, angle: A)

Rotates this vector around the X axis by angle A.

§Parameters

angle - the angle to rotate

source

pub fn rotate_y<A: Angle>(&mut self, angle: A)

Rotates this vector around the Y axis by angle A.

§Parameters

angle - the angle to rotate

source

pub fn rotate_z<A: Angle>(&mut self, angle: A)

Rotates this vector around the Y axis by angle A.

§Parameters

angle - the angle to rotate

source

pub fn is_finite(&self) -> bool

Returns whether all components of this Vec are finite.

§Example

Basic use:


let finite = Vector3::UNIT_X;
let not_finite = Vector3::new(f32::INFINITY, 3.0, 0.0);

assert!(finite.is_finite());
assert!(!not_finite.is_finite());

source

pub fn is_infinite(&self) -> bool

Returns whether any component of this vec are infinite.

This is the inverse operation of is_finite.

§Example

Basic use:


let finite = Vector3::UNIT_X;
let not_finite = Vector3::new(f32::INFINITY, 3.0, 0.0);

assert!(!finite.is_infinite());
assert!(not_finite.is_infinite());

source