Enum Shape 

pub enum Shape {
    Auto,
    Points,
    Lines,
    Surface,
    Volume,
    Outline,
    Centroid,
}

The form a caller wants a representation drawn in.

Variants

Auto

The richest form this topology supports.

A grid becomes its cells, a polyline set stays lines, a hexahedral grid stays a volume. What every export did before there was anything to ask.

Points

The nodes alone.

Lines

Polylines.

Surface

Triangles and quadrilaterals.

Volume

Cells with an inside.

Outline

One polygon: the convex hull of every node, whatever the topology was.

A summary, not a rendering - the first of the two shapes here whose output is not the object. It answers “where is this”, which is what a discovery index wants and what OSDU’s SpatialArea asks for: “a polygon boundary that reflects the locale of the content”. (OSDU).

Convex and not concave, deliberately: an alpha-shape follows a horizon’s bays and holes far better, and it needs a parameter whose wrong value silently cuts the outline into pieces. A hull has no parameter and no wrong answer - it is simply the smallest convex thing containing the data.

Centroid

One point: the mean of the nodes.

The other summary, and OSDU’s SpatialPoint: “a centroid point that reflects the locale of the content”.

The mean of the nodes, which is not the centroid of the area - a densely sampled corner pulls it. Saying so rather than implying a precision this does not have; for “where is this on a map”, at the scale these are used, the difference is invisible.

Implementations

impl Shape

pub fn name(&self) -> &'static str

The name a caller writes on a command line.

pub fn all() -> [Shape; 7]

Every shape there is, for a caller listing them.

pub fn is_summary(&self) -> bool

Whether this shape summarises the object instead of drawing it.

The two are different in a way a caller has to know about: a summary replaces the points, so nothing that hangs on nodes or cells - a property, a colour ramp - comes through it. Four points that say where a horizon is cannot carry a value per node of the horizon.

pub fn parse(text: &str) -> Option<Shape>

Parse a name, case-insensitively.

The plural and singular both work - someone writing --as Grid=polygon means the same thing as surface, and refusing them over an s teaches nothing.

Trait Implementations

impl Clone for Shape

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Shape

impl Debug for Shape

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

Formats the value using the given formatter.

impl Default for Shape

fn default() -> Self

Returns the “default value” for a type.

impl Display for Shape

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

Formats the value using the given formatter.

impl Eq for Shape

impl PartialEq for Shape

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Shape