pub struct PlotOverlay { /* private fields */ }Expand description
GUI overlay manager for plot annotations and controls
Implementations§
Source§impl PlotOverlay
impl PlotOverlay
pub fn set_theme_config(&mut self, theme: PlotThemeConfig)
pub fn compute_subplot_plot_rects( &self, outer: Rect, plot_renderer: &PlotRenderer, font_scale: f32, ) -> Vec<Rect>
Sourcepub fn compute_subplot_plot_rects_explicit(
&self,
outer: Rect,
plot_renderer: &PlotRenderer,
font_scale: f32,
show_title: bool,
) -> Vec<Rect>
pub fn compute_subplot_plot_rects_explicit( &self, outer: Rect, plot_renderer: &PlotRenderer, font_scale: f32, show_title: bool, ) -> Vec<Rect>
Like [compute_subplot_plot_rects] but lets the caller control whether the
super-title band is reserved. Pass show_title: false when the overlay is
rendered without titles so that GPU viewports and hit-rects stay aligned.
pub fn snap_rect_to_pixels(rect: Rect, pixels_per_point: f32) -> Rect
pub fn compute_subplot_plot_rects_snapped( &self, outer: Rect, plot_renderer: &PlotRenderer, font_scale: f32, pixels_per_point: f32, ) -> Vec<Rect>
Sourcepub fn compute_subplot_plot_rects_snapped_explicit(
&self,
outer: Rect,
plot_renderer: &PlotRenderer,
font_scale: f32,
pixels_per_point: f32,
show_title: bool,
) -> Vec<Rect>
pub fn compute_subplot_plot_rects_snapped_explicit( &self, outer: Rect, plot_renderer: &PlotRenderer, font_scale: f32, pixels_per_point: f32, show_title: bool, ) -> Vec<Rect>
Like [compute_subplot_plot_rects_snapped] but lets the caller control whether
the super-title band is reserved. Pass show_title: false when the overlay is
rendered without titles so that GPU viewports stay aligned with the drawn area.
pub fn outer_plot_area_for_axes( available_rect: Rect, plot_renderer: &PlotRenderer, ) -> Rect
Sourcepub fn apply_theme(&self, ctx: &Context)
pub fn apply_theme(&self, ctx: &Context)
Apply theme to egui context
Sourcepub fn render(
&mut self,
ctx: &Context,
plot_renderer: &PlotRenderer,
config: &OverlayConfig,
metrics: OverlayMetrics,
) -> FrameInfo
pub fn render( &mut self, ctx: &Context, plot_renderer: &PlotRenderer, config: &OverlayConfig, metrics: OverlayMetrics, ) -> FrameInfo
Render the complete overlay UI
Sourcepub fn compute_subplot_rects(
&self,
outer: Rect,
rows: usize,
cols: usize,
hgap: f32,
vgap: f32,
) -> Vec<Rect>
pub fn compute_subplot_rects( &self, outer: Rect, rows: usize, cols: usize, hgap: f32, vgap: f32, ) -> Vec<Rect>
Compute subplot rectangles within a given plot area for a rows x cols grid (row-major)
Sourcepub fn axes_plot_rects(&self) -> &[Rect]
pub fn axes_plot_rects(&self) -> &[Rect]
Get per-axes snapped content rectangles from the last frame.
Sourcepub fn toolbar_rect(&self) -> Option<Rect>
pub fn toolbar_rect(&self) -> Option<Rect>
Get toolbar rectangle from last frame
Get sidebar rectangle from last frame
pub fn take_toolbar_actions( &mut self, ) -> (bool, bool, bool, Option<bool>, Option<bool>)
Trait Implementations§
Auto Trait Implementations§
impl Freeze for PlotOverlay
impl RefUnwindSafe for PlotOverlay
impl Send for PlotOverlay
impl Sync for PlotOverlay
impl Unpin for PlotOverlay
impl UnsafeUnpin for PlotOverlay
impl UnwindSafe for PlotOverlay
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
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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>
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>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().