Enum bvh::axis::Axis

source ·
pub enum Axis {
    X,
    Y,
    Z,
}
Expand description

An Axis in a three-dimensional coordinate system. Used to access Vector3/Point3 structs via index.

Examples

use bvh::axis::Axis;

let mut position = [1.0, 0.5, 42.0];
position[Axis::Y] *= 4.0;

assert_eq!(position[Axis::Y], 2.0);

nalgebra structures are also indexable using Axis. For reference see [the documentation] (http://nalgebra.org/doc/nalgebra/struct.Vector3.html#method.index).

extern crate bvh;
extern crate nalgebra;

use bvh::axis::Axis;
use nalgebra::Point3;

let mut position: Point3<f32> = Point3::new(1.0, 2.0, 3.0);
position[Axis::X] = 1000.0;

assert_eq!(position[Axis::X], 1000.0);

Variants

X

Index of the X axis.

Y

Index of the Y axis.

Z

Index of the Z axis.

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more

Display implementation for Axis.

Formats the value using the given formatter. Read more

Make slices indexable by Axis.

The returned type after indexing.
Performs the indexing (container[index]) operation. Read more

Make Point3 indexable by Axis.

The returned type after indexing.
Performs the indexing (container[index]) operation. Read more

Make slices mutably accessible by Axis.

Performs the mutable indexing (container[index]) operation. Read more

Make Point3 mutably accessible by Axis.

Performs the mutable indexing (container[index]) operation. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
Tests if Self the same as the type T Read more
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.