Struct rerun::components::DepthMeter

#[repr(transparent)]
pub struct DepthMeter(pub Float32);

Component: The world->depth map scaling factor.

This measures how many depth map units are in a world unit. For instance, if a depth map uses millimeters and the world uses meters, this value would be 1000.

Note that the only effect on 2D views is the physical depth values shown when hovering the image. In 3D views on the other hand, this affects where the points of the point cloud are placed.

Tuple Fields

0: Float32

Methods from Deref<Target = f32>

pub const RADIX: u32 = 2u32

pub const MANTISSA_DIGITS: u32 = 24u32

pub const DIGITS: u32 = 6u32

pub const EPSILON: f32 = 1.1920929E-7f32

pub const MIN: f32 = -3.40282347E+38f32

pub const MIN_POSITIVE: f32 = 1.17549435E-38f32

pub const MAX: f32 = 3.40282347E+38f32

pub const MIN_EXP: i32 = -125i32

pub const MAX_EXP: i32 = 128i32

pub const MIN_10_EXP: i32 = -37i32

pub const MAX_10_EXP: i32 = 38i32

pub const NAN: f32 = NaN_f32

pub const INFINITY: f32 = +Inf_f32

pub const NEG_INFINITY: f32 = -Inf_f32

pub fn total_cmp(&self, other: &f32) -> Ordering

Return the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

• negative quiet NaN
• negative signaling NaN
• negative infinity
• negative numbers
• negative subnormal numbers
• negative zero
• positive zero
• positive subnormal numbers
• positive numbers
• positive infinity
• positive signaling NaN
• positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f32. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

Example

struct GoodBoy {
    name: String,
    weight: f32,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f32::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f32::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

// `f32::NAN` could be positive or negative, which will affect the sort order.
if f32::NAN.is_sign_negative() {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([f32::NAN, -5.0, 0.1, 10.0, 99.0, f32::INFINITY].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
} else {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([-5.0, 0.1, 10.0, 99.0, f32::INFINITY, f32::NAN].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
}

Trait Implementations

impl Borrow<Float32> for DepthMeter

fn borrow(&self) -> &Float32

Immutably borrows from an owned value.

impl Clone for DepthMeter

fn clone(&self) -> DepthMeter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DepthMeter

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

Formats the value using the given formatter.

impl Default for DepthMeter

fn default() -> DepthMeter

Returns the “default value” for a type.

impl Deref for DepthMeter

type Target = Float32

The resulting type after dereferencing.

fn deref(&self) -> &Float32

Dereferences the value.

impl DerefMut for DepthMeter

fn deref_mut(&mut self) -> &mut Float32

Mutably dereferences the value.

impl<T> From<T> for DepthMeter

where T: Into<Float32>,

fn from(v: T) -> DepthMeter

Converts to this type from the input type.

impl Loggable for DepthMeter

type Name = ComponentName

fn name() -> <DepthMeter as Loggable>::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, DepthMeter>>>> ) -> Result<Box<dyn Array>, SerializationError>

where DepthMeter: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow_opt( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<Option<DepthMeter>>, DeserializationError>

where DepthMeter: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn from_arrow( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<DepthMeter>, DeserializationError>

where DepthMeter: Sized,

Given an Arrow array, deserializes it into a collection of Loggables.

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>> ) -> Result<Box<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

impl PartialEq for DepthMeter

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

fn partial_cmp(&self, other: &DepthMeter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SizeBytes for DepthMeter

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 Zeroable for DepthMeter

fn zeroed() -> Self

Calls zeroed.

impl Copy for DepthMeter

impl Pod for DepthMeter

impl StructuralPartialEq for DepthMeter