Struct mercator_db::space::Axis

pub struct Axis { /* fields omitted */ }

Definition of an axis of a base.

This links together valid values on this axis, as well as the direction in the Universe of the axis and the base length unit of the 1.0 value.

Methods

impl Axis

pub fn new(
    unit: &str,
    unit_vector: Vec<f64>,
    set: NumberSet,
    minimum: f64,
    maximum: f64,
    steps: u64
) -> Result<Self, String>

Instanciate a new Axis definition.

Parameters

• unit: SI Unit to use on this axis for the 1.0 value. See measurement_unit.

• unit_vector: A vector providing the direction in the Universe space of this axis.

• set: The valid numbers on this axis.

• minimum: The minimum value described by this axis included.

• maximum: The maximum value described by this axis included.

• steps: The number of steps, or discrete ticks on this axis.

pub fn measurement_unit(&self) -> &str

The unit, as in SI unit used on this axis, more specifically, a metric prefix of the meter.

Currently the following values are supported:

• m
• dm
• cm
• mm
• um
• nm
• pm

pub fn unit_vector(&self) -> &Position

The unit vector of the axis.

This vector is expressed in the Universe coordinate system.

pub fn graduation(&self) -> &Graduation

The valid number range and properties on this axis.

pub fn project_in(&self, position: &Position) -> Result<Coordinate, String>

Project a position on this axis.

The resulting coordinate is expressed as an encoded coordinate on this axis.

Parameters

• position: The position to project on this axis. It must be defined in Universe coordinates, but with any translations already applied so that the origin of the vector is the origin of this axis.

pub fn project_out(&self, coordinate: &Coordinate) -> Result<Position, String>

Convert an encoded coordinate expressed on this axis into a position.

The resulting position is expressed in the Universe reference space, but from the origin of this axis. Any required translation must be applied to this resulting position to obtain an absolute value in the Universe space.

Parameters

• coordinate: The coordinate to project out of this axis. It must be defined as an encoded coordinate on this axis.

pub fn encode(&self, val: f64) -> Result<Coordinate, String>

Encode a coordinate expressed on this axis.

Parameters

• val: The coordinate to encode. It must be defined as a coordinate on this axis.

pub fn decode(&self, val: &Coordinate) -> Result<f64, String>

Decode a coordinate expressed on this axis.

Parameters

• val: The coordinate to decode. It must be defined as an encoded coordinate on this axis.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Axis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Axis

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'_> From<&'_ Axis> for Axis

fn from(axis: &Axis) -> Self

Performs the conversion.

impl From<Axis> for Axis

fn from(axis: Axis) -> Self

Performs the conversion.

impl PartialEq<Axis> for Axis

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

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

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

This method tests for !=.

impl Serialize for Axis

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Axis