Struct pix_engine::shape::Sphere

#[repr(transparent)]
pub struct Sphere<T = i32>(_);

A Sphere positioned at (x, y, z) with radius.

Please see the module-level documentation for examples.

Implementations

impl<T> Sphere<T>

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

Constructs a Sphere at position (x, y, z) with radius.

impl<T: Copy> Sphere<T>

pub fn as_array(&self) -> [T; 4]

Returns Sphere as [x, y, z, radius].

pub fn as_bytes(&self) -> &[T; 4]

Returns Sphere as a byte slice &[x, y, z, radius].

pub fn as_bytes_mut(&mut self) -> &mut [T; 4]

Returns Sphere as a mutable byte slice &mut [x, y, z, radius].

impl<T: Num> Sphere<T>

pub fn with_position<P: Into<Point<T, 3>>>(p: P, radius: T) -> Self

Constructs a Sphere at position Point with radius.

pub fn x(&self) -> T

Returns the x-coordinate of the sphere.

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

Sets the x-coordinate of the sphere.

pub fn y(&self) -> T

Returns the y-coordinate of the sphere.

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

Sets the y-coordinate of the sphere.

pub fn z(&self) -> T

Returns the z-coordinate of the sphere.

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

Sets the z-coordinate of the sphere.

pub fn radius(&self) -> T

Returns the radius of the sphere.

pub fn set_radius(&mut self, radius: T)

Sets the radius of the sphere.

pub fn center(&self) -> Point<T, 3>

Returns the center Point.

impl<T> Sphere<T>

pub fn as_<U>(&self) -> Sphere<U> where
    U: 'static + Copy,
    T: AsPrimitive<U>, 

Converts Sphere < T > to Sphere < U >.

impl<T: Float> Sphere<T>

pub fn round(&self) -> Self

Returns Sphere < T > with the nearest integers to the numbers. Round half-way cases away from 0.0.

pub fn floor(&self) -> Self

Returns Sphere < T > with the largest integers less than or equal to the numbers.

pub fn ceil(&self) -> Self

Returns Sphere < T > with the smallest integers greater than or equal to the numbers.

Trait Implementations

impl<T> AsMut<[T; 4]> for Sphere<T>

fn as_mut(&mut self) -> &mut [T; 4]

Performs the conversion.

impl<T> AsRef<[T; 4]> for Sphere<T>

fn as_ref(&self) -> &[T; 4]

Performs the conversion.

impl<T: Clone> Clone for Sphere<T>

fn clone(&self) -> Sphere<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Num, const N: usize> Contains<T, N> for Sphere<T>

fn contains_point<P>(&self, p: P) -> bool where
    P: Into<Point<T, N>>, 

Returns whether this sphere contains a given Point.

fn contains_shape<O>(&self, other: O) -> bool where
    O: Into<Self::Shape>, 

Returns whether this sphere completely contains another sphere.

type Shape = Sphere<T>

The shape type. e.g. Rect<T>.

impl<T: Debug> Debug for Sphere<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Sphere<T>

fn default() -> Sphere<T>

Returns the “default value” for a type.

impl<T> Deref for Sphere<T>

type Target = [T; 4]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Sphere<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for Sphere<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Copy> From<&'_ [T; 4]> for Sphere<T>

fn from(arr: &[T; 4]) -> Self

Converts &[T; M] to Sphere < T >.

impl<T: Copy> From<&'_ Sphere<T>> for [T; 4]

fn from(t: &Sphere<T>) -> Self

Converts Sphere < T > to &[T; M].

impl<T> From<[T; 4]> for Sphere<T>

fn from(arr: [T; 4]) -> Self

Converts [T; M] to Sphere < T >.

impl<T> From<Sphere<T>> for [T; 4]

fn from(t: Sphere<T>) -> Self

Converts Sphere < T > to [T; M].

impl<T: Default> FromIterator<T> for Sphere<T>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = T>, 

Creates a value from an iterator.

impl<T: Hash> Hash for Sphere<T>

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<T> Index<usize> for Sphere<T>

type Output = T

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Sphere<T>

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: Num> Intersects<T, 3_usize> for Sphere<T>

fn intersects_line<L>(&self, _line: L) -> Option<(Point<T, 3>, T)> where
    L: Into<Line<T, 3>>, 

Returns the closest intersection point with a given line and distance along the line or None if there is no intersection.

fn intersects_shape<O>(&self, other: O) -> bool where
    O: Into<Self::Shape>, 

Returns whether this sphere intersects another sphere.

type Shape = Sphere<T>

The shape type. e.g. Rect<T>.

impl<T> IntoIterator for Sphere<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item, 4>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a Sphere<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Sphere<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<Sphere<T>> for Sphere<T>

fn eq(&self, other: &Sphere<T>) -> bool

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

fn ne(&self, other: &Sphere<T>) -> bool

This method tests for !=.

impl<T> Serialize for Sphere<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for Sphere<T>

impl<T: Eq> Eq for Sphere<T>

impl<T> StructuralEq for Sphere<T>

impl<T> StructuralPartialEq for Sphere<T>