Struct mercator_db::space::Space

pub struct Space { /* fields omitted */ }

A reference space, defined by its name and coordinate system.

Methods

impl Space

pub fn new<S>(name: S, system: CoordinateSystem) -> Self where
    S: Into<String>, 

Instantiate a new space.

Parameters

• name: Id of the reference space.

• system: Coordinate system defintion of the reference space

pub fn universe() -> &'static Self

Returns the Universe Space.

This space contains all of the spaces, and allows us to connect them between each others.

pub fn change_base(
    position: &Position,
    from: &Space,
    to: &Space
) -> Result<Position, String>

Transform a position from space from into a position in space to.

Parameters

• position: Position to transform, expressed as encoded coordinates.

• from: Space in which position is defined.

• to: Target space in which position should be expressed.

pub fn name(&self) -> &String

Id of the reference space.

pub fn origin(&self) -> &Position

Origin of the space, expressed in Universe.

pub fn axes(&self) -> &Vec<Axis>

Axes definition of the space.

pub fn bounding_box(&self) -> (Position, Position)

Returns the bounding box enclosing the whole space.

pub fn volume(&self) -> f64

Total volume of the reference space.

pub fn decode(&self, position: &Position) -> Result<Vec<f64>, String>

Decode coordinates expressed in the current space, to their values within the axes definitions.

Parameters

• position: expressed in encoded coordinates within the current space.

Return value

The decoded position within the space.

pub fn encode(&self, position: &[f64]) -> Result<Position, String>

Encode a position expressed in the current space within the axes value ranges.

Parameters

• position: expressed in the current space.

Return value

The encoded coordinates within the space.

Trait Implementations

impl Clone for Space

fn clone(&self) -> Space

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Space

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Space

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

Deserialize this value from the given Serde deserializer.

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

fn from(space: &Space) -> Self

Performs the conversion.

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

fn from(space: &Space) -> Self

Performs the conversion.

impl PartialEq<Space> for Space

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

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

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

This method tests for !=.

impl Record<String> for Space

fn key(&self) -> String

Extract the key from the record.

impl Serialize for Space

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 Space