Struct ElevationRequest 

pub struct ElevationRequest { /* private fields */ }

A request for the area of an object’s elevation that its cover leaves uncovered.

The elevation is the object projected onto the vertical plane through axis (a plan direction, normalised here): positions along the axis against heights. Only the part of each cover object within the object’s own depth across the axis, widened by along_growth_metres on both sides, is projected; that projection is grown by along_growth_metres along the axis and vertical_growth_metres in height.

frame objects cover by the frame they form, not by their bodies: the convex hull of their projected parts (a column at each end and a beam over them enclose the bay between), grown the same way. An empty frame adds nothing.

Implementations

impl ElevationRequest

pub fn try_new( object: ObjectId, axis: [f64; 2], cover: &[ObjectId], frame: &[ObjectId], along_growth_metres: f64, vertical_growth_metres: f64, ) -> Result<Self, PlanAreaError>

The request, its cover and frame sorted and without repeats.

Refuses an axis that is not a finite plan direction, a growth that is negative or not finite, and an object in its own cover or frame.

pub fn object(&self) -> &ObjectId

The object whose elevation is measured.

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

The unit plan direction the elevation runs along.

pub fn cover(&self) -> &[ObjectId]

The objects covering by their bodies, sorted.

pub fn frame(&self) -> &[ObjectId]

The objects covering by the frame they form, sorted.

pub fn along_growth_metres(&self) -> f64

Growth along the axis, and the depth added across it on each side.

pub fn vertical_growth_metres(&self) -> f64

Growth in height.

Trait Implementations

impl Clone for ElevationRequest

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 ElevationRequest

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

Formats the value using the given formatter.

impl PartialEq for ElevationRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ElevationRequest