Struct rerun::GraphNodes

pub struct GraphNodes {
    pub node_ids: Option<SerializedComponentBatch>,
    pub positions: Option<SerializedComponentBatch>,
    pub colors: Option<SerializedComponentBatch>,
    pub labels: Option<SerializedComponentBatch>,
    pub show_labels: Option<SerializedComponentBatch>,
    pub radii: Option<SerializedComponentBatch>,
}

Archetype: A list of nodes in a graph with optional labels, colors, etc.

Example

Simple directed graph

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_graph_directed").spawn()?;

    rec.log(
        "simple",
        &[
            &rerun::GraphNodes::new(["a", "b", "c"])
                .with_positions([(0.0, 100.0), (-100.0, 0.0), (100.0, 0.0)])
                .with_labels(["A", "B", "C"]) as &dyn rerun::AsComponents,
            &rerun::GraphEdges::new([("a", "b"), ("b", "c"), ("c", "a")]).with_directed_edges(),
        ],
    )?;

    Ok(())
}

Fields

node_ids: Option<SerializedComponentBatch>

A list of node IDs.

positions: Option<SerializedComponentBatch>

Optional center positions of the nodes.

colors: Option<SerializedComponentBatch>

Optional colors for the boxes.

labels: Option<SerializedComponentBatch>

Optional text labels for the node.

show_labels: Option<SerializedComponentBatch>

Optional choice of whether the text labels should be shown by default.

radii: Option<SerializedComponentBatch>

Optional radii for nodes.

Implementations

impl GraphNodes

pub fn descriptor_node_ids() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::node_ids.

pub fn descriptor_positions() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::positions.

pub fn descriptor_colors() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::colors.

pub fn descriptor_labels() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::labels.

pub fn descriptor_show_labels() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::show_labels.

pub fn descriptor_radii() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::radii.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl GraphNodes

pub const NUM_COMPONENTS: usize = 7usize

The total number of components in the archetype: 1 required, 1 recommended, 5 optional

impl GraphNodes

pub fn new( node_ids: impl IntoIterator<Item = impl Into<GraphNode>>, ) -> GraphNodes

Create a new GraphNodes.

pub fn update_fields() -> GraphNodes

Update only some specific fields of a GraphNodes.

pub fn clear_fields() -> GraphNodes

Clear all the fields of a GraphNodes.

pub fn columns<I>( self, _lengths: I, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_node_ids( self, node_ids: impl IntoIterator<Item = impl Into<GraphNode>>, ) -> GraphNodes

A list of node IDs.

pub fn with_positions( self, positions: impl IntoIterator<Item = impl Into<Position2D>>, ) -> GraphNodes

Optional center positions of the nodes.

pub fn with_colors( self, colors: impl IntoIterator<Item = impl Into<Color>>, ) -> GraphNodes

Optional colors for the boxes.

pub fn with_labels( self, labels: impl IntoIterator<Item = impl Into<Text>>, ) -> GraphNodes

Optional text labels for the node.

pub fn with_show_labels(self, show_labels: impl Into<ShowLabels>) -> GraphNodes

Optional choice of whether the text labels should be shown by default.

pub fn with_many_show_labels( self, show_labels: impl IntoIterator<Item = impl Into<ShowLabels>>, ) -> GraphNodes

This method makes it possible to pack multiple crate::components::ShowLabels in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_show_labels should be used when logging a single row’s worth of data.

pub fn with_radii( self, radii: impl IntoIterator<Item = impl Into<Radius>>, ) -> GraphNodes

Optional radii for nodes.

Trait Implementations

impl Archetype for GraphNodes

type Indicator = GenericIndicatorComponent<GraphNodes>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, Arc<dyn Array>)>, ) -> Result<GraphNodes, DeserializationError>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for GraphNodes

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for GraphNodes

fn clone(&self) -> GraphNodes

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphNodes

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for GraphNodes

fn default() -> GraphNodes

Returns the “default value” for a type.

impl PartialEq for GraphNodes

fn eq(&self, other: &GraphNodes) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for GraphNodes

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for GraphNodes

impl StructuralPartialEq for GraphNodes