Struct bevy_inspector_egui::reflect_inspector::InspectorUi

pub struct InspectorUi<'a, 'c> {
    pub type_registry: &'a TypeRegistry,
    pub context: &'a mut Context<'c>,
    pub short_circuit: ShortCircuitFn,
    pub short_circuit_readonly: ShortCircuitFnReadonly,
    pub short_circuit_many: ShortCircuitFnMany,
}

Fields

type_registry: &'a TypeRegistry

Reference to the TypeRegistry

context: &'a mut Context<'c>

Context with additional data that can be used to display values

short_circuit: ShortCircuitFn

Function which will be executed for every field recursively, which can be used to skip regular traversal. This can be used to recognize Handle<T> types and display them as their actual value instead.

short_circuit_readonly: ShortCircuitFnReadonly

Same as short_circuit, but for read only usage.

short_circuit_many: ShortCircuitFnMany

Implementations

impl<'a, 'c> InspectorUi<'a, 'c>

pub fn for_bevy(
    type_registry: &'a TypeRegistry,
    context: &'a mut Context<'c>
) -> InspectorUi<'a, 'c>

InspectorUi with short circuiting methods able to display bevy_asset Handles

impl<'a, 'c> InspectorUi<'a, 'c>

pub fn new(
    type_registry: &'a TypeRegistry,
    context: &'a mut Context<'c>,
    short_circuit: Option<ShortCircuitFn>,
    short_circuit_readonly: Option<ShortCircuitFnReadonly>,
    short_circuit_many: Option<ShortCircuitFnMany>
) -> Self

pub fn new_no_short_circuit(
    type_registry: &'a TypeRegistry,
    context: &'a mut Context<'c>
) -> Self

impl InspectorUi<'_, '_>

pub fn ui_for_reflect(&mut self, value: &mut dyn Reflect, ui: &mut Ui) -> bool

Draws the inspector UI for the given value.

pub fn ui_for_reflect_readonly(&mut self, value: &dyn Reflect, ui: &mut Ui)

Draws the inspector UI for the given value in a read-only way.

pub fn ui_for_reflect_with_options(
    &mut self,
    value: &mut dyn Reflect,
    ui: &mut Ui,
    id: Id,
    options: &dyn Any
) -> bool

Draws the inspector UI for the given value with some options.

The options can be InspectorOptions for structs or enums with nested options for their fields, or other structs like NumberOptions which are interpreted by leaf types like f32 or Vec3,

pub fn ui_for_reflect_readonly_with_options(
    &mut self,
    value: &dyn Reflect,
    ui: &mut Ui,
    id: Id,
    options: &dyn Any
)

Draws the inspector UI for the given value with some options in a read-only way.

The options can be InspectorOptions for structs or enums with nested options for their fields, or other structs like NumberOptions which are interpreted by leaf types like f32 or Vec3,

pub fn ui_for_reflect_many(
    &mut self,
    type_id: TypeId,
    name: &str,
    ui: &mut Ui,
    id: Id,
    values: &mut [&mut dyn Reflect],
    projector: &dyn Fn(&mut dyn Reflect) -> &mut dyn Reflect
) -> bool

pub fn ui_for_reflect_many_with_options(
    &mut self,
    type_id: TypeId,
    name: &str,
    ui: &mut Ui,
    id: Id,
    options: &dyn Any,
    values: &mut [&mut dyn Reflect],
    projector: &dyn Fn(&mut dyn Reflect) -> &mut dyn Reflect
) -> bool