Struct re_types::blueprint::archetypes::LineGrid3D

pub struct LineGrid3D {
    pub visible: Option<Visible>,
    pub spacing: Option<GridSpacing>,
    pub plane: Option<Plane3D>,
    pub stroke_width: Option<StrokeWidth>,
    pub color: Option<Color>,
}

Archetype: Configuration for the 3D line grid.

Fields

visible: Option<Visible>

Whether the grid is visible.

Defaults to true.

spacing: Option<GridSpacing>

Space between grid lines spacing of one line to the next in scene units.

As you zoom out, successively only every tenth line is shown. This controls the closest zoom level.

plane: Option<Plane3D>

In what plane the grid is drawn.

Defaults to whatever plane is determined as the plane at zero units up/down as defined by components::ViewCoordinates if present.

stroke_width: Option<StrokeWidth>

How thick the lines should be in ui units.

Default is 1.0 ui unit.

color: Option<Color>

Color used for the grid.

Transparency via alpha channel is supported. Defaults to a slightly transparent light gray.

Implementations

impl LineGrid3D

pub const NUM_COMPONENTS: usize = 6usize

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

impl LineGrid3D

pub fn new() -> Self

Create a new LineGrid3D.

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

Whether the grid is visible.

Defaults to true.

pub fn with_spacing(self, spacing: impl Into<GridSpacing>) -> Self

Space between grid lines spacing of one line to the next in scene units.

As you zoom out, successively only every tenth line is shown. This controls the closest zoom level.

pub fn with_plane(self, plane: impl Into<Plane3D>) -> Self

In what plane the grid is drawn.

Defaults to whatever plane is determined as the plane at zero units up/down as defined by components::ViewCoordinates if present.

pub fn with_stroke_width(self, stroke_width: impl Into<StrokeWidth>) -> Self

How thick the lines should be in ui units.

Default is 1.0 ui unit.

pub fn with_color(self, color: impl Into<Color>) -> Self

Color used for the grid.

Transparency via alpha channel is supported. Defaults to a slightly transparent light gray.

Trait Implementations

impl Archetype for LineGrid3D

type Indicator = GenericIndicatorComponent<LineGrid3D>

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 LineGrid3D

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 LineGrid3D

fn clone(&self) -> LineGrid3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LineGrid3D

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

Formats the value using the given formatter.

impl SizeBytes for LineGrid3D

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 LineGrid3D