Skip to main content

Dimension

step_io::scene::pmi

Struct Dimension

pub struct Dimension<'m> { /* private fields */ }

Expand description

A dimension (DIMENSIONAL_SIZE / _LOCATION / ANGULAR_SIZE / ANGULAR_LOCATION) — its kind, name, and nominal value.

Implementations§

impl<'m> Dimension<'m>

pub fn kind(&self) -> DimensionKind

What this dimension measures.

pub fn name(&self) -> &'m str

The dimension’s name.

pub fn key(&self) -> EntityKey

This dimension’s global identity (a Copy key for maps / deduplication).

pub fn value(&self) -> Option<f64>

The nominal value (reverse: a DIMENSIONAL_CHARACTERISTIC_REPRESENTATION referencing this dimension → its SHAPE_DIMENSION_REPRESENTATION’s first MEASURE_REPRESENTATION_ITEM).

The number is raw: interpret its unit via kind (Size/Location are lengths, Angular* are angles) and Scene::units, exactly as point coordinates are read. A representation the walk cannot resolve (a complex one) is reported via Scene::warnings; a dimension with no value representation simply yields None.

impl<'m> Dimension<'m>

pub fn features(&self) -> Vec<Feature<'m>>

The shape feature(s) this dimension applies to. A size (DIMENSIONAL_SIZE / ANGULAR_SIZE) yields the one feature it measures; a location (DIMENSIONAL_LOCATION / ANGULAR_LOCATION) yields the two it spans, in [relating, related] order.

Trait Implementations§

impl<'m> Clone for Dimension<'m>

fn clone(&self) -> Dimension<'m>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<'m> Copy for Dimension<'m>

Auto Trait Implementations§

impl<'m> Freeze for Dimension<'m>

impl<'m> RefUnwindSafe for Dimension<'m>

impl<'m> Send for Dimension<'m>

impl<'m> Sync for Dimension<'m>

impl<'m> Unpin for Dimension<'m>

impl<'m> UnsafeUnpin for Dimension<'m>

impl<'m> UnwindSafe for Dimension<'m>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.