Struct PlanRectangle 

pub struct PlanRectangle { /* private fields */ }

The rectangle of least area enclosing an object’s footprint, oriented in plan: a centre, two unit axes and the half extents along them.

Every value is bounded: the true centre lies within Self::centre_radius_metres of Self::centre, each true axis within Self::axis_error_radians of the stated one, and each true half extent inside its interval. The evidence is exact exactly when every bound is a point and the orientation is RectangleOrientation::Unique.

Implementations

impl PlanRectangle

pub fn try_new( object: ObjectId, centre: [f64; 2], centre_radius: f64, axes: [[f64; 2]; 2], axis_error: f64, half_extents: [(f64, f64); 2], orientation: RectangleOrientation, evidence: Evidence, ) -> Result<Self, PlanSpanError>

The rectangle enclosing object’s footprint.

axes are unit vectors, the second the first turned a quarter counter-clockwise, the first pointing into [0, 90) degrees, so one rectangle has one spelling. half_extents are (lower, upper) intervals along the axes in order.

pub fn object(&self) -> &ObjectId

The object whose footprint the rectangle encloses.

pub fn centre(&self) -> [f64; 2]

The measured centre, in canonical metres.

pub fn centre_radius_metres(&self) -> f64

How far, in metres, the true centre can lie from Self::centre.

pub fn axes(&self) -> [[f64; 2]; 2]

The two unit axes, the second the first turned a quarter counter-clockwise.

pub fn axis_error_radians(&self) -> f64

How far, in radians, each true axis can be turned from the stated one.

pub fn half_extents_metres(&self) -> [(f64, f64); 2]

The half extents along the two axes, each (lower, upper) metres.

pub fn orientation(&self) -> RectangleOrientation

How well the orientation is known.

pub fn is_exact(&self) -> bool

Whether the rectangle is known exactly.

pub fn evidence(&self) -> &Evidence

Reviewable provenance of the measurement.

pub fn width_and_length(&self) -> Result<[(f64, f64); 2], String>

The footprint’s width and length along its own axes: the shorter and the longer side, each (lower, upper) metres.

Refused unless the orientation is RectangleOrientation::Unique: another rectangle of least area may have other sides. Near-equal sides are fine; which of them is the longer does not matter here.

pub fn long_axis(&self) -> Result<usize, String>

The index of the longer axis, when the orientation is unique and one side is surely longer than the other. A square, or a rectangle whose sides the measurement cannot order, has no long axis.

pub fn long_axis_angle(&self, other: &Self) -> Result<(f64, f64), String>

The acute angle between this footprint’s long axis and other’s, in degrees within [0, 90], as (lower, upper) sure to hold the angle between the true axes.

Trait Implementations

impl Clone for PlanRectangle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanRectangle

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

Formats the value using the given formatter.

impl PartialEq for PlanRectangle

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlanRectangle