Struct iced_audio::native::tick_marks::Group

pub struct Group { /* fields omitted */ }

A group of tick marks.

tick mark: struct.TickMark.html

Implementations

impl Group

pub fn from_normalized(tick_marks: &[(Normal, Tier)]) -> Self

Constructs a new Group from an array of normalized values and tiers.

pub fn center(tier: Tier) -> Self

Returns a new Group with a single tick mark in the center position.

• tier - a Tier representing the size of the tick mark

pub fn min_max(tier: Tier) -> Self

Returns a new Group with a tick mark in the min (0.0) position and max (1.0) position.

• tier - a Tier representing the size of the tick mark

pub fn min_max_and_center(min_max_tier: Tier, center_tier: Tier) -> Self

Returns a new Group with a tick mark in the min (0.0), the max (1.0), and center (0.5) positions.

• min_max_tier - a Tier representing the size of the min and max tick marks
• center_tier - a Tier representing the size of the center tick mark

pub fn subdivided(
    one: usize,
    two: usize,
    three: usize,
    sides: Option<Tier>
) -> Self

Creates a group of tick marks by subdividing the range.

• one - The number of tier 1 tick marks. For example, 1 will put a single tier 1 tick mark at the 0.5 (center) position. 3 will put three tick marks at 0.25, 0.5, 0.75. For no tier 1 tick marks, put 0.
• two - The number of tier 2 tick marks in each range between tier 1 tick marks. If there are no tier 1 tick marks, then it will behave the same as tier 1 tick marks.
• three - The number of tier 3 tick marks in each range between tier 2 tick marks. If there are no tier 2 tick marks, then it will behave the same as tier 2 tick marks.
• sides - The tier of tick marks to put on the two sides (0.0 and 1.0). For no tick marks on the sides, put None.

pub fn evenly_spaced(len: usize, tier: Tier) -> Self

Creates a Group of evenly spaced tick marks

• len - the number of tick marks
• tier - the Tier of the tick marks

pub fn tier_1(&self) -> Option<&Vec<Normal>>

Returns the positions of the tier 1 tick marks. Returns None if there are no tier 1 tick marks.

pub fn tier_2(&self) -> Option<&Vec<Normal>>

Returns the positions of the tier 2 tick marks. Returns None if there are no tier 2 tick marks.

pub fn tier_3(&self) -> Option<&Vec<Normal>>

Returns the positions of the tier 3 tick marks. Returns None if there are no tier 3 tick marks.

pub fn len(&self) -> usize

Returns the total number of tick marks.

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl Default for Group

fn default() -> Self

Returns the “default value” for a type.

impl From<&'_ [(Normal, Tier)]> for Group

fn from(slice: &[(Normal, Tier)]) -> Self

Performs the conversion.

impl From<Vec<(Normal, Tier), Global>> for Group

fn from(vec: Vec<(Normal, Tier)>) -> Self

Performs the conversion.