Struct ScrollAxes

pub struct ScrollAxes {
    pub horizontal: bool,
    pub vertical: bool,
}

Scrollable axes for a viewport.

Examples

use ailloli_ui_core::ScrollAxes;

assert!(ScrollAxes::VERTICAL.vertical);
assert!(!ScrollAxes::VERTICAL.horizontal);

Fields

horizontal: bool

true permits horizontal offset and wheel deltas; false forces zero.

vertical: bool

true permits vertical offset and wheel deltas; false forces zero.

Implementations

impl ScrollAxes

pub const NONE: Self

Disables scrolling on both axes.

Examples

use ailloli_ui_core::ScrollAxes;
assert_eq!(ScrollAxes::NONE, ScrollAxes { horizontal: false, vertical: false });

pub const HORIZONTAL: Self

Enables horizontal scrolling only.

Examples

use ailloli_ui_core::ScrollAxes;
assert!(ScrollAxes::HORIZONTAL.horizontal);

pub const VERTICAL: Self

Enables vertical scrolling only.

Examples

use ailloli_ui_core::ScrollAxes;
assert!(ScrollAxes::VERTICAL.vertical);

pub const BOTH: Self

Enables scrolling on both axes.

Examples

use ailloli_ui_core::ScrollAxes;
assert!(ScrollAxes::BOTH.horizontal && ScrollAxes::BOTH.vertical);

pub fn horizontal() -> Self

Returns Self::HORIZONTAL.

Examples

use ailloli_ui_core::ScrollAxes;
assert_eq!(ScrollAxes::horizontal(), ScrollAxes::HORIZONTAL);

pub fn vertical() -> Self

Returns Self::VERTICAL.

Examples

use ailloli_ui_core::ScrollAxes;
assert_eq!(ScrollAxes::vertical(), ScrollAxes::VERTICAL);

pub fn both() -> Self

Returns Self::BOTH.

Examples

use ailloli_ui_core::ScrollAxes;
assert_eq!(ScrollAxes::both(), ScrollAxes::BOTH);

pub fn filter_offset(self, offset: Offset) -> Offset

Preserves enabled components and replaces disabled components with zero.

Examples

use ailloli_ui_core::{Offset, ScrollAxes};
assert_eq!(ScrollAxes::VERTICAL.filter_offset(Offset::new(3.0, 4.0)), Offset::new(0.0, 4.0));

Trait Implementations

impl Clone for ScrollAxes

fn clone(&self) -> ScrollAxes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollAxes

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

Formats the value using the given formatter.

impl PartialEq for ScrollAxes

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ScrollAxes

impl Eq for ScrollAxes

impl StructuralPartialEq for ScrollAxes