chore: import upstream snapshot with attribution
This commit is contained in:
wehub-resource-sync
@@ -0,0 +1,76 @@
|
||||
<!--[metadata]
|
||||
title = "Clock"
|
||||
tags = ["3D", "API example"]
|
||||
thumbnail = "https://static.rerun.io/clock/8c49e25f5cac4d6a1d7d0490b14cf6881bdb707b/480w.png"
|
||||
thumbnail_dimensions = [480, 480]
|
||||
-->
|
||||
|
||||
|
||||
<picture>
|
||||
<source media="(max-width: 480px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/480w.png">
|
||||
<source media="(max-width: 768px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/768w.png">
|
||||
<source media="(max-width: 1024px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/1024w.png">
|
||||
<source media="(max-width: 1200px)" srcset="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/1200w.png">
|
||||
<img src="https://static.rerun.io/clock/05e69dc20c9a28005f1ffe7f0f2ac9eeaa95ba3b/full.png" alt="Clock example screenshot">
|
||||
</picture>
|
||||
|
||||
An example visualizing an analog clock with hour, minute and seconds hands using Rerun Arrow3D primitives.
|
||||
|
||||
## Used Rerun types
|
||||
|
||||
[`Boxes3D`](https://www.rerun.io/docs/reference/types/archetypes/boxes3d), [`Points3D`](https://www.rerun.io/docs/reference/types/archetypes/points3d), [`Arrows3D`](https://www.rerun.io/docs/reference/types/archetypes/arrows3d)
|
||||
|
||||
## Logging and visualizing with Rerun
|
||||
|
||||
The visualizations in this example were created with the following Rerun code:
|
||||
|
||||
The clock's frame is logged as a 3D box using [`Boxes3D`](https://www.rerun.io/docs/reference/types/archetypes/boxes3d) archetype.
|
||||
```python
|
||||
rr.log(
|
||||
"world/frame",
|
||||
rr.Boxes3D(half_sizes=[LENGTH_S, LENGTH_S, 1.0], centers=[0.0, 0.0, 0.0]),
|
||||
static=True,
|
||||
)
|
||||
```
|
||||
|
||||
Then, the positions and colors of points and arrows representing the hands of a clock for seconds, minutes, and hours are logged in each simulation time.
|
||||
It first sets the simulation time using [`timelines`](https://www.rerun.io/docs/concepts/logging-and-ingestion/timelines), calculates the data for each hand, and logs it using [`Points3D`](https://www.rerun.io/docs/reference/types/archetypes/points3d) and [`Arrows3D`](https://www.rerun.io/docs/reference/types/archetypes/arrows3d) archetypes.
|
||||
This enables the visualization of the clock's movement over time.
|
||||
|
||||
```python
|
||||
for step in range(steps):
|
||||
rr.set_time("sim_time", duration=t_secs)
|
||||
|
||||
# … calculating seconds …
|
||||
rr.log("world/seconds_pt", rr.Points3D(positions=point_s, colors=color_s))
|
||||
rr.log("world/seconds_hand", rr.Arrows3D(vectors=point_s, colors=color_s, radii=WIDTH_S))
|
||||
|
||||
# … calculating minutes …
|
||||
rr.log("world/minutes_pt", rr.Points3D(positions=point_m, colors=color_m))
|
||||
rr.log("world/minutes_hand", rr.Arrows3D(vectors=point_m, colors=color_m, radii=WIDTH_M))
|
||||
|
||||
# … calculating hours …
|
||||
rr.log("world/hours_pt", rr.Points3D(positions=point_h, colors=color_h))
|
||||
rr.log("world/hours_hand", rr.Arrows3D(vectors=point_h, colors=color_h, radii=WIDTH_H))
|
||||
```
|
||||
|
||||
## Run the code
|
||||
To run this example, make sure you have the Rerun repository checked out and the latest SDK installed:
|
||||
```bash
|
||||
pip install --upgrade rerun-sdk # install the latest Rerun SDK
|
||||
git clone git@github.com:rerun-io/rerun.git # Clone the repository
|
||||
cd rerun
|
||||
git checkout latest # Check out the commit matching the latest SDK release
|
||||
```
|
||||
Install the necessary libraries specified in the requirements file:
|
||||
```bash
|
||||
pip install -e examples/python/clock
|
||||
```
|
||||
To experiment with the provided example, simply execute the main Python script:
|
||||
```bash
|
||||
python -m clock # run the example
|
||||
```
|
||||
If you wish to customize it, explore additional features, or save it use the CLI with the `--help` option for guidance:
|
||||
```bash
|
||||
python -m clock --help
|
||||
```
|
||||
Executable
+81
@@ -0,0 +1,81 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
An example showing usage of `log_arrow`.
|
||||
|
||||
An analog clock is built with Rerun Arrow3D primitives.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import math
|
||||
from typing import Final
|
||||
|
||||
import numpy as np
|
||||
|
||||
import rerun as rr # pip install rerun-sdk
|
||||
|
||||
LENGTH_S: Final = 20.0
|
||||
LENGTH_M: Final = 10.0
|
||||
LENGTH_H: Final = 4.0
|
||||
|
||||
WIDTH_S: Final = 0.125
|
||||
WIDTH_M: Final = 0.2
|
||||
WIDTH_H: Final = 0.3
|
||||
|
||||
|
||||
def log_clock(steps: int) -> None:
|
||||
def rotate(angle: float, len: float) -> tuple[float, float, float]:
|
||||
return (
|
||||
len * math.sin(angle),
|
||||
len * math.cos(angle),
|
||||
0.0,
|
||||
)
|
||||
|
||||
rr.log("world", rr.ViewCoordinates.RIGHT_HAND_Y_UP, static=True)
|
||||
|
||||
rr.log(
|
||||
"world/frame",
|
||||
rr.Boxes3D(half_sizes=[LENGTH_S, LENGTH_S, 1.0], centers=[0.0, 0.0, 0.0]),
|
||||
static=True,
|
||||
)
|
||||
|
||||
for step in range(steps):
|
||||
t_secs = step
|
||||
|
||||
rr.set_time("sim_time", duration=t_secs)
|
||||
|
||||
scaled_s = (t_secs % 60) / 60.0
|
||||
point_s = np.array(rotate(math.tau * scaled_s, LENGTH_S))
|
||||
color_s = (int(255 - (scaled_s * 255)), int(scaled_s * 255), 0, 128)
|
||||
rr.log("world/seconds_pt", rr.Points3D(positions=point_s, colors=color_s))
|
||||
rr.log("world/seconds_hand", rr.Arrows3D(vectors=point_s, colors=color_s, radii=WIDTH_S))
|
||||
|
||||
scaled_m = (t_secs % 3600) / 3600.0
|
||||
point_m = np.array(rotate(math.tau * scaled_m, LENGTH_M))
|
||||
color_m = (int(255 - (scaled_m * 255)), int(scaled_m * 255), 128, 128)
|
||||
rr.log("world/minutes_pt", rr.Points3D(positions=point_m, colors=color_m))
|
||||
rr.log("world/minutes_hand", rr.Arrows3D(vectors=point_m, colors=color_m, radii=WIDTH_M))
|
||||
|
||||
scaled_h = (t_secs % 43200) / 43200.0
|
||||
point_h = np.array(rotate(math.tau * scaled_h, LENGTH_H))
|
||||
color_h = (int(255 - (scaled_h * 255)), int(scaled_h * 255), 255, 255)
|
||||
rr.log("world/hours_pt", rr.Points3D(positions=point_h, colors=color_h))
|
||||
rr.log("world/hours_hand", rr.Arrows3D(vectors=point_h, colors=color_h, radii=WIDTH_H))
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser(
|
||||
description="An example visualizing an analog clock is built with Rerun Arrow3D primitives.",
|
||||
)
|
||||
parser.add_argument("--steps", type=int, default=10_000, help="The number of time steps to log")
|
||||
rr.script_add_args(parser)
|
||||
args = parser.parse_args()
|
||||
|
||||
rr.script_setup(args, "rerun_example_clock")
|
||||
log_clock(args.steps)
|
||||
rr.script_teardown(args)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,16 @@
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "clock"
|
||||
version = "0.1.0"
|
||||
readme = "README.md"
|
||||
dependencies = ["numpy", "rerun-sdk"]
|
||||
|
||||
[project.scripts]
|
||||
clock = "clock:main"
|
||||
|
||||
[tool.rerun-example]
|
||||
#skip = false
|
||||
extra-args = ["--steps=200"]
|
||||
Reference in New Issue
Block a user