Struct gdnative::prelude::Plane

#[repr(C)]pub struct Plane {
    pub normal: Vector3D<f32, UnknownUnit>,
    pub d: f32,
}

Plane in hessian form.

Fields

normal: Vector3D<f32, UnknownUnit>

d: f32

Implementations

impl Plane

pub fn new(normal: Vector3D<f32, UnknownUnit>, d: f32) -> Plane

Creates a new Plane from the 'Vector3' normal and the distance from the origin.

pub fn from_coordinates(a: f32, b: f32, c: f32, d: f32) -> Plane

Creates a new Plane from four floats. a, b, c are used for the normal 'Vector3'. d is the distance from the origin.

pub fn from_points(
    a: Vector3D<f32, UnknownUnit>,
    b: Vector3D<f32, UnknownUnit>,
    c: Vector3D<f32, UnknownUnit>
) -> Option<Plane>

Creates a new Plane from three Vector3, given in clockwise order. If all three points are collinear, returns None.

pub fn center(&self) -> Vector3D<f32, UnknownUnit>

Returns the center of the Plane.

pub fn distance_to(&self, point: Vector3D<f32, UnknownUnit>) -> f32

Returns the shortest distance from the Plane to point.

pub fn has_point(&self, point: Vector3D<f32, UnknownUnit>, epsilon: f32) -> bool

Returns true if point is inside the Plane. epislon specifies the minimum threshold to be considered inside the Plane.

pub fn intersect_3(
    &self,
    b: Plane,
    c: Plane
) -> Option<Vector3D<f32, UnknownUnit>>

Returns the intersection point of the three planes b, c and this Plane. Returns None if the 'Plane's don't intersect.

pub fn intersects_ray(
    &self,
    from: Vector3D<f32, UnknownUnit>,
    dir: Vector3D<f32, UnknownUnit>
) -> Option<Vector3D<f32, UnknownUnit>>

Returns the intersection point of a ray consisting of the position from and the direction normal dir with this plane/ Returns None if the ray doesn't intersect.

pub fn intersects_segment(
    &self,
    begin: Vector3D<f32, UnknownUnit>,
    end: Vector3D<f32, UnknownUnit>
) -> Option<Vector3D<f32, UnknownUnit>>

Returns the intersection point of a segment from begin to end with this Plane. Returns None if the the segment doesn't intersect.

pub fn approx_eq(&self, other: Plane) -> bool

Returns true if this Plane and other are approximately equal. Determined by running approx_eq on both normal and d.

pub fn is_point_over(&self, point: Vector3D<f32, UnknownUnit>) -> bool

Returns true if point is above the Plane.

pub fn normalize(self) -> Plane

Returns the Plane normalized.

pub fn project(
    &self,
    point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

Returns the orthogonal projection of point into a point in the Plane.

Trait Implementations

impl Clone for Plane

fn clone(&self) -> Plane

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Plane

impl Debug for Plane

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

Formats the value using the given formatter.

impl Export for Plane

type Hint = ()

A type-specific hint type that is valid for the type being exported.

fn export_info(_hint: Option<<Plane as Export>::Hint>) -> ExportInfo

Returns ExportInfo given an optional typed hint.

impl FromVariant for Plane

fn from_variant(variant: &Variant) -> Result<Plane, FromVariantError>

impl PartialEq<Plane> for Plane

fn eq(&self, other: &Plane) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Plane

impl ToVariant for Plane

fn to_variant(&self) -> Variant