Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the tooltip of the Force* graph view properties #8501

Merged
merged 1 commit into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ namespace rerun.blueprint.archetypes;
struct ForceCenter (
"attr.rerun.scope": "blueprint"
) {
/// Whether the force is enabled.
/// Whether the center force is enabled.
///
/// The center force tries to move the center of mass of the graph towards the origin.
enabled: rerun.blueprint.components.Enabled ("attr.rerun.component_optional", nullable, order: 100);

/// The strength of the force.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
namespace rerun.blueprint.archetypes;

/// Resolves collisions between the bounding spheres, according to the radius of the nodes.
/// Resolves collisions between the bounding circles, according to the radius of the nodes.
struct ForceCollisionRadius (
"attr.rerun.scope": "blueprint"
) {
/// Whether the force is enabled.
/// Whether the collision force is enabled.
///
/// The collision force resolves collisions between nodes based on the bounding circle defined by their radius.
enabled: rerun.blueprint.components.Enabled ("attr.rerun.component_optional", nullable, order: 100);

/// The strength of the force.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ namespace rerun.blueprint.archetypes;
struct ForceLink (
"attr.rerun.scope": "blueprint"
) {
/// Whether the force is enabled.
/// Whether the link force is enabled.
///
/// The link force aims to achieve a target distance between two nodes that are connected by one ore more edges.
enabled: rerun.blueprint.components.Enabled ("attr.rerun.component_optional", nullable, order: 100);

/// The target distance between two nodes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ namespace rerun.blueprint.archetypes;
struct ForceManyBody (
"attr.rerun.scope": "blueprint"
) {
/// Whether the force is enabled.
/// Whether the many body force is enabled.
///
/// The many body force is applied on each pair of nodes in a way that ressembles an electrical charge. If the
/// strength is smaller than 0, it pushes nodes apart; if it is larger than 0, it pulls them together.
enabled: rerun.blueprint.components.Enabled ("attr.rerun.component_optional", nullable, order: 100);

/// The strength of the force.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ namespace rerun.blueprint.archetypes;
struct ForcePosition (
"attr.rerun.scope": "blueprint"
) {
/// Whether the force is enabled.
/// Whether the position force is enabled.
///
/// The position force pulls nodes towards a specific position, similar to gravity.
enabled: rerun.blueprint.components.Enabled ("attr.rerun.component_optional", nullable, order: 100);

/// The strength of the force.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions crates/store/re_types/src/blueprint/archetypes/force_link.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 15 additions & 10 deletions crates/store/re_types/src/reflection/mod.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions docs/content/reference/types/views/graph_view.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions rerun_cpp/src/rerun/blueprint/archetypes/force_center.hpp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions rerun_cpp/src/rerun/blueprint/archetypes/force_link.hpp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 8 additions & 2 deletions rerun_cpp/src/rerun/blueprint/archetypes/force_many_body.hpp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions rerun_cpp/src/rerun/blueprint/archetypes/force_position.hpp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading