Struct CompoundFlags 

pub struct CompoundFlags(/* private fields */);

Controls how a Compound is loaded.

Implementations

impl CompoundFlags

pub const FIX_INTERNAL_EDGES: CompoundFlags

If set, the edges (2D) or faces (3D) where two parts meet are treated as interior to the union, and contact normals are clamped to the surviving outline. This removes the ledge a body catches on when it slides across the cut between two parts of a convex decomposition.

This is the Compound counterpart of TriMeshFlags::FIX_INTERNAL_EDGES, and like it costs a one-off pass over the parts’ edges when set.

impl CompoundFlags

pub const fn empty() -> CompoundFlags

Get a flags value with all bits unset.

pub const fn all() -> CompoundFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<CompoundFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> CompoundFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> CompoundFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<CompoundFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: CompoundFlags) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: CompoundFlags) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: CompoundFlags)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: CompoundFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: CompoundFlags)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: CompoundFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: CompoundFlags) -> CompoundFlags

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: CompoundFlags) -> CompoundFlags

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: CompoundFlags) -> CompoundFlags

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: CompoundFlags) -> CompoundFlags

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> CompoundFlags

The bitwise negation (!) of the bits in self, truncating the result.

impl CompoundFlags

pub const fn iter(&self) -> Iter<CompoundFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<CompoundFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for CompoundFlags

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

Formats the value using the given formatter.

impl BitAnd for CompoundFlags

fn bitand(self, other: CompoundFlags) -> CompoundFlags

The bitwise and (&) of the bits in self and other.

type Output = CompoundFlags

The resulting type after applying the & operator.

impl BitAndAssign for CompoundFlags

fn bitand_assign(&mut self, other: CompoundFlags)

The bitwise and (&) of the bits in self and other.

impl BitOr for CompoundFlags

fn bitor(self, other: CompoundFlags) -> CompoundFlags

The bitwise or (|) of the bits in self and other.

type Output = CompoundFlags

The resulting type after applying the | operator.

impl BitOrAssign for CompoundFlags

fn bitor_assign(&mut self, other: CompoundFlags)

The bitwise or (|) of the bits in self and other.

impl BitXor for CompoundFlags

fn bitxor(self, other: CompoundFlags) -> CompoundFlags

The bitwise exclusive-or (^) of the bits in self and other.

type Output = CompoundFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for CompoundFlags

fn bitxor_assign(&mut self, other: CompoundFlags)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for CompoundFlags

fn clone(&self) -> CompoundFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompoundFlags

impl Debug for CompoundFlags

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

Formats the value using the given formatter.

impl Default for CompoundFlags

fn default() -> CompoundFlags

Returns the “default value” for a type.

impl Eq for CompoundFlags

impl Extend<CompoundFlags> for CompoundFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = CompoundFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for CompoundFlags

const FLAGS: &'static [Flag<CompoundFlags>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> CompoundFlags

Convert from a bits value exactly.

fn all_named() -> CompoundFlags

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<CompoundFlags> for CompoundFlags

fn from_iter<T>(iterator: T) -> CompoundFlags

where T: IntoIterator<Item = CompoundFlags>,

The bitwise or (|) of the bits in each flags value.

impl Hash for CompoundFlags

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

where __H: Hasher,

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 IntoIterator for CompoundFlags

type Item = CompoundFlags

The type of the elements being iterated over.

type IntoIter = Iter<CompoundFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <CompoundFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for CompoundFlags

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

Formats the value using the given formatter.

impl Not for CompoundFlags

fn not(self) -> CompoundFlags

The bitwise negation (!) of the bits in self, truncating the result.

type Output = CompoundFlags

The resulting type after applying the ! operator.

impl Octal for CompoundFlags

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

Formats the value using the given formatter.

impl Ord for CompoundFlags

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

Restrict a value to a certain interval.

impl PartialEq for CompoundFlags

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CompoundFlags

fn partial_cmp(&self, other: &CompoundFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for CompoundFlags

impl Sub for CompoundFlags

fn sub(self, other: CompoundFlags) -> CompoundFlags

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = CompoundFlags

The resulting type after applying the - operator.

impl SubAssign for CompoundFlags

fn sub_assign(&mut self, other: CompoundFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for CompoundFlags

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

Formats the value using the given formatter.