Trait bevy_inspector_egui::Inspectable

pub trait Inspectable {
    type Attributes: Default + Clone;
    fn ui(
        &mut self, 
        ui: &mut Ui, 
        options: Self::Attributes, 
        context: &Context<'_>
    ) -> bool;

    fn ui_raw(&mut self, ui: &mut Ui, options: Self::Attributes) { ... }
    fn setup(app: &mut AppBuilder) { ... }
}

This trait describes how a struct should be displayed. It can be derived for structs and enums, see the crate-level docs for how to do that.

Default attributes

• ignore: hides the field in the inspector
• label: provides a label instead of using the field name
• read_only: disables the UI
• collapse: wraps the ui in an [egui::CollapsingHeader].
• default: only for enums, specifies the default value when selecting a new variant
• wrapper: wrap field UI in a custom function. Demo in the rust_types example.

Associated Types

type Attributes: Default + Clone

The Attributes associated type specifies what attributes can be passed to a field. See the following snippet for an example:

struct MyCustomType;
struct MyWidgetAttributes { a: f32, b: Option<String> }

impl Inspectable for MyCustomType {
  type Attributes = MyWidgetAttributes;

  fn ui(&mut self, _: &mut egui::Ui, options: MyWidgetAttributes, context: &Context) -> bool {
    println!("a = {}, b = {:?}", options.a, options.b);
    false
  }
}

// ...

#[derive(Inspectable)]
struct InspectorData {
  #[inspectable(a = 10.0, b = None)]
  value: MyCustomType,
}

Required methods

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

This methods is responsible for building the egui ui. Returns whether any data was modified.

Provided methods

fn ui_raw(&mut self, ui: &mut Ui, options: Self::Attributes)

Displays the value without any context. Useful for usage outside of the plugins, where there is no access to the world or EguiContext.

fn setup(app: &mut AppBuilder)

Required setup for the bevy application, e.g. registering events. Note that this method will run for every instance of a type.

Implementations on Foreign Types

impl Inspectable for Light

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for ColorMaterial

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for PrimitiveTopology

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for WindowOrigin

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for ScalingMode

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for DepthCalculation

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Cube

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Quad

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Plane

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Capsule

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for CapsuleUvProfile

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Icosphere

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Torus

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Box

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Transform

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for GlobalTransform

type Attributes = <Transform as Inspectable>::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Mat3

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Mat4

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Color

type Attributes = ColorAttributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    _: &Context<'_>
) -> bool

impl Inspectable for AmbientLight

type Attributes = <Color as Inspectable>::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for ClearColor

type Attributes = <Color as Inspectable>::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Rect

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for TextureAtlasSprite

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for TextureAtlas

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for StandardMaterial

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Mesh

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Name

type Attributes = ()

