Axis

Struct Axis 

Source
pub struct Axis {
    pub name: String,
    pub tag: Tag,
    pub min: UserCoord,
    pub default: UserCoord,
    pub max: UserCoord,
    pub hidden: bool,
    pub converter: CoordConverter,
    pub localized_names: HashMap<String, String>,
}
Expand description

A variable font axis.

Fields§

§name: String

A human-readable name, like ‘Weight’.

§tag: Tag

The axis tag, like ‘wght’.

§min: UserCoord

The minimum value for this axis, in UserSpace.

§default: UserCoord

The default value for this axis, in UserSpace.

§max: UserCoord

The max value for this axis, in UserSpace.

§hidden: bool§converter: CoordConverter§localized_names: HashMap<String, String>

Localized names for the axis, e.g. {"en": "Weight"}

Implementations§

Source§

impl Axis

Source

pub fn is_point(&self) -> bool

Source

pub fn default_converter(&self) -> CoordConverter

Initialize a CoordConverter for the default normalization from this axis user space.

Source

pub fn ui_label_name(&self) -> &str

Display name for the axis.

Some frontends (e.g. designspace) support the notion of an axis’ UI label name distinct from the axis name; the former is used for displaying the axis in UI and can be localised, whereas the latter is only used for internal cross-references. In Designspace documents, these are stored in the axes’ <labelname> elements. FontTools uses these to build the name records associated with axis names referenced by fvar and STAT tables, or else falls back to the axis.name. But even when the labelnames are ommited, there’s a special group of registered axis names that were common in old MutatorMath source files before the <labelname> element itself got standardised, which continue to receive a special treatment in fonttools: i.e., the lowercase, shortened name gets replaced with a title-case, expanded one (e.g. ‘weight’ => ‘Weight’, ‘optical’ => ‘Optical Size’ etc.). For the sake of matching fontmake (which uses fonttools), we do the same here.

For additional info see: https://github.com/googlefonts/fontc/issues/1020

Trait Implementations§

Source§

impl Clone for Axis

Source§

fn clone(&self) -> Axis

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Axis

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl FromIterator<Axis> for Axes

Source§

fn from_iter<T: IntoIterator<Item = Axis>>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl PartialEq for Axis

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Axis

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Axis

Source§

impl StructuralPartialEq for Axis

Auto Trait Implementations§

§

impl Freeze for Axis

§

impl RefUnwindSafe for Axis

§

impl Send for Axis

§

impl Sync for Axis

§

impl Unpin for Axis

§

impl UnwindSafe for Axis

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,