Struct graphene::Sphere

pub struct Sphere(_);

A sphere, represented by its center and radius.

Implementations

impl Sphere

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

Checks whether the given point is contained in the volume of a Sphere.

point

a Point3D

Returns

true if the sphere contains the point

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

Computes the distance of the given point from the surface of a Sphere.

point

a Point3D

Returns

the distance of the point

pub fn bounding_box(&self) -> Box

Computes the bounding box capable of containing the given Sphere.

Returns

box_

return location for the bounding box

pub fn center(&self) -> Point3D

Retrieves the coordinates of the center of a Sphere.

Returns

center

return location for the coordinates of the center

pub fn radius(&self) -> f32

Retrieves the radius of a Sphere.

pub fn init(&mut self, center: Option<&Point3D>, radius: f32)

Initializes the given Sphere with the given center and radius.

center

the coordinates of the center of the sphere, or None for a center in (0, 0, 0)

radius

the radius of the sphere

Returns

the initialized Sphere

pub fn is_empty(&self) -> bool

Checks whether the sphere has a zero radius.

Returns

true if the sphere is empty

pub fn translate(&self, point: &Point3D) -> Sphere

Translates the center of the given Sphere using the point coordinates as the delta of the translation.

point

the coordinates of the translation

Returns

res

return location for the translated sphere

impl Sphere

pub fn init_from_points(
    &mut self,
    points: &[&Point3D],
    center: Option<&Point3D>
)

Initializes the given Sphere using the given array of 3D coordinates so that the sphere includes them.

The center of the sphere can either be specified, or will be center of the 3D volume that encompasses all points.

points

an array of Point3D

center

the center of the sphere

Returns

the initialized Sphere

pub fn init_from_vectors(&mut self, vectors: &[&Vec3], center: Option<&Point3D>)

Initializes the given Sphere using the given array of 3D coordinates so that the sphere includes them.

The center of the sphere can either be specified, or will be center of the 3D volume that encompasses all vectors.

vectors

an array of Vec3

center

the center of the sphere

Returns

the initialized Sphere

pub fn new(center: Option<&Point3D>, radius: f32) -> Sphere

pub fn from_points(points: &[&Point3D], center: Option<&Point3D>) -> Sphere

pub fn from_vectors(vectors: &[&Vec3], center: Option<&Point3D>) -> Sphere

Trait Implementations

impl Clone for Sphere

fn clone(&self) -> Sphere

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sphere

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

Formats the value using the given formatter.

impl Hash for Sphere

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 Sphere

fn cmp(&self, other: &Sphere) -> 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<Sphere> for Sphere

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<Sphere> for Sphere

fn partial_cmp(&self, other: &Sphere) -> 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 Sphere

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Sphere