Type Alias splashsurf_lib::topology::Axis

pub type Axis = CartesianAxis3d;

Abbreviated type alias for cartesian coordinate axes in 3D

Aliased Type

enum Axis {
    X,
    Y,
    Z,
}

Variants

X

The x-axis

Y

The y-axis

Z

The z-axis

Implementations

impl CartesianAxis3d

pub const fn all_possible() -> &'static [Axis; 3]

Returns a reference to an array containing all 3D cartesian axes

use crate::splashsurf_lib::topology::Axis;
assert_eq!(Axis::all_possible()[0], Axis::X);
assert_eq!(Axis::all_possible()[2], Axis::Z);
assert_eq!(Axis::all_possible().len(), 3);

pub const fn dim(self) -> usize

Converts the cartesian axis into the corresponding 3D dimension index (X=0, Y=1, Z=2)

use crate::splashsurf_lib::topology::Axis;
assert_eq!(Axis::X.dim(), 0);
assert_eq!(Axis::Y.dim(), 1);
assert_eq!(Axis::Z.dim(), 2);

pub const fn orthogonal_axes(&self) -> [Self; 2]

Returns the other two axes that are orthogonal to the current axis

use crate::splashsurf_lib::topology::Axis;
assert_eq!(Axis::X.orthogonal_axes(), [Axis::Y, Axis::Z]);

pub const fn with_direction(self, direction: Direction) -> DirectedAxis

Combines this coordinate axis with a direction into a DirectedAxis

use crate::splashsurf_lib::topology::{Axis, DirectedAxis, Direction};
assert_eq!(Axis::X.with_direction(Direction::Positive), DirectedAxis::new(Axis::X, Direction::Positive));

Trait Implementations

impl Clone for CartesianAxis3d

fn clone(&self) -> CartesianAxis3d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CartesianAxis3d

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

Formats the value using the given formatter.

impl Hash for CartesianAxis3d

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CartesianAxis3d

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<CartesianAxis3d> for CartesianAxis3d

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<CartesianAxis3d> for CartesianAxis3d

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

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

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

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

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

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

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

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

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

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

impl Copy for CartesianAxis3d

impl Eq for CartesianAxis3d

impl StructuralEq for CartesianAxis3d

impl StructuralPartialEq for CartesianAxis3d