Enum Primitive

#[non_exhaustive]
pub enum Primitive {
    Block {
        x: f64,
        y: f64,
        z: f64,
    },
    Sphere {
        radius: f64,
    },
    Cylinder {
        radius: f64,
        height: f64,
    },
    Cone {
        radius: f64,
        height: f64,
    },
    Pyramid {
        x: f64,
        y: f64,
        height: f64,
    },
    Torus {
        major_radius: f64,
        minor_radius: f64,
    },
    Wedge {
        x: f64,
        y: f64,
        height: f64,
        top_x_min: f64,
        top_x_max: f64,
        top_y_min: f64,
        top_y_max: f64,
    },
}

Exact primitive solid; tessellation is a separate operation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Block

Axis-aligned box in local coordinates.

Fields

x: f64

Extent along x.

y: f64

Extent along y.

z: f64

Extent along z.

Sphere

Sphere centered at the local origin.

Fields

radius: f64

Radius.

Cylinder

Cylinder along local +z.

Fields

radius: f64

Radius.

height: f64

Height.

Cone

Cone along local +z.

Fields

radius: f64

Base radius.

height: f64

Height.

Pyramid

Rectangular pyramid along local +z.

Fields

x: f64

Base extent along x.

y: f64

Base extent along y.

height: f64

Height.

Torus

Ring torus centred on the local origin, about local +z.

The tube’s centre circle has radius major_radius in the plane z = 0. Only a ring torus, 0 < minor_radius < major_radius, is a valid solid: at minor == major (a horn torus) the tube pinches the axis to a point, and past it (a spindle torus) the tube overlaps itself, so neither bounds a two-manifold solid.

Fields

major_radius: f64

Radius of the tube’s centre circle.

minor_radius: f64

Radius of the tube.

Wedge

Wedge: a box whose top face is narrowed or shifted, as OCCT’s BRepPrimAPI_MakeWedge(dx, dy, dz, xmin, zmin, xmax, zmax) with OCCT’s y (the height) read as local +z here.

The base is the rectangle [0, x] x [0, y] at z = 0 and the top is [top_x_min, top_x_max] x [top_y_min, top_y_max] at z = height. Every face is planar and the solid is the convex hull of the two rectangles. The top may collapse to a segment (top_x_min == top_x_max or top_y_min == top_y_max, a wedge proper) or to a point (a pyramid with its apex anywhere); OCCT’s ltx form is top_x_min = 0, top_x_max = ltx, top_y_min = 0, top_y_max = y.

Fields

x: f64

Base extent along x.

y: f64

Base extent along y.

height: f64

Height along z.

top_x_min: f64

Top face’s least x.

top_x_max: f64

Top face’s greatest x.

top_y_min: f64

Top face’s least y.

top_y_max: f64

Top face’s greatest y.

Trait Implementations

impl Clone for Primitive

fn clone(&self) -> Primitive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Primitive

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

Formats the value using the given formatter.

impl From<Primitive> for GeometryNode

fn from(value: Primitive) -> GeometryNode

Converts to this type from the input type.

impl PartialEq for Primitive

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

impl Copy for Primitive

impl StructuralPartialEq for Primitive