Enum re_viewer_context :: component_ui_registry :: UiLayout Copy item path

List

Display a short summary. Used in lists.

Keep it small enough to fit on half a row (i.e. the second column of a re_ui::list_item::ListItem with re_ui::list_item::PropertyContent. Text should truncate.

Tooltip

Display as much information as possible in a compact way. Used for hovering/tooltips.

Keep it under a half-dozen lines. Text may wrap. Avoid interactive UI. When using a table, use the re_data_ui::table_for_ui_layout function.

SelectionPanelLimitHeight

Display everything as wide as available but limit height. Used in the selection panel when multiple items are selected.

When displaying lists, wrap them in a height-limited [egui::ScrollArea]. When using a table, use the re_data_ui::table_for_ui_layout function.

SelectionPanelFull

Display everything as wide as available, without height restriction. Used in the selection panel when a single item is selected.

The UI will be wrapped in a [egui::ScrollArea], so data should be fully displayed with no restriction. When using a table, use the re_data_ui::table_for_ui_layout function.

Implementations§

impl UiLayout

pub fn is_single_line(&self) -> bool

Should the UI fit on one line?

pub fn is_selection_panel(self) -> bool

Do we have a lot of vertical space?

pub fn table(self, ui: &mut Ui) -> TableBuilder<'_>

Build an egui table and configure it for the given UI layout.

Note that the caller is responsible for strictly limiting the number of displayed rows for Self::List and Self::Tooltip, as the table will not scroll.

pub fn label(self, ui: &mut Ui, text: impl Into<WidgetText>) -> Response

Show a label while respecting the given UI layout.

Important: for label only, data should use UiLayout::data_label instead.

pub fn data_label(self, ui: &mut Ui, string: impl AsRef<str>) -> Response

Show data while respecting the given UI layout.

Import: for data only, labels should use UiLayout::data_label instead.

fn data_label_impl(self, ui: &mut Ui, string: &str) -> Response

Trait Implementations§

impl Clone for UiLayout

fn clone(&self) -> UiLayout

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for UiLayout

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

Formats the value using the given formatter. Read more

impl PartialEq for UiLayout

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

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

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

impl Copy for UiLayout

impl Eq for UiLayout

impl StructuralPartialEq for UiLayout

Auto Trait Implementations§

impl UnwindSafe for UiLayout

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

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

fn __clone_box(&self, _: Private) -> *mut ()

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

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

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

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

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

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more