Struct rust_3d::FilterSphere

pub struct FilterSphere { /* fields omitted */ }

FilterSphere, a sphere filter within 3D space

Implementations

impl FilterSphere

pub fn new(sphere: Sphere) -> Self

Creates a new FilterSphere with the given parameters

Trait Implementations

impl Clone for FilterSphere

fn clone(&self) -> FilterSphere

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterSphere

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

Formats the value using the given formatter.

impl Default for FilterSphere

fn default() -> FilterSphere

Returns the "default value" for a type.

impl Eq for FilterSphere

impl HasBoundingBox3D for FilterSphere

fn bounding_box(&self) -> BoundingBox3D

Should return the bounding box

impl HasBoundingBox3DMaybe for FilterSphere

fn bounding_box_maybe(&self) -> Result<BoundingBox3D>

Should return the bounding box if it can be calculated

impl Hash for FilterSphere

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Is3D for FilterSphere

fn x(&self) -> f64

Should return the x-coordinate

fn y(&self) -> f64

Should return the y-coordinate

fn z(&self) -> f64

Should return the z-coordinate

fn xyz(&self) -> [f64; 3]

Returns the position as x,y,z array

fn xy(&self) -> [f64; 2]

Returns the components of the position as array

fn xz(&self) -> [f64; 2]

Returns the components of the position as array

fn yz(&self) -> [f64; 2]

Returns the components of the position as array

fn dot(&self, other: &dyn Is3D) -> f64

Calculates the dot product with another Is3D

fn abs(&self) -> NonNegative

The absolute / length of this position

fn rad_to(&self, other: &dyn Is3D) -> Result<Rad>

Calculates the angle to the other Is3D in radians

fn to_str(&self) -> String

Transforms the position in a "x y z" string. E.g. "3.72 5.99 1.01"

impl IsBuildable3D for FilterSphere

fn new(x: f64, y: f64, z: f64) -> Self

Should build an object from x, y and z coordinates

fn from<P>(&mut self, other: &P) where
    P: Is3D, 

Should use the coordinates of another as its own

fn new_from<P>(other: &P) -> Self where
    P: Is3D, 

Uses the coordinates of other to create a new

fn multiply_m(&self, m: &Matrix4) -> Self

Applies a matrix to this

fn normalized(&self) -> Result<Self>

Returns this with normalized values

fn zero() -> Self

Returns a new object with 0/0/0 as coordinates

fn parse(text: &str) -> Result<Self>

Creates this from a "x y z" string. E.g. "32.2 14.7 1.90"

fn center<P>(&self, other: &P) -> Self where
    P: Is3D, 

Returns the center between this and other

impl IsBuildableND for FilterSphere

fn new_nd(coords: &[f64]) -> Result<Self>

Should build an object from the correct number of coordinates

fn from_nd<P>(&mut self, other: P) -> Result<()> where
    P: IsBuildableND, 

Should use the coordinates of another as its own

fn zero_nd() -> Result<Self>

Returns a new object with 0 for all coordinates

fn center_nd<P>(&self, other: &P, buffer: &mut Vec<f64>) -> Result<Self> where
    P: IsND, 

Returns the center between this and other

impl IsEditable3D for FilterSphere

fn set_x(&mut self, val: f64)

Should set the position in x

fn set_y(&mut self, val: f64)

Should set the position in y

fn set_z(&mut self, val: f64)

Should set the position in z

fn set_xyz(&mut self, x: f64, y: f64, z: f64)

Sets the position from x, y and z values

fn set_xy(&mut self, x: f64, y: f64)

Updates the position with x and y values

fn set_xz(&mut self, x: f64, z: f64)

Updates the position with x and z values

fn set_yz(&mut self, y: f64, z: f64)

Updates the position with y and z values

fn increase_distance_to_by<P>(&mut self, other: &P, factor: Positive) where
    P: Is3D, 

Increases distance towards other by factor

fn add<P>(&mut self, other: &P) where
    P: Is3D, 

Adds the coordinates of other onto this. x = x + other.x ...

fn subtract<P>(&mut self, other: &P) where
    P: Is3D, 

Subtracts the coordinates of other from this. x = x - other.x ...

fn scale_pos(&mut self, val: f64)

Scales the coordinates by applying a factor to all of them

impl IsEditableND for FilterSphere

fn set_position(&mut self, dimension: usize, val: f64) -> Result<()>

Should set the coordinate / position at dimension to val

impl<T> IsFilter<T> for FilterSphere where
    T: Is3D, 

fn is_allowed(&self, p: &T) -> bool

Should return true if a it passes the filter, otherwise false

impl IsND for FilterSphere

fn n_dimensions() -> usize

Should return the number of dimensions. E.g. 2 for points in 2D space, 3 for points in 3D space etc.

fn position_nd(&self, dimension: usize) -> Result<f64>

Should return the value of a given dimensions. E.g. for 2D position with x = 4.3, y = 1.8 the result for dimension = 1 should be 1.8

impl IsScalable for FilterSphere

fn scale(&mut self, factor: Positive)

Should scale by the given factor. 0.5 -> half size, 2.0 double the size without moving the position/center

impl Ord for FilterSphere

fn cmp(&self, other: &FilterSphere) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FilterSphere> for FilterSphere

fn eq(&self, other: &FilterSphere) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FilterSphere) -> bool

This method tests for !=.

impl PartialOrd<FilterSphere> for FilterSphere

fn partial_cmp(&self, other: &FilterSphere) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &FilterSphere) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &FilterSphere) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &FilterSphere) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &FilterSphere) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for FilterSphere

impl StructuralPartialEq for FilterSphere