Struct Atom

pub struct Atom<'a> {
    pub size: Option<Vec2>,
    pub max_size: Vec2,
    pub grow: bool,
    pub shrink: bool,
    pub kind: AtomKind<'a>,
}

A low-level ui building block.

Implements From for String, str, crate::Image and much more for convenience. You can directly call the atom_* methods on anything that implements Into<Atom>.

use egui::AtomExt as _;
let string_atom = "Hello".atom_grow(true);
let image_atom = Image::new("some_image_url").atom_size(Vec2::splat(20.0));

Fields

size: Option<Vec2>

See crate::AtomExt::atom_size

max_size: Vec2

See crate::AtomExt::atom_max_size

grow: bool

See crate::AtomExt::atom_grow

shrink: bool

See crate::AtomExt::atom_shrink

kind: AtomKind<'a>

The atom type

Implementations

impl<'a> Atom<'a>

pub fn grow() -> Self

Create an empty Atom marked as grow.

This will expand in size, allowing all preceding atoms to be left-aligned, and all following atoms to be right-aligned

pub fn custom(id: Id, size: impl Into<Vec2>) -> Self

Create a AtomKind::Custom with a specific size.

pub fn into_sized( self, ui: &Ui, available_size: Vec2, wrap_mode: Option<TextWrapMode>, ) -> SizedAtom<'a>

Turn this into a SizedAtom.

Trait Implementations

impl<'a> Clone for Atom<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Atom<'a>

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

Formats the value using the given formatter.

impl Default for Atom<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> From<T> for Atom<'a>

where T: Into<AtomKind<'a>>,

fn from(value: T) -> Self

Converts to this type from the input type.