Struct re_types::blueprint::archetypes::ViewBlueprint

pub struct ViewBlueprint {
    pub class_identifier: ViewClass,
    pub display_name: Option<Name>,
    pub space_origin: Option<ViewOrigin>,
    pub visible: Option<Visible>,
}

Archetype: The description of a single view.

Fields

class_identifier: ViewClass

The class of the view.

display_name: Option<Name>

The name of the view.

space_origin: Option<ViewOrigin>

The “anchor point” of this view.

Defaults to the root path ‘/’ if not specified.

The transform at this path forms the reference point for all scene->world transforms in this view. I.e. the position of this entity path in space forms the origin of the coordinate system in this view. Furthermore, this is the primary indicator for heuristics on what entities we show in this view.

visible: Option<Visible>

Whether this view is visible.

Defaults to true if not specified.

Implementations

impl ViewBlueprint

pub const NUM_COMPONENTS: usize = 5usize

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

impl ViewBlueprint

pub fn new(class_identifier: impl Into<ViewClass>) -> Self

Create a new ViewBlueprint.

pub fn with_display_name(self, display_name: impl Into<Name>) -> Self

The name of the view.

pub fn with_space_origin(self, space_origin: impl Into<ViewOrigin>) -> Self

The “anchor point” of this view.

Defaults to the root path ‘/’ if not specified.

The transform at this path forms the reference point for all scene->world transforms in this view. I.e. the position of this entity path in space forms the origin of the coordinate system in this view. Furthermore, this is the primary indicator for heuristics on what entities we show in this view.

pub fn with_visible(self, visible: impl Into<Visible>) -> Self

Whether this view is visible.

Defaults to true if not specified.

Trait Implementations

impl Archetype for ViewBlueprint

type Indicator = GenericIndicatorComponent<ViewBlueprint>

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>)>, ) -> DeserializationResult<Self>

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 ViewBlueprint

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 ViewBlueprint

fn clone(&self) -> ViewBlueprint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewBlueprint

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

Formats the value using the given formatter.

impl SizeBytes for ViewBlueprint

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 ViewBlueprint