Struct re_types::blueprint::archetypes::VisualBounds2D

pub struct VisualBounds2D {
    pub range: Option<SerializedComponentBatch>,
}

Archetype: Controls the visual bounds of a 2D view.

Everything within these bounds are guaranteed to be visible. Somethings outside of these bounds may also be visible due to letterboxing.

If no visual bounds are set, it will be determined automatically, based on the bounding-box of the data or other camera information present in the view.

Fields

range: Option<SerializedComponentBatch>

Controls the visible range of a 2D view.

Use this to control pan & zoom of the view.

Implementations

impl VisualBounds2D

pub fn descriptor_range() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::range.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl VisualBounds2D

pub const NUM_COMPONENTS: usize = 2usize

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

impl VisualBounds2D

pub fn new(range: impl Into<VisualBounds2D>) -> Self

Create a new VisualBounds2D.

pub fn update_fields() -> Self

Update only some specific fields of a VisualBounds2D.

pub fn clear_fields() -> Self

Clear all the fields of a VisualBounds2D.

pub fn with_range(self, range: impl Into<VisualBounds2D>) -> Self

Controls the visible range of a 2D view.

Use this to control pan & zoom of the view.

Trait Implementations

impl Archetype for VisualBounds2D

type Indicator = GenericIndicatorComponent<VisualBounds2D>

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, ArrayRef)>, ) -> 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.

impl AsComponents for VisualBounds2D

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 VisualBounds2D

fn clone(&self) -> VisualBounds2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VisualBounds2D

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

Formats the value using the given formatter.

impl Default for VisualBounds2D

fn default() -> VisualBounds2D

Returns the “default value” for a type.

impl SizeBytes for VisualBounds2D

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 VisualBounds2D