pub struct EguiEditorShell { /* private fields */ }Expand description
Egui-backed editor shell using native SidePanel, TopBottomPanel, and
CentralPanel for the dock layout.
Implementations§
Source§impl EguiEditorShell
impl EguiEditorShell
Sourcepub fn new(ctx: Context, theme: UiTheme) -> Self
pub fn new(ctx: Context, theme: UiTheme) -> Self
Creates a new shell using the given egui context (shared with EguiOverlay).
Sourcepub fn register_viewport_texture(
&mut self,
handle: ViewportTextureHandle,
egui_id: TextureId,
)
pub fn register_viewport_texture( &mut self, handle: ViewportTextureHandle, egui_id: TextureId, )
Registers an abstract viewport handle → egui texture ID mapping.
Called by the render system after overlay.register_viewport_texture().
Sourcepub fn resolve_viewport_texture(
&self,
handle: ViewportTextureHandle,
) -> Option<TextureId>
pub fn resolve_viewport_texture( &self, handle: ViewportTextureHandle, ) -> Option<TextureId>
Returns the egui texture ID for a given viewport handle, if registered.
Sourcepub fn last_status(&self) -> &StatusBarData
pub fn last_status(&self) -> &StatusBarData
Returns the most recent [StatusBarData] passed via [set_status].
Editor-side status-bar panels read this through their own state, but
debug shells / tests can introspect it here.
Trait Implementations§
Source§impl EditorShell for EguiEditorShell
impl EditorShell for EguiEditorShell
Source§fn register_panel(
&mut self,
location: PanelLocation,
panel: Box<dyn EditorPanel>,
)
fn register_panel( &mut self, location: PanelLocation, panel: Box<dyn EditorPanel>, )
Registers a panel at the given dock location.
Source§fn remove_panel(&mut self, id: &str) -> bool
fn remove_panel(&mut self, id: &str) -> bool
Removes a panel by id. Returns
true if it was found.Source§fn set_fonts(&mut self, fonts: FontPack)
fn set_fonts(&mut self, fonts: FontPack)
Installs a custom font pack. If [
FontPack::is_empty] is true, the
backend keeps its built-in defaults. Default no-op so backends that
don’t support custom fonts compile without changes.Source§fn set_status(&mut self, data: StatusBarData)
fn set_status(&mut self, data: StatusBarData)
Updates the status bar data shared with panels. Read more
Source§fn set_editor_state(&mut self, state: Arc<Mutex<EditorState>>)
fn set_editor_state(&mut self, state: Arc<Mutex<EditorState>>)
Sets a shared [
EditorState] reference. Panels typically grab this
at construction; this method exists for shells that want to surface
state to internal helpers (debug overlays, etc.).Source§fn show_frame(&mut self)
fn show_frame(&mut self)
Renders the full editor frame. Read more
Auto Trait Implementations§
impl Freeze for EguiEditorShell
impl !RefUnwindSafe for EguiEditorShell
impl Send for EguiEditorShell
impl Sync for EguiEditorShell
impl Unpin for EguiEditorShell
impl UnsafeUnpin for EguiEditorShell
impl !UnwindSafe for EguiEditorShell
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn 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>
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)
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)
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> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSend for T
impl<T> DowncastSend for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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§impl<T> Pointable for T
impl<T> Pointable for T
§impl<F, T, S> SimdInto<T, S> for Fwhere
T: SimdFrom<F, S>,
S: Simd,
impl<F, T, S> SimdInto<T, S> for Fwhere
T: SimdFrom<F, S>,
S: Simd,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.