fn ui(&mut self, ui: &mut Ui, _: Self::Attributes, _: &Context<'_>) -> bool

impl Inspectable for VisibleEntities

type Attributes = ()

fn ui(&mut self, ui: &mut Ui, _: Self::Attributes, _: &Context<'_>) -> bool

impl<'a, T: Inspectable> Inspectable for Mut<'a, T>

type Attributes = T::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<T> Inspectable for Vec<T> where
    T: Inspectable + Default, 

type Attributes = <T as Inspectable>::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl<T: Inspectable, const N: usize> Inspectable for [T; N]

type Attributes = <T as Inspectable>::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl Inspectable for ()

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl<A: Inspectable + 'static> Inspectable for (A,)

type Attributes = (<A as Inspectable>::Attributes,)

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl<A: Inspectable + 'static, B: Inspectable + 'static> Inspectable for (A, B)

type Attributes = (<A as Inspectable>::Attributes, <B as Inspectable>::Attributes)

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl<A: Inspectable + 'static, B: Inspectable + 'static, C: Inspectable + 'static> Inspectable for (A, B, C)

type Attributes = (<A as Inspectable>::Attributes, <B as Inspectable>::Attributes, <C as Inspectable>::Attributes)

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl<A: Inspectable + 'static, B: Inspectable + 'static, C: Inspectable + 'static, D: Inspectable + 'static> Inspectable for (A, B, C, D)

type Attributes = (<A as Inspectable>::Attributes, <B as Inspectable>::Attributes, <C as Inspectable>::Attributes, <D as Inspectable>::Attributes)

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl Inspectable for String

type Attributes = StringAttributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    _: &Context<'_>
) -> bool

impl<'a> Inspectable for &'a str

type Attributes = ()

fn ui(&mut self, ui: &mut Ui, _: Self::Attributes, _: &Context<'_>) -> bool

impl Inspectable for bool

type Attributes = ()

fn ui(&mut self, ui: &mut Ui, _: Self::Attributes, _: &Context<'_>) -> bool

impl<T> Inspectable for RangeInclusive<T> where
    T: Inspectable + Default, 

type Attributes = T::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<T> Inspectable for Range<T> where
    T: Inspectable + Default, 

type Attributes = T::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<T: Inspectable> Inspectable for Option<T>

type Attributes = OptionAttributes<T>

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Duration

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Quat

type Attributes = QuatAttributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Display

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for FocusPolicy

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for VerticalAlign

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for HorizontalAlign

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for PositionType

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Direction

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for FlexDirection

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for FlexWrap

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for AlignItems

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for AlignSelf

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for AlignContent

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for JustifyContent

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for TextAlignment

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for TextStyle

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for TextSection

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Text

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Style

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<T: Inspectable + Reflect + PartialEq> Inspectable for Size<T>

type Attributes = T::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Val

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Vec2

type Attributes = Vec2dAttributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Vec3

type Attributes = NumberAttributes<Vec3>

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Vec4

type Attributes = NumberAttributes<Vec4>

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for HandleId

type Attributes = ()

fn ui(&mut self, ui: &mut Ui, _: Self::Attributes, _: &Context<'_>) -> bool

impl<T: Asset + Inspectable> Inspectable for Handle<T>

type Attributes = T::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Handle<Texture>

type Attributes = TextureAttributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Handle<Font>

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for World

type Attributes = WorldInspectorParams

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl Inspectable for Entity

type Attributes = EntityAttributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

Implementors

impl<'w, Q, F> Inspectable for InspectorQuery<Q, F> where
    Q: WorldQuery,
    F: WorldQuery,
    F::Fetch: FilterFetch,
    <<Q as WorldQuery>::Fetch as Fetch<'static>>::Item: Inspectable, 

type Attributes = <<<Q as WorldQuery>::Fetch as Fetch<'static>>::Item as Inspectable>::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<'w, Q, F> Inspectable for InspectorQuerySingle<Q, F> where
    Q: WorldQuery,
    F: WorldQuery,
    F::Fetch: FilterFetch,
    <<Q as WorldQuery>::Fetch as Fetch<'static>>::Item: Inspectable, 

type Attributes = <<<Q as WorldQuery>::Fetch as Fetch<'static>>::Item as Inspectable>::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<E: Component + Default> Inspectable for InspectableButton<E>

type Attributes = ButtonAttributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

fn setup(app: &mut AppBuilder)

impl<T: Inspectable + 'static> Inspectable for InNewWindow<T>

type Attributes = WindowAttributes<T>

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<T: Inspectable + Send + Sync + 'static> Inspectable for ResourceInspector<T>

type Attributes = T::Attributes

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    context: &Context<'_>
) -> bool

impl<T: Num> Inspectable for T

type Attributes = NumberAttributes<T>

fn ui(
    &mut self,
    ui: &mut Ui,
    options: Self::Attributes,
    _: &Context<'_>
) -> bool

impl<T: Reflect> Inspectable for ReflectedUI<T>

type Attributes = ()

fn ui(
    &mut self,
    ui: &mut Ui,
    _: Self::Attributes,
    context: &Context<'_>
) -> bool