Struct bevy_inspector_egui::reflect::ReflectedUI

pub struct ReflectedUI<T>(_);

Wrapper type for displaying inspector UI based on the types Reflect implementation.

Say you wanted to display a type defined in another crate in the inspector, and that type implements Reflect.

#[derive(Reflect, Default)]
struct SomeComponent {
    a: f32,
    b: Vec2,
}

Using the ReflectedUI wrapper type, you can include it in your inspector and edit the fields like you would expect:

#[derive(Inspectable, Default)]
struct Data {
    component: ReflectedUI<SomeComponent>,
    // it also works for bevy's types
    timer: ReflectedUI<Timer>,
}

Implementations

impl<T> ReflectedUI<T>

pub fn new(val: T) -> Self

Trait Implementations

impl<T: Debug> Debug for ReflectedUI<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for ReflectedUI<T>

fn default() -> ReflectedUI<T>

Returns the “default value” for a type.

impl<T> Deref for ReflectedUI<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for ReflectedUI<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

type Attributes = ()

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

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

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

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 App)

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