Plot refactor #331

EmbersArc · 2021-04-21T18:12:56Z

Closes #330

Co-authored-by: ilya sheprut <[email protected]>

* add curve from function * move more functionality into ScreenTransform struct

EmbersArc · 2021-04-23T15:07:15Z

Since I created some new files it's difficult to see what's changed, so here's a quick overview:

Split plot.rs into multiple files as described in Plotting library: More features and cleanup #330
Move more functionality from the plot builder into the ScreenTransform struct
Allow users to create curves based on callback functions y=f(x) and (x,y)=f(t). The points are generated here once the plot limits are known. This should be the only functional change and it would be great to get some feedback on it.

emilk

Very nice improvements and cleanups!

I left some comments, mainly:

keep the plot name so we don't need to introduce a breaking change a
keep old functions with a deprecation notice
remove Parametric type and compute its values right away

emilk · 2021-04-24T08:01:32Z

egui/src/widgets/plotting/items.rs

+        let range_union = |range1: &RangeInclusive<f64>, range2: &RangeInclusive<f64>| {
+            range1.start().max(*range2.start())..=range1.end().min(*range2.end())


This is the intersection; not the union

This would also be better as fn instead of a lambda, since it doesn't capture anything.

egui/src/widgets/plotting/items.rs

emilk · 2021-04-24T08:07:23Z

egui/src/widgets/plotting/plot.rs

 /// ```
 /// # let ui = &mut egui::Ui::__test();
-/// use egui::plot::{Curve, Plot, Value};
+/// use egui::plotting::{Curve, Plot, Value};


This rename will be a breaking change for users. I think we should just call the module plot instead to avoid this.

emilk · 2021-04-24T08:08:30Z

egui/src/widgets/plotting/plot.rs

+    pub fn include_y(mut self, y: impl Into<f64>) -> Self {
+        self.min_auto_bounds.extend_with_y(y.into());
+        self
+    }


the diff becomes harder to read when moving around code like this. what is the motivation?

emilk · 2021-04-24T08:09:31Z

egui/src/widgets/plotting/plot.rs


-    /// If true, the x-bounds will be symmetrical, so that the x=0 zero line
-    /// is always in the center.
-    pub fn symmetrical_x_bounds(mut self, symmetrical_x_bounds: bool) -> Self {


I agree that the new name (center_x_axis) is better, but keep the old function with an added #[deprecated = "Renamed center_x_axis"]

emilk · 2021-04-24T08:14:02Z

egui/src/widgets/plotting/plot.rs

-            self.bounds.min[1]..=self.bounds.max[1],
-            (self.rect.bottom() as f64)..=(self.rect.top() as f64), // negated y axis!
+        // Initialize values from functions.
+        // TODO: Let the user pick a resolution?


The from_explicit_callback and from_parametric_callback already does, so this TODO is done?

emilk · 2021-04-24T08:18:20Z

egui_demo_lib/src/apps/demo/plot_demo.rs

+            .center_x_axis(false)
+            .center_y_axis(false)


Since this is the default

Suggested change

.center_x_axis(false)

.center_y_axis(false)

emilk · 2021-04-24T08:23:08Z

egui_demo_lib/src/apps/demo/plot_demo.rs

+        let time = self.time;
+        Curve::from_explicit_callback(
+            move |x| 0.5 * (2.0 * x).sin() * time.sin(),
+            Some((-2.)..=2.),


I think it would be a good demo for sin to span -INF..=INF

emilk · 2021-04-24T08:26:25Z

egui/src/widgets/plotting/items.rs

+    /// Describes a function y = f(x) with an optional range for x and a number of points.
+    Explicit(Box<dyn Fn(f64) -> f64>, Option<RangeInclusive<f64>>, usize),
+    /// Describes a function (x,y) = f(t) with a range for t and a number of points.
+    Parametric(Box<dyn Fn(f64) -> (f64, f64)>, RangeInclusive<f64>, usize),


Suggested change

/// Describes a function y = f(x) with an optional range for x and a number of points.

Explicit(Box<dyn Fn(f64) -> f64>, Option<RangeInclusive<f64>>, usize),

/// Describes a function (x,y) = f(t) with a range for t and a number of points.

Parametric(Box<dyn Fn(f64) -> (f64, f64)>, RangeInclusive<f64>, usize),

/// Describes a function y = f(x) with a range for x and a number of points.

Explicit{

y_from_x: Box<dyn Fn(f64) -> f64>,

x_range: RangeInclusive<f64>,

resolution: usize,

},

/// Describes a function (x,y) = f(t) with a range for t and a number of points.

Parametric{

xy_from_t: Box<dyn Fn(f64) -> (f64, f64)>,

t_range: RangeInclusive<f64>,

resolution: usize

},

I see no difference between None range and an -INF..=INF range, so better to unify to the simpler type

emilk · 2021-04-24T08:30:51Z

egui/src/widgets/plotting/items.rs

+        t_range: RangeInclusive<f64>,
+        points: usize,
+    ) -> Self {
+        let generator = Generator::Parametric(Box::new(function), t_range, points);


The parametric function always computes all the points, so there is not reason to defer that computation to later as far as I can tell.

If you compute values here instead and pass to Self::from_values we get default bounds and also a speedup, because function doesn't need to be boxed (and doesn't need to be 'static either)

egui/src/widgets/plot/items.rs

EmbersArc · 2021-04-24T11:50:58Z

Thanks for the review! I agree with your suggestions and made all the changes in 2abfb0f. The remaining commits are just the filename changes.

Co-authored-by: Emil Ernerfeldt <[email protected]>

emilk · 2021-04-24T12:26:59Z

Thanks!

EmbersArc and others added 11 commits April 18, 2021 17:54

drag and zoom support for plots

ec3bda0

update doctest

a398183

use impl ToString

5022279

revert back to Into<String> until emilk#302 is solved

a245b9f

Apply suggestions from code review

bbd6d28

Co-authored-by: ilya sheprut <[email protected]>

use persistence feature for PlotMemory

1def4ca

* split plot into multiple files

01f0276

* add curve from function * move more functionality into ScreenTransform struct

changes from code review in base branch

12a45c9

let user specify a range for generated functions

d4b1094

rename file

e539c89

minor changes

23bd667

EmbersArc mentioned this pull request Apr 21, 2021

Drag and zoom support for plots #317

Merged

EmbersArc added 6 commits April 21, 2021 20:45

improve generator functionality

dbac21c

improve callback and add parametric callback

0f05375

minor changes

f0e22c5

add documentation

91688e4

Merge remote-tracking branch 'upstream/master' into plot-refactor

05deddb

fix merge issues

ae375c1

EmbersArc marked this pull request as ready for review April 23, 2021 14:59

emilk requested changes Apr 24, 2021

View reviewed changes

emilk mentioned this pull request Apr 24, 2021

Implement trackpad pinch-to-zoom for plots in egui_web #333

Merged

EmbersArc added 7 commits April 24, 2021 13:30

changes based on review

2abfb0f

rename folder

2782625

make plot.rs the mod.rs file

e121938

remove mod.rs

5cf493e

rename file

f1968cd

namespace changes

fd10935

fix doctest

12c3bbf

emilk reviewed Apr 24, 2021

View reviewed changes

egui/src/widgets/plot/items.rs Outdated Show resolved Hide resolved

Update egui/src/widgets/plot/items.rs

12ddf5a

Co-authored-by: Emil Ernerfeldt <[email protected]>

emilk approved these changes Apr 24, 2021

View reviewed changes

emilk merged commit a505d01 into emilk:master Apr 24, 2021

		let range_union = \|range1: &RangeInclusive<f64>, range2: &RangeInclusive<f64>\| {
		range1.start().max(range2.start())..=range1.end().min(range2.end())

-    /// Describes a function y = f(x) with an optional range for x and a number of points.
-    Explicit(Box<dyn Fn(f64) -> f64>, Option<RangeInclusive<f64>>, usize),
-    /// Describes a function (x,y) = f(t) with a range for t and a number of points.
-    Parametric(Box<dyn Fn(f64) -> (f64, f64)>, RangeInclusive<f64>, usize),
+    /// Describes a function y = f(x) with a range for x and a number of points.
+    Explicit{
+        y_from_x: Box<dyn Fn(f64) -> f64>,
+        x_range: RangeInclusive<f64>,
+        resolution: usize,
+    },
+    /// Describes a function (x,y) = f(t) with a range for t and a number of points.
+    Parametric{
+        xy_from_t: Box<dyn Fn(f64) -> (f64, f64)>,
+        t_range: RangeInclusive<f64>,
+        resolution: usize
+    },

Plot refactor #331

Plot refactor #331

Uh oh!

Conversation

EmbersArc commented Apr 21, 2021

Uh oh!

EmbersArc commented Apr 23, 2021

Uh oh!

emilk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

EmbersArc commented Apr 24, 2021

Uh oh!

emilk commented Apr 24, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants