Struct Torus 

pub struct Torus { /* private fields */ }

A torus, with the frame’s z as its axis of revolution.

Implementations

impl Torus

pub fn new( frame: Frame, major_radius: f64, minor_radius: f64, tol: Tolerances, ) -> OgeomResult<Self>

A torus about frame’s z axis.

major_radius is the distance from the axis to the centre of the tube; minor_radius is the tube’s own radius.

Errors

OgeomError::Construction if either radius is not finite and positive. A minor radius exceeding the major is allowed: that is a spindle torus, a real self-intersecting surface, and Torus::kind reports which case this is.

pub const fn frame(&self) -> Frame

The frame positioning this torus.

pub const fn centre(&self) -> Point

The centre.

pub const fn axis(&self) -> Axis

The axis of revolution.

pub const fn major_radius(&self) -> f64

The distance from the axis to the centre of the tube.

pub const fn minor_radius(&self) -> f64

The radius of the tube.

pub fn kind(&self, tol: Tolerances) -> TorusKind

Which of the three topological cases this torus falls into.

pub fn self_intersects(&self, tol: Tolerances) -> bool

Whether the surface passes through itself.

pub fn signed_distance_to(&self, p: Point) -> f64

The signed distance from p: negative inside, magnitude the distance to the nearest sheet.

For a TorusKind::Ring or TorusKind::Horn torus, inside is the tube. A TorusKind::Spindle torus passes through itself and bounds two nested regions, and “inside” cannot name both; here it names the outer one (the apple, the solid of revolution the outer sheet bounds, which contains the lemon) because that is the region the torus-as-a-solid occupies. The magnitude is measured to whichever sheet is nearer, the folded inner sheet included, so a point on either sheet reads zero.

pub fn distance_to(&self, p: Point) -> f64

The distance from p to the surface.

Correct for all three kinds. In the half-plane at a fixed azimuth, the surface’s profile is the generating circle folded about the axis: when the minor radius exceeds the major, part of that circle lies on the far side of the axis and sweeps to the near side. Measuring only to the unfolded branch (which is what the signed form does) then reports a point on the surface as being some distance off it.

pub fn contains(&self, p: Point, tol: Tolerances) -> bool

Whether p lies on the surface within tol.confusion().

pub fn area(&self) -> f64

The surface area, for a ring torus.

Meaningless for a spindle torus, whose surface overlaps itself.

pub fn volume(&self) -> f64

The volume enclosed, for a ring torus.

pub fn transformed(&self, t: &Transform, tol: Tolerances) -> OgeomResult<Self>

This torus moved by t.

Errors

OgeomError::Construction if the transformed frame is degenerate.

Trait Implementations

impl Clone for Torus

fn clone(&self) -> Torus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Torus

impl Debug for Torus

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

Formats the value using the given formatter.

impl PartialEq for Torus

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