Struct rerun::sdk::prelude::GraphNodes

pub struct GraphNodes {
    pub node_ids: Vec<GraphNode>,
    pub positions: Option<Vec<Position2D>>,
    pub colors: Option<Vec<Color>>,
    pub labels: Option<Vec<Text>>,
    pub show_labels: Option<ShowLabels>,
    pub radii: Option<Vec<Radius>>,
}

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: Vec<GraphNode>

A list of node IDs.

positions: Option<Vec<Position2D>>

Optional center positions of the nodes.

colors: Option<Vec<Color>>

Optional colors for the boxes.

labels: Option<Vec<Text>>

Optional text labels for the node.

show_labels: Option<ShowLabels>

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

radii: Option<Vec<Radius>>

Optional radii for nodes.

Implementations

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 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_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() -> ComponentBatchCowWithDescriptor<'static>

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_arrow2_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<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.

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

where Self: Sized,

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

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

where Self: Sized,

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

impl AsComponents for GraphNodes

fn as_component_batches(&self) -> Vec<ComponentBatchCowWithDescriptor<'_>>

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

fn to_arrow2(&self) -> Result<Vec<(Field, Box<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 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 the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

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.

impl ArchetypeReflectionMarker for GraphNodes

impl StructuralPartialEq for GraphNodes