Struct SlicePlane 

pub struct SlicePlane { /* private fields */ }

A slice plane that can cut through geometry.

The plane is defined by a point (origin) and a normal direction. Geometry on the negative side of the plane (opposite to normal) is discarded.

Implementations

impl SlicePlane

pub fn new(name: impl Into<String>) -> Self

Creates a new slice plane with default settings.

By default, the plane is at the origin with +Y normal.

pub fn with_pose(name: impl Into<String>, origin: Vec3, normal: Vec3) -> Self

Creates a slice plane with specific pose.

pub fn name(&self) -> &str

Returns the name of this slice plane.

pub fn origin(&self) -> Vec3

Returns the origin point of the plane.

pub fn set_origin(&mut self, origin: Vec3)

Sets the origin point of the plane.

pub fn normal(&self) -> Vec3

Returns the normal direction of the plane.

pub fn set_normal(&mut self, normal: Vec3)

Sets the normal direction of the plane.

pub fn set_pose(&mut self, origin: Vec3, normal: Vec3)

Sets both origin and normal at once.

pub fn is_enabled(&self) -> bool

Returns whether the slice plane is enabled.

pub fn set_enabled(&mut self, enabled: bool)

Sets whether the slice plane is enabled.

pub fn draw_plane(&self) -> bool

Returns whether to draw the plane visualization.

pub fn set_draw_plane(&mut self, draw: bool)

Sets whether to draw the plane visualization.

pub fn draw_widget(&self) -> bool

Returns whether to draw the widget.

pub fn set_draw_widget(&mut self, draw: bool)

Sets whether to draw the widget.

pub fn color(&self) -> Vec4

Returns the color of the plane visualization.

pub fn set_color(&mut self, color: Vec3)

Sets the color of the plane visualization.

pub fn transparency(&self) -> f32

Returns the transparency of the plane visualization.

pub fn set_transparency(&mut self, transparency: f32)

Sets the transparency of the plane visualization.

pub fn plane_size(&self) -> f32

Returns the size of the plane visualization (half-extent in each direction).

pub fn set_plane_size(&mut self, size: f32)

Sets the size of the plane visualization (half-extent in each direction).

pub fn signed_distance(&self, point: Vec3) -> f32

Returns the signed distance from a point to the plane.

Positive values are on the normal side (kept), negative on the opposite (discarded).

pub fn is_kept(&self, point: Vec3) -> bool

Returns whether a point is on the kept side of the plane.

pub fn project(&self, point: Vec3) -> Vec3

Projects a point onto the plane.

pub fn to_transform(&self) -> Mat4

Computes a transform matrix for gizmo manipulation.

The plane normal becomes the local X axis, with Y and Z axes forming an orthonormal basis in the plane.

pub fn set_from_transform(&mut self, transform: Mat4)

Updates origin and normal from a transform matrix.

Extracts position from column 3 (translation), and normal from column 0 (x-axis in local space).

Trait Implementations

impl Clone for SlicePlane

fn clone(&self) -> SlicePlane

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SlicePlane

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

Formats the value using the given formatter.

impl Default for SlicePlane

fn default() -> Self

Returns the “default value” for a type.

impl From<&SlicePlane> for SlicePlaneUniforms

fn from(plane: &SlicePlane) -> Self

Converts to this type from the input type.