Struct fj_core::objects::Region

pub struct Region { /* private fields */ }

A single, continuous 2d region, may contain holes

Interior cycles must have the opposite winding of the exterior cycle, meaning on the front side of the region, they must appear clockwise. This means that all HalfEdges that bound a Region have the interior of the region on their left side (on the region’s front side).

Implementations

impl Region

pub fn new( exterior: Handle<Cycle>, interiors: impl IntoIterator<Item = Handle<Cycle>>, color: Option<Color> ) -> Self

Construct an instance of Region

pub fn exterior(&self) -> &Handle<Cycle>

Access the cycle that bounds the region on the outside

pub fn interiors(&self) -> impl Iterator<Item = &Handle<Cycle>> + '_

Access the cycles that bound the region on the inside

Each of these cycles defines a hole in the region .

pub fn all_cycles(&self) -> impl Iterator<Item = &Handle<Cycle>> + '_

Access all cycles of the region (both exterior and interior)

pub fn color(&self) -> Option<Color>

Access the color of the region

Trait Implementations

impl BuildRegion for Region

fn empty(services: &mut Services) -> Region

Build an empty region

fn circle( center: impl Into<Point<2>>, radius: impl Into<Scalar>, services: &mut Services ) -> Region

Build a circle

fn polygon<P, Ps>(points: Ps, services: &mut Services) -> Regionwhere P: Into<Point<2>>, Ps: IntoIterator<Item = P>, Ps::IntoIter: Clone + ExactSizeIterator,

Build a polygon

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl From<Region> for Object<Bare>

fn from(object: Region) -> Self

Converts to this type from the input type.

impl Hash for Region

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Insert for Region

type Inserted = Handle<Region>

The type of Self, once it has been inserted

fn insert(self, services: &mut Services) -> Self::Inserted

Insert the object into its respective store

impl Ord for Region

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Region> for Region

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

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

fn update_exterior( &self, f: impl FnOnce(&Handle<Cycle>) -> Handle<Cycle> ) -> Self

Update the exterior of the region

fn add_interiors( &self, interiors: impl IntoIterator<Item = Handle<Cycle>> ) -> Self

Add the provides interiors to the region

impl Validate for Region

fn validate_with_config( &self, _: &ValidationConfig, _: &mut Vec<ValidationError> )

Validate the object

fn validate_and_return_first_error(&self) -> Result<(), ValidationError>

Validate the object using default config and return on first error

fn validate(&self, errors: &mut Vec<ValidationError>)

Validate the object using default configuration

impl Eq for Region

impl StructuralEq for Region

impl StructuralPartialEq for Region