Skip to content

Commit

Permalink
Update migration guide and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
abey79 committed Jul 5, 2024
1 parent 83b3dc0 commit abf52ec
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Migration guide: http://rerun.io/docs/reference/migration/migration-0-17

### ✨ Overview & highlights

* 🟦 Blueprint component override & defaults
* *Defaults*: Configure default component value for an entire view, used when no values are logged to the data store (using `rr.log()`).
* *Override*: Specify a value to use regardless of the data-store & default values and use specified value instead. Can be set per view per entity.
* Both are available from UI and (Python) blueprint code.
* When a view entity is selected, the selection panel now shows all active visualizers, what components they use, and where they come from.
* Everything that was editable per Entity in a View uses component overrides now (e.g. camera plane distance, transform axis lengths etc.)
* 🟦 Blueprint component override & defaults, and visualizer override for all views
* *Component defaults*: Configure default component value for an entire view, used when no values are logged to the data store (using `rr.log()`).
* *Component overrides*: Specify a value to use regardless of the data-store & default values and use specified value instead. Can be set per view per entity.
* *Visualizer overrides*: Specify a visualizer to use for a given entity in a given view. Previously only available for scalar data in timeseries views, now available for all view kinds.
* All three are available from the (fully revamped) UI _and_ the Python blueprint APIs.
* Everything that was editable per entity in a view now uses component overrides (e.g. camera plane distance, transform axis lengths, etc.)
* Tip: Tooltips for each component in the UI include a link to the docs now!
* 🕸️ Improved notebook & website embedding support
* Now you can stream data from the notebook cell to the embedded viewer.
Expand Down
62 changes: 62 additions & 0 deletions docs/content/reference/migration/migration-0-17.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,68 @@ order: 170
---


## New integrated visualizer and component override UI

The visualizer and component override UI of the timeseries views has been unified and overhauled. It is also now used for all view kinds (it was previously only available for timeseries views).

In 0.16.1 and earlier:

<picture style="zoom: 0.5">
<img src="https://static.rerun.io/vizcomp-ui-before/ec7c0b88cdb54420665de32aaf2096dfd3dc05ea/full.png" alt="">
<source media="(max-width: 480px)" srcset="https://static.rerun.io/vizcomp-ui-before/ec7c0b88cdb54420665de32aaf2096dfd3dc05ea/480w.png">
</picture>

In 0.17.0:

<picture style="zoom: 0.5">
<img src="https://static.rerun.io/vizcomp-ui-after/86f74d239e8b77bc3df00e61cfc35eb9f4c07989/full.png" alt="">
<source media="(max-width: 480px)" srcset="https://static.rerun.io/vizcomp-ui-after/86f74d239e8b77bc3df00e61cfc35eb9f4c07989/480w.png">
</picture>

See [Visualizers and Overrides](../../concepts/visualizers-and-overrides.md) for more information.


## New blueprint API to specify component overrides, visualizer overrides, and component defaults

This release introduces new Python APIs to set component overrides, visualizer overrides, and component defaults from code. Depending on your use-case, these new APIs become the preferred way of styling views.

For example, setting color and enabling the `SeriesPoint` visualizer was previously done using `rr.log()`:

```python
rr.log("data", rr.SeriesPoint(color=[255, 255, 0]), static=True)

for t in range(1000):
rr.set_time_sequence("frame_nr", t)
rr.log("data",rr.Scalar(get_data(t))),

rr.send_blueprint(
rr.blueprint.TimeSeriesView(origin="data")
)
```

Now the override can be specified from the blueprint, removing the need to include styling information in the data store:

```python
for t in range(1000):
rr.set_time_sequence("frame_nr", t)
rr.log("data",rr.Scalar(get_data(t))),

rr.send_blueprint(
rr.blueprint.TimeSeriesView(
origin="data",
overrides={
"data": [
rr.blueprint.VisualizerOverrides("SeriesPoint"),
rr.components.Color([255, 255, 0])
]
},
)
)
```

The [Plots](https://rerun.io/examples/feature-showcase/plots) example has been updated to showcase the new APIs. See [Visualizers and Overrides](../../concepts/visualizers-and-overrides.md) for more information.


## New and changed components

* New [`ImagePlaneDistance`](https://rerun.io/docs/reference/types/components/image_plane_distance) to allow configuring the size of the Pinhole frustum visualization.
Expand Down

0 comments on commit abf52ec

Please sign in to comment.