Trait bevy_inspector_egui::Inspectable

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

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.

Associated Types

type Attributes: Default

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) {
    println!("a = {}, b = {:?}", options.a, options.b);
  }
}

// ...

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

Loading content...

Required methods

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

This methods is responsible for building the egui ui.

Loading content...

Implementations on Foreign Types

impl Inspectable for Quat

type Attributes = NumberAttributes<[f32; 4]>

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

impl Inspectable for Transform

type Attributes = ()

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

impl Inspectable for Mat3

type Attributes = ()

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

impl Inspectable for Mat4

type Attributes = ()

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

impl Inspectable for Color

type Attributes = ColorAttributes

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

impl Inspectable for StandardMaterial

type Attributes = ()

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

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

type Attributes = <T as Inspectable>::Attributes

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

impl Inspectable for f32

type Attributes = NumberAttributes<f32>

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

impl Inspectable for f64

type Attributes = NumberAttributes<f64>

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

impl Inspectable for u8

type Attributes = NumberAttributes<u8>

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

impl Inspectable for i32

type Attributes = NumberAttributes<i32>

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

impl Inspectable for u16

type Attributes = NumberAttributes<u16>

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

impl Inspectable for u32

type Attributes = NumberAttributes<u32>

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

impl Inspectable for u64

type Attributes = NumberAttributes<u64>

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

impl Inspectable for i8

type Attributes = NumberAttributes<i8>

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

impl Inspectable for i16

type Attributes = NumberAttributes<i16>

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

impl Inspectable for i64

type Attributes = NumberAttributes<i64>

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

impl Inspectable for String

type Attributes = StringAttributes

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

impl Inspectable for bool

type Attributes = ()

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

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

type Attributes = T::Attributes

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

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

type Attributes = T::Attributes

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

impl Inspectable for Vec2

type Attributes = Vec2dAttributes

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

impl Inspectable for Vec3

type Attributes = NumberAttributes<Vec3>

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

impl Inspectable for Vec4

type Attributes = NumberAttributes<Vec4>

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

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

type Attributes = T::Attributes

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

Loading content...

Implementors

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

type Attributes = ()

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

Loading content...