rerun::blueprint::archetypes::SpaceViewContents Struct Reference

Archetype: The contents of a SpaceView. More...

#include <rerun/blueprint/archetypes/space_view_contents.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	SpaceViewContents (SpaceViewContents &&other)=default
	SpaceViewContents (Collection< rerun::blueprint::components::QueryExpression > _query)

Public Attributes
Collection< rerun::blueprint::components::QueryExpression >	query
	The QueryExpression that populates the contents for the SpaceView.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: The contents of a SpaceView.

The contents are found by combining a collection of QueryExpressions.

+ /world/‍**           # add everything…
- /world/roads/‍**     # …but remove all roads…
+ /world/roads/main   # …but show main road

If there is multiple matching rules, the most specific rule wins. If there are multiple rules of the same specificity, the last one wins. If no rules match, the path is excluded.

Specifying a path without a + or - prefix is equivalent to +:

/world/‍**           # add everything…
- /world/roads/‍**   # …but remove all roads…
/world/roads/main   # …but show main road

The /‍** suffix matches the whole subtree, i.e. self and any child, recursively (/world/‍** matches both /world and /world/car/driver). Other uses of * are not (yet) supported.

Internally, EntityPathFilter sorts the rule by entity path, with recursive coming before non-recursive. This means the last matching rule is also the most specific one. For instance:

+ /world/‍**
- /world
- /world/car/‍**
+ /world/car/driver

The last rule matching /world/car/driver is + /world/car/driver, so it is included. The last rule matching /world/car/hood is - /world/car/‍**, so it is excluded. The last rule matching /world is - /world, so it is excluded. The last rule matching /world/house is + /world/‍**, so it is included.

Member Data Documentation

query

Collection<rerun::blueprint::components::QueryExpression> rerun::blueprint::archetypes::SpaceViewContents::query

The QueryExpression that populates the contents for the SpaceView.

They determine which entities are part of the spaceview.

IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::SpaceViewContents::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.SpaceViewContentsIndicator"

---

The documentation for this struct was generated from the following file:

• rerun/blueprint/archetypes/space_view_contents.hpp