Struct substrate::geometry::ring::Ring

pub struct Ring { /* private fields */ }

A rectangular ring surrounding an enclosed rectangle.

Implementations

impl Ring

pub fn builder() -> RingBuilder

Creates a new RingBuilder.

pub fn outer_hspan(&self) -> Span

The horizontal span of the annulus of the ring.

pub fn inner_hspan(&self) -> Span

The horizontal span of the inner portion of the ring.

pub fn outer_vspan(&self) -> Span

The vertical span of the annulus of the ring.

pub fn inner_vspan(&self) -> Span

The vertical span of the inner portion of the ring.

pub fn outer(&self) -> Rect

The outer annulus bounding box.

pub fn inner(&self) -> Rect

The inner rectangle.

pub fn rect(&self, side: Side) -> Rect

The annular rectangle on the given side.

pub fn inner_rect(&self, side: Side) -> Rect

The annuluar rectangle on the given side, but limited to the width/height of the inner rectangle.

pub fn corner(&self, corner: Corner) -> Rect

The lower left annular corner.

Shares a corner with the inner rect, but does not have any edges in common with the inner rect.

pub fn left(&self) -> Rect

The left annular rectangle.

pub fn right(&self) -> Rect

The right annular rectangle.

pub fn top(&self) -> Rect

The top annular rectangle.

pub fn bot(&self) -> Rect

The bottom annular rectangle.

pub fn rects(&self) -> [Rect; 4]

All 4 annular rectangles.

The order is subject to change.

pub fn hrects(&self) -> [Rect; 2]

The Rects going in the horizontal direction (ie. the bottom and top rectangles).

pub fn vrects(&self) -> [Rect; 2]

The Rects going in the vertical direction (ie. the left and right rectangles).

pub fn inner_rects(&self) -> [Rect; 4]

The 4 inner annular rectangles.

The order is subject to change.

pub fn inner_vrects(&self) -> [Rect; 2]

The inner annular vertical-going (i.e. left and right) rectangles.

pub fn inner_hrects(&self) -> [Rect; 2]

The inner annular horizontal-going (i.e. top and bottom) rectangles.

pub fn dir_rects(&self, dir: Dir) -> [Rect; 2]

The Rects going in the given direction.

Also see Ring::hrects and Ring::vrects.

Trait Implementations

impl Bbox for Ring

fn bbox(&self) -> Option<Rect>

Computes the axis-aligned rectangular bounding box.

fn bbox_rect(&self) -> Rect

Computes the axis-aligned rectangular bounding box, panicking if it is empty.

impl Clone for Ring

fn clone(&self) -> Ring

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Contains<Point> for Ring

fn contains(&self, other: &Point) -> Containment

Returns a Containment indicating how other is enclosed within this shape.

fn encloses(&self, other: &T) -> bool

Returns true if other is fully enclosed in this shape.

fn partially_intersects(&self, other: &T) -> bool

Returns true if other is fully or partially enclosed in this shape.

impl Debug for Ring

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

Formats the value using the given formatter.

impl Default for Ring

fn default() -> Ring

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ring

fn deserialize<__D>( __deserializer: __D ) -> Result<Ring, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RingBuilder> for Ring

fn from(value: RingBuilder) -> Ring

Converts to this type from the input type.

impl Ord for Ring

fn cmp(&self, other: &Ring) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Ring

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

fn partial_cmp(&self, other: &Ring) -> 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 Serialize for Ring

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TranslateMut for Ring

fn translate_mut(&mut self, p: Point)

Translates the shape by a Point through mutation.

impl Copy for Ring

impl Eq for Ring

impl StructuralPartialEq for Ring