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>> ) -> 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) -> &ObjectSet<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)

Trait Implementations

impl BoundingVerticesOfHalfEdge for Region

fn bounding_vertices_of_half_edge( &self, half_edge: &Handle<HalfEdge> ) -> Option<CurveBoundary<Vertex>>

Determine the bounding vertices of a half-edge

impl BuildRegion for Region

fn empty(core: &mut Core) -> Region

Build an empty region

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

Build a circle

fn polygon<P, Ps>(points: Ps, core: &mut Core) -> Region

where 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 AnyObject<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, core: &mut Core) -> Self::Inserted

Insert the object into its respective store

impl IsObject for Region

type BareObject = Region

The type of the bare object

impl Ord for Region

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

fn replace_curve( &self, original: &Handle<Curve>, replacement: Handle<Curve>, core: &mut Core ) -> ReplaceOutput<Self, Self::BareObject>

Replace the curve

impl ReplaceHalfEdge for Region

fn replace_half_edge<const N: usize>( &self, original: &Handle<HalfEdge>, replacements: [Handle<HalfEdge>; N], core: &mut Core ) -> ReplaceOutput<Self, Self::BareObject>

Replace the half-edge

impl ReplaceVertex for Region

fn replace_vertex( &self, original: &Handle<Vertex>, replacement: Handle<Vertex>, core: &mut Core ) -> ReplaceOutput<Self, Self::BareObject>

Replace the vertex

impl Reverse for Region

fn reverse(&self, core: &mut Core) -> Self

Reverse the direction/orientation of the object

impl ReverseCurveCoordinateSystems for Region

fn reverse_curve_coordinate_systems(&self, core: &mut Core) -> Self

Reverse the direction of the curve coordinate systems within an object

impl SweepRegion for Region

fn sweep_region( &self, surface: &Handle<Surface>, color: Option<Color>, path: impl Into<Vector<3>>, cache: &mut SweepCache, core: &mut Core ) -> SweptRegion

Sweep the Region

impl TransformObject for Region

fn transform_with_cache( &self, transform: &Transform, core: &mut Core, cache: &mut TransformCache ) -> Self

Transform the object using the provided cache

fn transform(&self, transform: &Transform, core: &mut Core) -> Self

Transform the object

fn translate(&self, offset: impl Into<Vector<3>>, core: &mut Core) -> Self

Translate the object

fn rotate(&self, axis_angle: impl Into<Vector<3>>, core: &mut Core) -> Self

Rotate the object

impl UpdateRegion for Region

fn update_exterior<T>( &self, update: impl FnOnce(&Handle<Cycle>, &mut Core) -> T, core: &mut Core ) -> Self

where T: Insert<Inserted = Handle<Cycle>>,

Update the exterior of the region

fn add_interiors<T>( &self, interiors: impl IntoIterator<Item = T>, core: &mut Core ) -> Self

where T: Insert<Inserted = Handle<Cycle>>,

Add the provided interiors to the region

fn update_interior<T, R>( &self, handle: &Handle<Cycle>, update: impl FnOnce(&Handle<Cycle>, &mut Core) -> R, core: &mut Core ) -> Self

where T: Insert<Inserted = Handle<Cycle>>, R: IntoIterator<Item = T>,

Update an interior cycle of the region

impl Validate for Region

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

Validate the object

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

Validate the object using default config and return on first error

impl Eq for Region

impl StructuralPartialEq for Region