Struct rapier3d_f64::dynamics::JointAxesMask
source · pub struct JointAxesMask { /* private fields */ }
Expand description
A bit mask identifying multiple degrees of freedom of a joint.
Implementations§
source§impl JointAxesMask
impl JointAxesMask
sourcepub const LOCKED_REVOLUTE_AXES: Self = _
pub const LOCKED_REVOLUTE_AXES: Self = _
The set of degrees of freedom locked by a revolute joint.
sourcepub const LOCKED_PRISMATIC_AXES: Self = _
pub const LOCKED_PRISMATIC_AXES: Self = _
The set of degrees of freedom locked by a prismatic joint.
sourcepub const LOCKED_FIXED_AXES: Self = _
pub const LOCKED_FIXED_AXES: Self = _
The set of degrees of freedom locked by a fixed joint.
sourcepub const LOCKED_SPHERICAL_AXES: Self = _
pub const LOCKED_SPHERICAL_AXES: Self = _
The set of degrees of freedom locked by a spherical joint.
sourcepub const FREE_REVOLUTE_AXES: Self = _
pub const FREE_REVOLUTE_AXES: Self = _
The set of degrees of freedom left free by a revolute joint.
sourcepub const FREE_PRISMATIC_AXES: Self = _
pub const FREE_PRISMATIC_AXES: Self = _
The set of degrees of freedom left free by a prismatic joint.
sourcepub const FREE_FIXED_AXES: Self = _
pub const FREE_FIXED_AXES: Self = _
The set of degrees of freedom left free by a fixed joint.
sourcepub const FREE_SPHERICAL_AXES: Self = _
pub const FREE_SPHERICAL_AXES: Self = _
The set of degrees of freedom left free by a spherical joint.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
§Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for JointAxesMask
impl Binary for JointAxesMask
source§impl BitAnd for JointAxesMask
impl BitAnd for JointAxesMask
source§impl BitAndAssign for JointAxesMask
impl BitAndAssign for JointAxesMask
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for JointAxesMask
impl BitOr for JointAxesMask
source§fn bitor(self, other: JointAxesMask) -> Self
fn bitor(self, other: JointAxesMask) -> Self
Returns the union of the two sets of flags.
§type Output = JointAxesMask
type Output = JointAxesMask
|
operator.source§impl BitOrAssign for JointAxesMask
impl BitOrAssign for JointAxesMask
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for JointAxesMask
impl BitXor for JointAxesMask
source§impl BitXorAssign for JointAxesMask
impl BitXorAssign for JointAxesMask
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for JointAxesMask
impl Clone for JointAxesMask
source§fn clone(&self) -> JointAxesMask
fn clone(&self) -> JointAxesMask
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for JointAxesMask
impl Debug for JointAxesMask
source§impl Default for JointAxesMask
impl Default for JointAxesMask
source§impl<'de> Deserialize<'de> for JointAxesMask
impl<'de> Deserialize<'de> for JointAxesMask
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Extend<JointAxesMask> for JointAxesMask
impl Extend<JointAxesMask> for JointAxesMask
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<JointAxis> for JointAxesMask
impl From<JointAxis> for JointAxesMask
source§impl FromIterator<JointAxesMask> for JointAxesMask
impl FromIterator<JointAxesMask> for JointAxesMask
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for JointAxesMask
impl Hash for JointAxesMask
source§impl LowerHex for JointAxesMask
impl LowerHex for JointAxesMask
source§impl Not for JointAxesMask
impl Not for JointAxesMask
source§impl Octal for JointAxesMask
impl Octal for JointAxesMask
source§impl Ord for JointAxesMask
impl Ord for JointAxesMask
source§fn cmp(&self, other: &JointAxesMask) -> Ordering
fn cmp(&self, other: &JointAxesMask) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for JointAxesMask
impl PartialEq for JointAxesMask
source§fn eq(&self, other: &JointAxesMask) -> bool
fn eq(&self, other: &JointAxesMask) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for JointAxesMask
impl PartialOrd for JointAxesMask
source§fn partial_cmp(&self, other: &JointAxesMask) -> Option<Ordering>
fn partial_cmp(&self, other: &JointAxesMask) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for JointAxesMask
impl Serialize for JointAxesMask
source§impl Sub for JointAxesMask
impl Sub for JointAxesMask
source§impl SubAssign for JointAxesMask
impl SubAssign for JointAxesMask
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for JointAxesMask
impl UpperHex for JointAxesMask
impl Copy for JointAxesMask
impl Eq for JointAxesMask
impl StructuralPartialEq for JointAxesMask
Auto Trait Implementations§
impl Freeze for JointAxesMask
impl RefUnwindSafe for JointAxesMask
impl Send for JointAxesMask
impl Sync for JointAxesMask
impl Unpin for JointAxesMask
impl UnwindSafe for JointAxesMask
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.