Struct RulerItem 

pub struct RulerItem {
    pub start: [f32; 3],
    pub end: [f32; 3],
    pub colour: [f32; 4],
    pub line_width_px: f32,
    pub font: Option<FontHandle>,
    pub font_size: f32,
    pub label_colour: [f32; 4],
    pub label_format: Option<String>,
    pub end_caps: bool,
}

A two-point measurement overlay that displays the distance between two world-space positions, with a distance readout at the segment midpoint.

Both endpoints are projected each frame by the renderer; the item culls cleanly when both endpoints are behind the camera.

Examples

let ruler = RulerItem {
    start: [0.0, 0.0, 0.0],
    end: [2.5, 0.0, 0.0],
    colour: [1.0, 1.0, 1.0, 1.0],
    label_format: Some("{:.2} m".into()),
    ..Default::default()
};

Fields

start: [f32; 3]

World-space start endpoint.

end: [f32; 3]

World-space end endpoint.

colour: [f32; 4]

RGBA colour for the ruler line and end caps. Default: white.

line_width_px: f32

Line thickness in screen pixels. Default: 1.5.

font: Option<FontHandle>

Font for the distance label. None = built-in default.

font_size: f32

Font size for the distance label in logical pixels. Default: 13.0.

label_colour: [f32; 4]

RGBA colour for the distance label text. Default: white.

label_format: Option<String>

Format string for the distance value using Rust format! syntax.

The {} placeholder is replaced with the computed distance. Accepts precision specifiers like "{:.3}" or unit suffixes like "{:.2} m". Default (None): "{:.3}" (3 decimal places).

end_caps: bool

Draw small perpendicular tick marks at each endpoint. Default: true.

Trait Implementations

impl Clone for RulerItem

fn clone(&self) -> RulerItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RulerItem

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

Formats the value using the given formatter.

impl Default for RulerItem

fn default() -> Self

Returns the “default value” for a type.