Add a "Visualizers and Overrides" concept page #6679
Conversation
abey79
added
📖 documentation
|
|
||
| Views rely on visualizers to display each of their entities. For example, [3D views](../reference/types/views/spatial3d_view.md) use the `Points3D` visualizer to display 3D point clouds, and [time series views](../reference/types/views/time_series_view.md) use the `SeriesLine` visualizer to display time series line plots. Which visualizers are available is highly dependent on the specific kind of view. For example, the `SeriesLine` visualizer only exist for time series views—not, e.g., 3D views. | ||
|
|
||
| For a given view, visualizers are selected for each of its entities based on their content. For example, in a 3D view, an entity containing a [`Position3D`](../reference/types/components/position3d.md) results in a `Points3D` visualizer being selected by default. (We will see that the visualizer selection process can be influenced by both the user interface and the blueprints.) |
There was a problem hiding this comment.
This is slightly incorrect.
If an entity contains Position3D component it is compatible with the Points3D visualizer. To be compatible with Visualizer, an entity must have all of the required components.
The thing that makes it selected by default is the Points3DIndicator component that is also logged when you use the Points3D archetype.
If you just log Position3DBatch without the Points3D archetype, then you will have to instantiate the visualizer manually.
There was a problem hiding this comment.
Thanks. I wasn't sure if we had this strong indicator<->visualiser relationship in place already.
Deployed docs
|
|
Fantastic article. I learned a few things 😄 |
Co-authored-by: Clement Rey <cr.rey.clement@gmail.com>
Co-authored-by: Clement Rey <cr.rey.clement@gmail.com>
|
Wondering if it might be helpful for users to remind them where the data came from: |
| This is determined by the [entity query](../reference/entity-queries.md), which is part of the view blueprint. | ||
| The query is run against the data store to generate the list of view entities. | ||
|
|
||
| Views rely on visualizers to display each of their entities. For example, [3D views](../reference/types/views/spatial3d_view.md) use the `Points3D` visualizer to display 3D point clouds, and [time series views](../reference/types/views/time_series_view.md) use the `SeriesLine` visualizer to display time series line plots. Which visualizers are available is highly dependent on the specific kind of view. For example, the `SeriesLine` visualizer only exist for time series views—not, e.g., 3D views. |
There was a problem hiding this comment.
| Views rely on visualizers to display each of their entities. For example, [3D views](../reference/types/views/spatial3d_view.md) use the `Points3D` visualizer to display 3D point clouds, and [time series views](../reference/types/views/time_series_view.md) use the `SeriesLine` visualizer to display time series line plots. Which visualizers are available is highly dependent on the specific kind of view. For example, the `SeriesLine` visualizer only exist for time series views—not, e.g., 3D views. | |
| Views rely on visualizers to display each of their entities. For example, [3D views](../reference/types/views/spatial3d_view.md) use the `Points3D` visualizer to display 3D point clouds, and [time series views](../reference/types/views/time_series_view.md) use the `SeriesLine` visualizer to display time series line plots. Which visualizers are available is highly dependent on the specific kind of view. For example, the `SeriesLine` visualizer only exist for time series views — not, e.g., for 3D views. |
There was a problem hiding this comment.
This is actually a em-dash (not visible with monospace font) and I exploit the lack of style guide to decide that we dont use spaces around it :) A cursory look indicates that I'm mostly the only one to actually use them, so I'm not infringing on some untold consistency rule 😅
Here is how it looks IRL (I'm taking that "for" in):
There was a problem hiding this comment.
Background: https://www.merriam-webster.com/grammar/em-dash-en-dash-how-to-use (last paragraph covers spacing)
|
tiny issue with the color example: the fact that white shows as the fallback is a bug actually. It should show a entity path hash based fallback. I'm a about to fix that |
I'm gonna decide that this is an acceptable glitch for now :) |
What
This is a first iteration on the visualisers and override doc update. This PR introduces a "concepts" page that happens to also include many snippets and screenshot.
TODO:
Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerTo run all checks from
main, comment on the PR with@rerun-bot full-check.