diff --git a/docs/snippets/INDEX.md b/docs/snippets/INDEX.md index 54c37146d7148..7643fa07aa856 100644 --- a/docs/snippets/INDEX.md +++ b/docs/snippets/INDEX.md @@ -22,8 +22,8 @@ Use it to quickly find copy-pastable snippets of code for any Rerun feature you' | ------- | ------- | ----------- | ------ | ---- | --- | | **Query dataframes** | `dataframe_query` | Query and display the first 10 rows of a recording | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/reference/dataframe_query.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/reference/dataframe_query.rs) | | | **Query dataframes** | `dataframe_view_query` | Query and display the first 10 rows of a recording in a dataframe view | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/reference/dataframe_view_query.py) | | | -| **Send columnar data** | `any_batch_value_send_columns` | Use `AnyBatchValue` and `send_column` to send an entire column of custom data to Rerun | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_batch_value_send_columns.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_batch_value_send_columns.rs) | | -| **Send columnar data** | `any_values_send_columns` | Use `AnyValues` and `send_column` to send entire columns of custom data to Rerun | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_values_send_columns.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_values_send_columns.rs) | | +| **Send columnar data** | `any_batch_value_send_columns` | Use `AnyBatchValue` and `send_column` to send an entire column of custom data to Rerun | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_batch_value_send_columns.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_batch_value_send_columns.rs) | [🌊](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_batch_value_send_columns.cpp) | +| **Send columnar data** | `any_values_send_columns` | Use `AnyValues` and `send_column` to send entire columns of custom data to Rerun | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_values_send_columns.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_values_send_columns.rs) | [🌊](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/howto/any_values_send_columns.cpp) | | **Send columnar data** | `image_send_columns` | Send multiple images at once using `send_columns` | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/image_send_columns.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/image_send_columns.rs) | [🌊](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/image_send_columns.cpp) | | **Send columnar data** | `points3d_send_columns` | Use the `send_columns` API to send several point clouds over time in a single call | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/points3d_send_columns.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/points3d_send_columns.rs) | [🌊](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/points3d_send_columns.cpp) | | **Send columnar data** | `scalar_send_columns` | Use the `send_columns` API to send scalars over time in a single call | [🐍](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/scalar_send_columns.py) | [🦀](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/scalar_send_columns.rs) | [🌊](https://github.com/rerun-io/rerun/blob/main/docs/snippets/all/archetypes/scalar_send_columns.cpp) | diff --git a/docs/snippets/all/archetypes/image_send_columns.cpp b/docs/snippets/all/archetypes/image_send_columns.cpp index d7c6d40fde1b1..7653ad70ccbf4 100644 --- a/docs/snippets/all/archetypes/image_send_columns.cpp +++ b/docs/snippets/all/archetypes/image_send_columns.cpp @@ -44,7 +44,7 @@ int main() { // Send all images at once. rec.send_columns( "images", - rerun::TimeColumn::from_sequence_points("step", std::move(times)), + rerun::TimeColumn::from_sequence("step", std::move(times)), rerun::Image().with_many_buffer(std::move(image_data)).columns() ); } diff --git a/docs/snippets/all/archetypes/scalar_send_columns.cpp b/docs/snippets/all/archetypes/scalar_send_columns.cpp index 1a748591f037d..a4765e21aa091 100644 --- a/docs/snippets/all/archetypes/scalar_send_columns.cpp +++ b/docs/snippets/all/archetypes/scalar_send_columns.cpp @@ -21,7 +21,7 @@ int main() { // Serialize to columns and send. rec.send_columns( "scalars", - rerun::TimeColumn::from_sequence_points("step", std::move(times)), + rerun::TimeColumn::from_sequence("step", std::move(times)), rerun::Scalar().with_many_scalar(std::move(scalar_data)).columns() ); } diff --git a/rerun_cpp/src/rerun/archetypes/scalar.hpp b/rerun_cpp/src/rerun/archetypes/scalar.hpp index eed555eb6eda7..747f3613b2d41 100644 --- a/rerun_cpp/src/rerun/archetypes/scalar.hpp +++ b/rerun_cpp/src/rerun/archetypes/scalar.hpp @@ -73,7 +73,7 @@ namespace rerun::archetypes { /// // Serialize to columns and send. /// rec.send_columns( /// "scalars", - /// rerun::TimeColumn::from_sequence_points("step", std::move(times)), + /// rerun::TimeColumn::from_sequence("step", std::move(times)), /// rerun::Scalar().with_many_scalar(std::move(scalar_data)).columns() /// ); /// } diff --git a/rerun_cpp/src/rerun/time_column.hpp b/rerun_cpp/src/rerun/time_column.hpp index 111b66cbb5220..d16dfe7af6161 100644 --- a/rerun_cpp/src/rerun/time_column.hpp +++ b/rerun_cpp/src/rerun/time_column.hpp @@ -69,6 +69,9 @@ namespace rerun { /// Make sure the sorting status is correctly specified. /// \param sorting_status The sorting status of the sequence points. /// Already sorted time points may perform better. + /// + /// \deprecated Use `from_sequence` instead. + [[deprecated("Use `from_sequence` instead.")]] static TimeColumn from_sequence_points( std::string timeline_name, Collection sequence_points, SortingStatus sorting_status = SortingStatus::Unknown @@ -80,6 +83,24 @@ namespace rerun { ); } + /// Creates a time column from an array of sequence points. + /// + /// \param timeline_name The name of the timeline this column belongs to. + /// \param sequence_points The sequence points. + /// Make sure the sorting status is correctly specified. + /// \param sorting_status The sorting status of the sequence points. + /// Already sorted time points may perform better. + static TimeColumn from_sequence( + std::string timeline_name, Collection sequence_points, + SortingStatus sorting_status = SortingStatus::Unknown + ) { + return TimeColumn( + Timeline(std::move(timeline_name), TimeType::Sequence), + std::move(sequence_points), + sorting_status + ); + } + /// Creates a time column from an array of nanoseconds. /// /// \param timeline_name The name of the timeline this column belongs to.