Struct ClipObject 

#[non_exhaustive]
pub struct ClipObject {
    pub shape: ClipShape,
    pub color: Option<[f32; 4]>,
    pub edge_color: Option<[f32; 4]>,
    pub clip_geometry: bool,
    pub enabled: bool,
    pub extent: f32,
    pub hovered: bool,
    pub active: bool,
}

A clip object : defines a clipping region and optional visual boundary rendering.

Push into EffectsFrame::clip_objects each frame. Up to 6 Plane variants are supported simultaneously; only the first Box or Sphere variant takes effect (subsequent ones are silently ignored).

Set color to Some(rgba) to have the renderer draw the clip boundary automatically. For planes this produces a semi-transparent fill quad + border; for box/sphere, a wireframe outline. Leave color as None for silent clipping with no visual.

The hovered and active flags are written by ClipPlaneController and read by the renderer to vary the plane overlay appearance (brighter when hovered, tinted when active).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

shape: ClipShape

The clipping shape (plane, box, or sphere).

color: Option<[f32; 4]>

RGBA fill color for the plane quad. None = no fill drawn.

When both color and edge_color are None, no visual is drawn at all.

edge_color: Option<[f32; 4]>

RGBA color for the plane border edge. None = derive from color (original behaviour).

Set independently to show a visible edge while keeping the fill transparent.

clip_geometry: bool

Whether this object clips rendered geometry via the GPU clip-plane uniform.

Set to false to produce only a visual indicator without affecting geometry. Default: true.

enabled: bool

Whether this object is active. Disabled objects are ignored entirely.

extent: f32

Visual and hit-test half-extent for Plane shapes (world units). Default 4.5.

hovered: bool

Hover state : set by ClipPlaneController, read by renderer.

active: bool

Active drag state : set by ClipPlaneController, read by renderer.

Implementations

impl ClipObject

pub fn plane(normal: [f32; 3], distance: f32) -> Self

Create a half-space plane clip object.

pub fn box_shape( center: [f32; 3], half_extents: [f32; 3], orientation: [[f32; 3]; 3], ) -> Self

Create an oriented box clip object.

pub fn sphere(center: [f32; 3], radius: f32) -> Self

Create a sphere clip object.

Trait Implementations

impl Clone for ClipObject

fn clone(&self) -> ClipObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClipObject

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

Formats the value using the given formatter.

impl Default for ClipObject

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ClipObject

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

impl StructuralPartialEq for ClipObject