Struct Sphere 

pub struct Sphere { /* private fields */ }

A sphere shape centered at the origin.

The sphere is defined by its radius and is commonly used for simple collision detection and physics calculations. The sphere is centered at the origin (0, 0, 0).

Examples

use phys_geom::shape::Sphere;

// Create a sphere with radius 1.0
let sphere = Sphere::new(1.0);
assert_eq!(sphere.radius(), 1.0);

// Use the predefined unit sphere
let unit_sphere = Sphere::UNIT;
assert_eq!(unit_sphere.radius(), 0.5);

Panics

• Sphere::new() panics if the radius is not positive
• Sphere::set_radius() panics if the new radius is not positive

Implementations

impl Sphere

pub const UNIT: Sphere

A unit sphere with radius 0.5.

This is useful as a reference size for normalized shapes.

pub fn new(radius: Real) -> Sphere

Creates a new sphere with the given radius.

Arguments

• radius - The radius of the sphere (must be positive)

Returns

A new Sphere instance with the specified radius.

Panics

Panics if radius is not positive.

Examples

use phys_geom::shape::Sphere;

let sphere = Sphere::new(2.5);
assert_eq!(sphere.radius(), 2.5);

pub const fn radius(&self) -> Real

Returns the radius of the sphere.

Returns

The radius as a Real (f32 or f64 depending on features).

Examples

use phys_geom::shape::Sphere;

let sphere = Sphere::new(3.0);
assert_eq!(sphere.radius(), 3.0);

pub fn set_radius(&mut self, value: Real)

Sets the radius of the sphere.

Arguments

• value - The new radius (must be positive)

Panics

Panics if value is not positive.

Examples

use phys_geom::shape::Sphere;

let mut sphere = Sphere::new(1.0);
sphere.set_radius(2.0);
assert_eq!(sphere.radius(), 2.0);

Trait Implementations

impl Clone for Sphere

fn clone(&self) -> Sphere

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComputeAabb3 for Sphere

fn compute_aabb(&self) -> Aabb3

Compute the AABB in local space.

impl ComputeVolume for Sphere

fn compute_volume(&self) -> Real

Computes the volume of this shape.

impl Debug for Sphere

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

Formats the value using the given formatter.

impl Default for Sphere

fn default() -> Sphere

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sphere

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sphere

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Sphere

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Sphere

impl StructuralPartialEq for Sphere