Struct Cylinder 

pub struct Cylinder { /* private fields */ }

A cylinder shape centered at the origin, aligned along the Y-axis.

A cylinder is a three-dimensional shape with a circular cross-section. It’s commonly used in physics engines for representing pillars, pipes, wheels, and other cylindrical objects.

The cylinder is centered at the origin (0, 0, 0) with its axis aligned to the Y-axis. It extends from -half_height to +half_height along the Y-axis.

Examples

use phys_geom::shape::Cylinder;

// Create a cylinder with height 3.0 and radius 0.8
let cylinder = Cylinder::new(1.5, 0.8);
assert_eq!(cylinder.height(), 3.0);
assert_eq!(cylinder.radius(), 0.8);

Dimensions

• half_height: Half the height of the cylinder
• radius: Radius of the circular cross-section
• Total height = 2 * half_height

Implementations

impl Cylinder

pub fn new(half_height: Real, radius: Real) -> Self

Creates a new cylinder with the given dimensions.

Arguments

• half_height - Half the height of the cylinder (must be positive)
• radius - The radius of the cylinder (must be positive)

Returns

A new Cylinder instance.

Panics

Panics if half_height or radius is not positive.

Examples

use phys_geom::shape::Cylinder;

// Create a cylinder with total height 4.0 and radius 1.0
let cylinder = Cylinder::new(2.0, 1.0);
assert_eq!(cylinder.height(), 4.0);
assert_eq!(cylinder.radius(), 1.0);

pub fn height(&self) -> Real

Returns the total height of the cylinder.

Returns

The total height as a Real.

Examples

use phys_geom::shape::Cylinder;

let cylinder = Cylinder::new(1.5, 0.8);
assert_eq!(cylinder.height(), 3.0);

pub fn half_height(&self) -> Real

Returns the half height of the cylinder.

This is the distance from the center to either end of the cylinder.

Returns

The half height as a Real.

Examples

use phys_geom::shape::Cylinder;

let cylinder = Cylinder::new(1.5, 0.8);
assert_eq!(cylinder.half_height(), 1.5);

pub fn radius(&self) -> Real

Returns the radius of the cylinder.

Returns

The radius as a Real.

Examples

use phys_geom::shape::Cylinder;

let cylinder = Cylinder::new(1.5, 0.8);
assert_eq!(cylinder.radius(), 0.8);

Trait Implementations

impl Clone for Cylinder

fn clone(&self) -> Cylinder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComputeAabb3 for Cylinder

fn compute_aabb(&self) -> Aabb3

Compute the AABB in local space.

impl ComputeVolume for Cylinder

fn compute_volume(&self) -> Real

Computes the volume of this shape.

impl Debug for Cylinder

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

Formats the value using the given formatter.

impl Default for Cylinder

fn default() -> Cylinder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cylinder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Cylinder

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

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 Cylinder

impl StructuralPartialEq for Cylinder