Skip to content

Commit dccf0af

Browse files
committed
some doc updates
1 parent 020350d commit dccf0af

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed

crates/store/re_tf/src/transform_forest.rs

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -212,17 +212,10 @@ pub enum TransformTreeRootInfo {
212212
//TransformFrameRoot,
213213
}
214214

215-
/// Provides transforms from any transform frame to a root transform frame for a given time & timeline.
215+
/// Analyzes & propagates the transform graph of a recording at a given time & timeline.
216216
///
217-
/// This information can then be used to relatively quickly resolve transforms to a given reference transform frame
218-
/// should such a connection exist.
219-
///
220-
/// The resulting transforms are dependent on:
221-
/// * tree, pose, pinhole and view-coordinates transforms components as logged to the data store. See [`TransformResolutionCache`] for more details.
222-
/// * TODO(#6743): blueprint overrides aren't respected yet
223-
/// * the query time
224-
/// * TODO(#723): ranges aren't taken into account yet
225-
// TODO: update docs a bit
217+
/// Identifies different transform trees present in the recording and computes transforms relative to their roots,
218+
/// such that arbitrary transforms within the tree can be resolved (relatively) quickly.
226219
#[derive(Default, Clone)]
227220
pub struct TransformForest {
228221
/// All known tree roots.

crates/viewer/re_view_spatial/src/contexts/transform_tree_context.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ use re_viewer_context::{
1212

1313
use crate::{caches::TransformDatabaseStoreCache, visualizers::CamerasVisualizer};
1414

15-
// TODO: docs
16-
15+
/// Provides a transform tree for the view & time it operates on.
16+
///
17+
/// Will do the necessary bulk processing of transform information and make it available
18+
/// for quick lookups by visualizers.
1719
#[derive(Clone)]
1820
pub struct TransformTreeContext {
1921
transform_forest: Arc<re_tf::TransformForest>,

0 commit comments

Comments
 (0)