Struct LocationRef

pub struct LocationRef<'a>(&'a [NormalizedCoord]);

Reference to an ordered sequence of normalized variation coordinates.

To convert from user coordinates see crate::AxisCollection::location.

This type represents a position in the variation space where each coordinate corresponds to an axis (in the same order as the fvar table) and is a normalized value in the range [-1..1].

See Coordinate Scales and Normalization for further details.

If the array is larger in length than the number of axes, extraneous values are ignored. If it is smaller, unrepresented axes are assumed to be at their default positions (i.e. 0).

A value of this type constructed with default() represents the default position for each axis.

Normalized coordinates are ignored for non-variable fonts.

Tuple Fields

0: &'a [NormalizedCoord]

Implementations

impl<'a> LocationRef<'a>

pub fn new(coords: &'a [NormalizedCoord]) -> Self

Creates a new sequence of normalized coordinates from the given array.

pub fn coords(&self) -> &'a [NormalizedCoord]

Returns the underlying array of normalized coordinates.

pub fn is_default(&self) -> bool

Returns true if this represents the default location in variation space.

This is represented a set of normalized coordinates that is either empty or contains all zeroes.

pub(crate) fn effective_coords(&self) -> &'a [NormalizedCoord]

Returns the underlying coordinate array if any of the entries are non-zero. Otherwise returns the empty slice.

This allows internal routines to bypass expensive variation code paths by just checking for an empty slice.

Trait Implementations

impl<'a> Clone for LocationRef<'a>

fn clone(&self) -> LocationRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LocationRef<'a>

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

Formats the value using the given formatter.

impl<'a> Default for LocationRef<'a>

fn default() -> LocationRef<'a>

Returns the “default value” for a type.

impl<'a> From<&'a [F2Dot14]> for LocationRef<'a>

fn from(value: &'a [NormalizedCoord]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Location> for LocationRef<'a>

fn from(value: &'a Location) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &LocationRef<'a>

type IntoIter = Iter<'a, F2Dot14>

Which kind of iterator are we turning this into?

type Item = &'a F2Dot14

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for LocationRef<'a>

type IntoIter = Iter<'a, F2Dot14>

Which kind of iterator are we turning this into?

type Item = &'a F2Dot14

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> Copy for LocationRef<'a>