Enum ClipShape 

#[non_exhaustive]
pub enum ClipShape {
    Plane {
        normal: [f32; 3],
        distance: f32,
        cap_colour: Option<[f32; 4]>,
        display_center: Option<[f32; 3]>,
    },
    Box {
        center: [f32; 3],
        half_extents: [f32; 3],
        orientation: [[f32; 3]; 3],
    },
    Sphere {
        center: [f32; 3],
        radius: f32,
    },
    Cylinder {
        center: [f32; 3],
        axis: [f32; 3],
        radius: f32,
        half_length: f32,
    },
}

A world-space half-space clipping plane for section views.

The shape of a ClipObject.

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.

Plane

Half-space plane : fragments where dot(p, normal) + distance >= 0 are kept.

Fields

normal: [f32; 3]

Unit normal pointing into the preserved half-space.

distance: f32

Signed distance from origin along normal.

cap_colour: Option<[f32; 4]>

Cap fill colour override. None = use the clipped mesh’s base_colour.

display_center: Option<[f32; 3]>

World-space point on the plane used to position the overlay quad.

When None, the renderer falls back to normal * (-distance), which is the closest point on the plane to the world origin. Set this to the user-facing origin (e.g. a drag handle position) so the overlay stays centred under the gizmo when the plane is translated laterally.

Box

Oriented box : fragments inside the box are kept.

Fields

center: [f32; 3]

World-space center of the box.

half_extents: [f32; 3]

Half-extents along each local axis.

orientation: [[f32; 3]; 3]

3×3 rotation matrix columns.

Sphere

Sphere : fragments inside the sphere are kept.

Fields

center: [f32; 3]

World-space center of the sphere.

radius: f32

Radius of the sphere.

Cylinder

Cylinder : fragments inside the cylinder are kept.

Fields

center: [f32; 3]

World-space center (midpoint of the axis segment).

axis: [f32; 3]

Unit axis direction.

radius: f32

Radius.

half_length: f32

Half-length along the axis (total length = 2 * half_length).

Trait Implementations

impl Clone for ClipShape

fn clone(&self) -> ClipShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClipShape

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

Formats the value using the given formatter.

impl PartialEq for ClipShape

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

impl StructuralPartialEq for ClipShape