Struct InputRelation 

pub struct InputRelation {
    pub contains: bool,
    pub strict_contains: bool,
    pub contained: bool,
    pub strict_contained: bool,
    pub intersect: bool,
    pub disjoint: bool,
    pub early_exit: bool,
}

This struct is used to query the specific relationship between two shapes. By default nothing is enabled and no relation are computed.

The difference between the strict and normal version of contains and contained are when dealing with multi-shape. Contains would return true if only one point of a multi-poins is contained in the first shape. The strict contains only returns true if all the points of the multi-points are contained in the first shape. It’s also way more expensive to compute.

Fields

contains: bool

Return true if any part on the first shape contains any part of the second shape.

strict_contains: bool

Return true if any parts of the first shape contains all parts of the second shape.

contained: bool

Return true if any part of the first shape is contained in any part of the second shape.

strict_contained: bool

Return true if all parts of the first shape are contained in any part of the second shape.

intersect: bool

Return true if all parts of the first shape are contained in any part of the second shape.

disjoint: bool

Return true if there is no relation between both shapes.

early_exit: bool

If set to true the relation algorithm will stop as soon as possible after filling any value. For example if you are asking if a shape contains, is contained or intersect with another but don’t really care about which of these happened you can set early_exit to true and the relation algorithm will be able to exit directly after finding the first intersection for example.

Implementations

impl InputRelation

pub fn all() -> Self

Set everything to true and cannot early exit.

pub fn any() -> Self

Set everything to true but can early exit.

pub fn swap_contains_relation(self) -> Self

Swap the contains and contained relation.

pub fn none() -> Self

Set everything to false, same as Self::default.

pub fn to_false(self) -> OutputRelation

Generates an OutputRelation where every true field of Self are set to Some(false).

pub fn to_true(self) -> OutputRelation

Generates an OutputRelation where every true field of Self are set to Some(true).

pub fn strip_strict(self) -> Self

Remove the strict contains and contained.

pub fn strip_strict_contained(self) -> Self

Remove only the strict contained.

pub fn strip_disjoint(self) -> Self

Remove disjoint.

Trait Implementations

impl Clone for InputRelation

fn clone(&self) -> InputRelation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputRelation

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

Formats the value using the given formatter.

impl Default for InputRelation

fn default() -> InputRelation

Returns the “default value” for a type.

impl PartialEq for InputRelation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for InputRelation

impl Eq for InputRelation

impl StructuralPartialEq for InputRelation