Struct bevy_rapier2d::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 X: JointAxesMask = _
pub const X: JointAxesMask = _
The translational degree of freedom along the local X axis of a joint.
sourcepub const Y: JointAxesMask = _
pub const Y: JointAxesMask = _
The translational degree of freedom along the local Y axis of a joint.
sourcepub const ANG_X: JointAxesMask = _
pub const ANG_X: JointAxesMask = _
The angular degree of freedom of a joint.
sourcepub const LOCKED_REVOLUTE_AXES: JointAxesMask = _
pub const LOCKED_REVOLUTE_AXES: JointAxesMask = _
The set of degrees of freedom locked by a revolute joint.
sourcepub const LOCKED_PRISMATIC_AXES: JointAxesMask = _
pub const LOCKED_PRISMATIC_AXES: JointAxesMask = _
The set of degrees of freedom locked by a prismatic joint.
sourcepub const LOCKED_FIXED_AXES: JointAxesMask = _
pub const LOCKED_FIXED_AXES: JointAxesMask = _
The set of degrees of freedom locked by a fixed joint.
sourcepub const FREE_REVOLUTE_AXES: JointAxesMask = _
pub const FREE_REVOLUTE_AXES: JointAxesMask = _
The set of degrees of freedom left free by a revolute joint.
sourcepub const FREE_PRISMATIC_AXES: JointAxesMask = _
pub const FREE_PRISMATIC_AXES: JointAxesMask = _
The set of degrees of freedom left free by a prismatic joint.
sourcepub const FREE_FIXED_AXES: JointAxesMask = _
pub const FREE_FIXED_AXES: JointAxesMask = _
The set of degrees of freedom left free by a fixed joint.
sourcepub const LIN_AXES: JointAxesMask = _
pub const LIN_AXES: JointAxesMask = _
The set of all translational degrees of freedom.
sourcepub const ANG_AXES: JointAxesMask = _
pub const ANG_AXES: JointAxesMask = _
The set of all angular degrees of freedom.
sourcepub const fn empty() -> JointAxesMask
pub const fn empty() -> JointAxesMask
Returns an empty set of flags.
sourcepub const fn all() -> JointAxesMask
pub const fn all() -> JointAxesMask
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<JointAxesMask>
pub const fn from_bits(bits: u8) -> Option<JointAxesMask>
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) -> JointAxesMask
pub const fn from_bits_truncate(bits: u8) -> JointAxesMask
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> JointAxesMask
pub const unsafe fn from_bits_unchecked(bits: u8) -> JointAxesMask
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: JointAxesMask) -> bool
pub const fn intersects(&self, other: JointAxesMask) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: JointAxesMask) -> bool
pub const fn contains(&self, other: JointAxesMask) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: JointAxesMask)
pub fn insert(&mut self, other: JointAxesMask)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: JointAxesMask)
pub fn remove(&mut self, other: JointAxesMask)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: JointAxesMask)
pub fn toggle(&mut self, other: JointAxesMask)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: JointAxesMask, value: bool)
pub fn set(&mut self, other: JointAxesMask, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: JointAxesMask) -> JointAxesMask
pub const fn intersection(self, other: JointAxesMask) -> JointAxesMask
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: JointAxesMask) -> JointAxesMask
pub const fn union(self, other: JointAxesMask) -> JointAxesMask
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: JointAxesMask) -> JointAxesMask
pub const fn difference(self, other: JointAxesMask) -> JointAxesMask
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: JointAxesMask) -> JointAxesMask
pub const fn symmetric_difference(self, other: JointAxesMask) -> JointAxesMask
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) -> JointAxesMask
pub const fn complement(self) -> JointAxesMask
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§fn bitand(self, other: JointAxesMask) -> JointAxesMask
fn bitand(self, other: JointAxesMask) -> JointAxesMask
Returns the intersection between the two sets of flags.
§type Output = JointAxesMask
type Output = JointAxesMask
&
operator.source§impl BitAndAssign for JointAxesMask
impl BitAndAssign for JointAxesMask
source§fn bitand_assign(&mut self, other: JointAxesMask)
fn bitand_assign(&mut self, other: JointAxesMask)
Disables all flags disabled in the set.
source§impl BitOr for JointAxesMask
impl BitOr for JointAxesMask
source§fn bitor(self, other: JointAxesMask) -> JointAxesMask
fn bitor(self, other: JointAxesMask) -> JointAxesMask
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: JointAxesMask)
fn bitor_assign(&mut self, other: JointAxesMask)
Adds the set of flags.
source§impl BitXor for JointAxesMask
impl BitXor for JointAxesMask
source§fn bitxor(self, other: JointAxesMask) -> JointAxesMask
fn bitxor(self, other: JointAxesMask) -> JointAxesMask
Returns the left flags, but with all the right flags toggled.
§type Output = JointAxesMask
type Output = JointAxesMask
^
operator.source§impl BitXorAssign for JointAxesMask
impl BitXorAssign for JointAxesMask
source§fn bitxor_assign(&mut self, other: JointAxesMask)
fn bitxor_assign(&mut self, other: JointAxesMask)
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§fn default() -> JointAxesMask
fn default() -> JointAxesMask
source§impl<'de> Deserialize<'de> for JointAxesMask
impl<'de> Deserialize<'de> for JointAxesMask
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<JointAxesMask, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<JointAxesMask, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl Extend<JointAxesMask> for JointAxesMask
impl Extend<JointAxesMask> for JointAxesMask
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = JointAxesMask>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = JointAxesMask>,
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§fn from(axis: JointAxis) -> JointAxesMask
fn from(axis: JointAxis) -> JointAxesMask
source§impl FromIterator<JointAxesMask> for JointAxesMask
impl FromIterator<JointAxesMask> for JointAxesMask
source§fn from_iter<T>(iterator: T) -> JointAxesMaskwhere
T: IntoIterator<Item = JointAxesMask>,
fn from_iter<T>(iterator: T) -> JointAxesMaskwhere
T: IntoIterator<Item = JointAxesMask>,
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§fn not(self) -> JointAxesMask
fn not(self) -> JointAxesMask
Returns the complement of this set of flags.
§type Output = JointAxesMask
type Output = JointAxesMask
!
operator.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§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
source§impl Sub for JointAxesMask
impl Sub for JointAxesMask
source§fn sub(self, other: JointAxesMask) -> JointAxesMask
fn sub(self, other: JointAxesMask) -> JointAxesMask
Returns the set difference of the two sets of flags.
§type Output = JointAxesMask
type Output = JointAxesMask
-
operator.source§impl SubAssign for JointAxesMask
impl SubAssign for JointAxesMask
source§fn sub_assign(&mut self, other: JointAxesMask)
fn sub_assign(&mut self, other: JointAxesMask)
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, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.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<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
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<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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<T> Serialize for T
impl<T> Serialize for T
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>
fn do_erased_serialize( &self, serializer: &mut dyn Serializer ) -> Result<(), ErrorImpl>
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.