Struct graphene::Plane

#[repr(transparent)]
pub struct Plane { /* private fields */ }

A 2D plane that extends infinitely in a 3D volume.

The contents of the Plane are private, and should not be modified directly.

Implementations

impl Plane

pub fn as_ptr(&self) -> *mut graphene_plane_t

impl Plane

pub fn distance(&self, point: &Point3D) -> f32

Computes the distance of point from a Plane.

point

a Point3D

Returns

the distance of the given Point3D from the plane

pub fn constant(&self) -> f32

Retrieves the distance along the normal vector of the given Plane from the origin.

Returns

the constant value of the plane

pub fn normal(&self) -> Vec3

Retrieves the normal vector pointing towards the origin of the given Plane.

Returns

normal

return location for the normal vector

pub fn negate(&self) -> Plane

Negates the normal vector and constant of a Plane, effectively mirroring the plane across the origin.

Returns

res

return location for the negated plane

pub fn normalize(&self) -> Plane

Normalizes the vector of the given Plane, and adjusts the constant accordingly.

Returns

res

return location for the normalized plane

pub fn transform( &self, matrix: &Matrix, normal_matrix: Option<&Matrix> ) -> Plane

Transforms a Plane self using the given matrix and normal_matrix.

If normal_matrix is None, a transformation matrix for the plane normal will be computed from matrix. If you are transforming multiple planes using the same matrix it’s recommended to compute the normal matrix beforehand to avoid incurring in the cost of recomputing it every time.

matrix

a Matrix

normal_matrix

a Matrix

Returns

res

the transformed plane

impl Plane

pub fn new(normal: Option<&Vec3>, constant: f32) -> Self

Initializes the given Plane using the given normal vector and constant values.

normal

a unit length normal vector defining the plane pointing towards the origin; if unset, we use the X axis by default

constant

the distance from the origin to the plane along the normal vector; the sign determines the half-space occupied by the plane

Returns

the initialized plane

pub fn from_point(normal: &Vec3, point: &Point3D) -> Self

Initializes the given Plane using the given normal vector and an arbitrary co-planar point.

normal

a normal vector defining the plane pointing towards the origin

point

a Point3D

Returns

the initialized plane

pub fn from_points(a: &Point3D, b: &Point3D, c: &Point3D) -> Self

Initializes the given Plane using the 3 provided co-planar points.

The winding order is counter-clockwise, and determines which direction the normal vector will point.

a

a Point3D

b

a Point3D

c

a Point3D

Returns

the initialized plane

pub fn from_vec4(src: &Vec4) -> Self

Initializes the given Plane using the components of the given Vec4 vector.

src

a Vec4 containing the normal vector in its first three components, and the distance in its fourth component

Returns

the initialized plane

Trait Implementations

impl Clone for Plane

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Plane

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

Formats the value using the given formatter.

impl PartialEq<Plane> for Plane

fn eq(&self, other: &Self) -> 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 StaticType for Plane

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for Plane

impl Eq for Plane