Struct graphene::Frustum

pub struct Frustum(_);

A 3D volume delimited by 2D clip planes.

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

Implementations

impl Frustum

pub fn contains_point(&self, point: &Point3D) -> bool

Checks whether a point is inside the volume defined by the given Frustum.

point

a Point3D

Returns

true if the point is inside the frustum

pub fn init(
    &mut self,
    p0: &Plane,
    p1: &Plane,
    p2: &Plane,
    p3: &Plane,
    p4: &Plane,
    p5: &Plane
)

Initializes the given Frustum using the provided clipping planes.

p0

a clipping plane

p1

a clipping plane

p2

a clipping plane

p3

a clipping plane

p4

a clipping plane

p5

a clipping plane

Returns

the initialized frustum

pub fn init_from_frustum(&mut self, src: &Frustum)

Initializes the given Frustum using the clipping planes of another Frustum.

src

a Frustum

Returns

the initialized frustum

pub fn init_from_matrix(&mut self, matrix: &Matrix)

Initializes a Frustum using the given matrix.

matrix

a Matrix

Returns

the initialized frustum

pub fn intersects_box(&self, box_: &Box) -> bool

Checks whether the given box_ intersects a plane of a Frustum.

box_

a Box

Returns

true if the box intersects the frustum

pub fn intersects_sphere(&self, sphere: &Sphere) -> bool

Checks whether the given sphere intersects a plane of a Frustum.

sphere

a Sphere

Returns

true if the sphere intersects the frustum

impl Frustum

pub fn planes(&self) -> [Plane; 6]

Retrieves the planes that define the given Frustum.

Returns

planes

return location for an array of 6 Plane

pub fn new(
    p0: &Plane,
    p1: &Plane,
    p2: &Plane,
    p3: &Plane,
    p4: &Plane,
    p5: &Plane
) -> Frustum

pub fn from_frustum(src: &Frustum) -> Frustum

pub fn from_matrix(matrix: &Matrix) -> Frustum

Trait Implementations

impl Clone for Frustum

fn clone(&self) -> Frustum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frustum

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

Formats the value using the given formatter.

impl Hash for Frustum

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Frustum

fn cmp(&self, other: &Frustum) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Frustum> for Frustum

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 !=.

impl PartialOrd<Frustum> for Frustum

fn partial_cmp(&self, other: &Frustum) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Frustum

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Frustum