Skip to content

Commit 4abee78

Browse files
committed
sharpen documentation of InstancePoses3D in respect to frames.
1 parent 35345ff commit 4abee78

File tree

6 files changed

+21
-18
lines changed

6 files changed

+21
-18
lines changed

crates/store/re_types/definitions/rerun/archetypes/instance_poses3d.fbs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
namespace rerun.archetypes;
22

33

4-
/// One or more transforms between the current entity and its parent. Unlike [archetypes.Transform3D], it is *not* propagated in the transform hierarchy.
4+
/// One or more transforms applied on the current entity's transform frame.
55
///
6-
/// If both [archetypes.InstancePoses3D] and [archetypes.Transform3D] are present,
7-
/// first the tree propagating [archetypes.Transform3D] is applied, then [archetypes.InstancePoses3D].
6+
/// Unlike [archetypes.Transform3D], it is *not* propagated in the transform hierarchy.
7+
/// If [archetypes.CoordinateFrame] is specified, it acts relative to that coordinate frame,
8+
/// otherwise it is relative to the entity's implicit coordinate frame.
89
///
910
/// Whenever you log this archetype, the state of the resulting overall pose is fully reset to the new archetype.
1011
/// This means that if you first log a pose with only a translation, and then log one with only a rotation,
@@ -53,6 +54,4 @@ table InstancePoses3D (
5354
///
5455
/// Any update to this field will reset all other transform properties that aren't changed in the same log call or `send_columns` row.
5556
mat3x3: [rerun.components.PoseTransformMat3x3] ("attr.rerun.component_optional", nullable, order: 1500);
56-
57-
// TODO: Clarify interaction with frames.
5857
}

crates/store/re_types/src/archetypes/instance_poses3d.rs

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/archetypes.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/archetypes/instance_poses3d.md

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rerun_cpp/src/rerun/archetypes/instance_poses3d.hpp

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rerun_py/rerun_sdk/rerun/archetypes/instance_poses3d.py

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)