Struct rerun::archetypes::Ellipsoids3D

pub struct Ellipsoids3D {
    pub half_sizes: Vec<HalfSize3D>,
    pub centers: Option<Vec<PoseTranslation3D>>,
    pub rotation_axis_angles: Option<Vec<PoseRotationAxisAngle>>,
    pub quaternions: Option<Vec<PoseRotationQuat>>,
    pub colors: Option<Vec<Color>>,
    pub line_radii: Option<Vec<Radius>>,
    pub fill_mode: Option<FillMode>,
    pub labels: Option<Vec<Text>>,
    pub show_labels: Option<ShowLabels>,
    pub class_ids: Option<Vec<ClassId>>,
}

Archetype: 3D ellipsoids or spheres.

This archetype is for ellipsoids or spheres whose size is a key part of the data (e.g. a bounding sphere). For points whose radii are for the sake of visualization, use archetypes::Points3D instead.

Note that orienting and placing the ellipsoids/spheres is handled via [archetypes.InstancePoses3D]. Some of its component are repeated here for convenience. If there’s more instance poses than half sizes, the last half size will be repeated for the remaining poses.

Fields

half_sizes: Vec<HalfSize3D>

For each ellipsoid, half of its size on its three axes.

If all components are equal, then it is a sphere with that radius.

centers: Option<Vec<PoseTranslation3D>>

Optional center positions of the ellipsoids.

If not specified, the centers will be at (0, 0, 0). Note that this uses a components::PoseTranslation3D which is also used by archetypes::InstancePoses3D.

rotation_axis_angles: Option<Vec<PoseRotationAxisAngle>>

Rotations via axis + angle.

If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system. Note that this uses a components::PoseRotationAxisAngle which is also used by archetypes::InstancePoses3D.

quaternions: Option<Vec<PoseRotationQuat>>

Rotations via quaternion.

If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system. Note that this uses a components::PoseRotationQuat which is also used by archetypes::InstancePoses3D.

colors: Option<Vec<Color>>

Optional colors for the ellipsoids.

line_radii: Option<Vec<Radius>>

Optional radii for the lines used when the ellipsoid is rendered as a wireframe.

fill_mode: Option<FillMode>

Optionally choose whether the ellipsoids are drawn with lines or solid.

labels: Option<Vec<Text>>

Optional text labels for the ellipsoids.

show_labels: Option<ShowLabels>

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

class_ids: Option<Vec<ClassId>>

Optional class ID for the ellipsoids.

The class ID provides colors and labels if not specified explicitly.

Implementations

impl Ellipsoids3D

pub const NUM_COMPONENTS: usize = 11usize

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

impl Ellipsoids3D

pub fn with_centers( self, centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>> ) -> Ellipsoids3D

Optional center positions of the ellipsoids.

If not specified, the centers will be at (0, 0, 0). Note that this uses a components::PoseTranslation3D which is also used by archetypes::InstancePoses3D.

pub fn with_rotation_axis_angles( self, rotation_axis_angles: impl IntoIterator<Item = impl Into<PoseRotationAxisAngle>> ) -> Ellipsoids3D

Rotations via axis + angle.

If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system. Note that this uses a components::PoseRotationAxisAngle which is also used by archetypes::InstancePoses3D.

pub fn with_quaternions( self, quaternions: impl IntoIterator<Item = impl Into<PoseRotationQuat>> ) -> Ellipsoids3D

Rotations via quaternion.

If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system. Note that this uses a components::PoseRotationQuat which is also used by archetypes::InstancePoses3D.

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

Optional colors for the ellipsoids.

pub fn with_line_radii( self, line_radii: impl IntoIterator<Item = impl Into<Radius>> ) -> Ellipsoids3D

Optional radii for the lines used when the ellipsoid is rendered as a wireframe.

pub fn with_fill_mode(self, fill_mode: impl Into<FillMode>) -> Ellipsoids3D

Optionally choose whether the ellipsoids are drawn with lines or solid.

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

Optional text labels for the ellipsoids.

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

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

pub fn with_class_ids( self, class_ids: impl IntoIterator<Item = impl Into<ClassId>> ) -> Ellipsoids3D

Optional class ID for the ellipsoids.

The class ID provides colors and labels if not specified explicitly.

impl Ellipsoids3D

pub fn from_radii(radii: impl IntoIterator<Item = f32>) -> Ellipsoids3D

Creates a new Ellipsoids3D for spheres with the given radii.

pub fn from_centers_and_radii( centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>, radii: impl IntoIterator<Item = f32> ) -> Ellipsoids3D

Creates a new Ellipsoids3D for spheres with the given Self::centers, and Self::half_sizes all equal to the given radii.

pub fn from_half_sizes( half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>> ) -> Ellipsoids3D

Creates a new Ellipsoids3D with Self::half_sizes.

pub fn from_centers_and_half_sizes( centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>, half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>> ) -> Ellipsoids3D

Creates a new Ellipsoids3D with Self::centers and Self::half_sizes.

Trait Implementations

impl Archetype for Ellipsoids3D

type Indicator = GenericIndicatorComponent<Ellipsoids3D>

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

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

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

Returns the names of all components that must be provided by the user when constructing this archetype.

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

Returns the names of all components that should be provided by the user when constructing this archetype.

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

Returns the names of all components that may be provided by the user when constructing this archetype.

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

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> Result<Ellipsoids3D, DeserializationError>

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

fn from_arrow( 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.

impl AsComponents for Ellipsoids3D

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

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

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

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

impl Clone for Ellipsoids3D

fn clone(&self) -> Ellipsoids3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ellipsoids3D

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

Formats the value using the given formatter.

impl PartialEq for Ellipsoids3D

fn eq(&self, other: &Ellipsoids3D) -> 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 Ellipsoids3D

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 Ellipsoids3D

impl StructuralPartialEq for Ellipsoids3D