pub struct GimbalDeviceFlags(/* private fields */);
common
only.Expand description
Flags for gimbal device (lower level) operation.
Implementations§
Source§impl GimbalDeviceFlags
impl GimbalDeviceFlags
Sourcepub const GIMBAL_DEVICE_FLAGS_RETRACT: Self
pub const GIMBAL_DEVICE_FLAGS_RETRACT: Self
Set to retracted safe position (no stabilization), takes precedence over all other flags.
Sourcepub const GIMBAL_DEVICE_FLAGS_NEUTRAL: Self
pub const GIMBAL_DEVICE_FLAGS_NEUTRAL: Self
Set to neutral/default position, taking precedence over all other flags except RETRACT. Neutral is commonly forward-facing and horizontal (roll=pitch=yaw=0) but may be any orientation.
Sourcepub const GIMBAL_DEVICE_FLAGS_ROLL_LOCK: Self
pub const GIMBAL_DEVICE_FLAGS_ROLL_LOCK: Self
Lock roll angle to absolute angle relative to horizon (not relative to vehicle). This is generally the default with a stabilizing gimbal.
Sourcepub const GIMBAL_DEVICE_FLAGS_PITCH_LOCK: Self
pub const GIMBAL_DEVICE_FLAGS_PITCH_LOCK: Self
Lock pitch angle to absolute angle relative to horizon (not relative to vehicle). This is generally the default with a stabilizing gimbal.
Sourcepub const GIMBAL_DEVICE_FLAGS_YAW_LOCK: Self
pub const GIMBAL_DEVICE_FLAGS_YAW_LOCK: Self
Lock yaw angle to absolute angle relative to North (not relative to vehicle). If this flag is set, the yaw angle and z component of angular velocity are relative to North (earth frame, x-axis pointing North), else they are relative to the vehicle heading (vehicle frame, earth frame rotated so that the x-axis is pointing forward).
Sourcepub const GIMBAL_DEVICE_FLAGS_YAW_IN_VEHICLE_FRAME: Self
pub const GIMBAL_DEVICE_FLAGS_YAW_IN_VEHICLE_FRAME: Self
Yaw angle and z component of angular velocity are relative to the vehicle heading (vehicle frame, earth frame rotated such that the x-axis is pointing forward).
Sourcepub const GIMBAL_DEVICE_FLAGS_YAW_IN_EARTH_FRAME: Self
pub const GIMBAL_DEVICE_FLAGS_YAW_IN_EARTH_FRAME: Self
Yaw angle and z component of angular velocity are relative to North (earth frame, x-axis is pointing North).
Sourcepub const GIMBAL_DEVICE_FLAGS_ACCEPTS_YAW_IN_EARTH_FRAME: Self
pub const GIMBAL_DEVICE_FLAGS_ACCEPTS_YAW_IN_EARTH_FRAME: Self
Gimbal device can accept yaw angle inputs relative to North (earth frame). This flag is only for reporting (attempts to set this flag are ignored).
Sourcepub const GIMBAL_DEVICE_FLAGS_RC_EXCLUSIVE: Self
pub const GIMBAL_DEVICE_FLAGS_RC_EXCLUSIVE: Self
The gimbal orientation is set exclusively by the RC signals feed to the gimbal’s radio control inputs. MAVLink messages for setting the gimbal orientation (GIMBAL_DEVICE_SET_ATTITUDE) are ignored.
Sourcepub const GIMBAL_DEVICE_FLAGS_RC_MIXED: Self
pub const GIMBAL_DEVICE_FLAGS_RC_MIXED: Self
The gimbal orientation is determined by combining/mixing the RC signals feed to the gimbal’s radio control inputs and the MAVLink messages for setting the gimbal orientation (GIMBAL_DEVICE_SET_ATTITUDE). How these two controls are combined or mixed is not defined by the protocol but is up to the implementation.
Source§impl GimbalDeviceFlags
impl GimbalDeviceFlags
Sourcepub const fn bits(&self) -> u16
pub const fn bits(&self) -> u16
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl GimbalDeviceFlags
impl GimbalDeviceFlags
Sourcepub const fn iter(&self) -> Iter<GimbalDeviceFlags>
pub const fn iter(&self) -> Iter<GimbalDeviceFlags>
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.
Sourcepub const fn iter_names(&self) -> IterNames<GimbalDeviceFlags>
pub const fn iter_names(&self) -> IterNames<GimbalDeviceFlags>
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§
Source§impl Binary for GimbalDeviceFlags
impl Binary for GimbalDeviceFlags
Source§impl BitAnd for GimbalDeviceFlags
impl BitAnd for GimbalDeviceFlags
Source§impl BitAndAssign for GimbalDeviceFlags
impl BitAndAssign for GimbalDeviceFlags
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOr for GimbalDeviceFlags
impl BitOr for GimbalDeviceFlags
Source§fn bitor(self, other: GimbalDeviceFlags) -> Self
fn bitor(self, other: GimbalDeviceFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
Source§type Output = GimbalDeviceFlags
type Output = GimbalDeviceFlags
|
operator.Source§impl BitOrAssign for GimbalDeviceFlags
impl BitOrAssign for GimbalDeviceFlags
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXor for GimbalDeviceFlags
impl BitXor for GimbalDeviceFlags
Source§impl BitXorAssign for GimbalDeviceFlags
impl BitXorAssign for GimbalDeviceFlags
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Clone for GimbalDeviceFlags
impl Clone for GimbalDeviceFlags
Source§fn clone(&self) -> GimbalDeviceFlags
fn clone(&self) -> GimbalDeviceFlags
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GimbalDeviceFlags
impl Debug for GimbalDeviceFlags
Source§impl Default for GimbalDeviceFlags
impl Default for GimbalDeviceFlags
Source§impl<'de> Deserialize<'de> for GimbalDeviceFlags
impl<'de> Deserialize<'de> for GimbalDeviceFlags
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<GimbalDeviceFlags> for GimbalDeviceFlags
impl Extend<GimbalDeviceFlags> for GimbalDeviceFlags
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
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 Flags for GimbalDeviceFlags
impl Flags for GimbalDeviceFlags
Source§const FLAGS: &'static [Flag<GimbalDeviceFlags>]
const FLAGS: &'static [Flag<GimbalDeviceFlags>]
Source§fn from_bits_retain(bits: u16) -> GimbalDeviceFlags
fn from_bits_retain(bits: u16) -> GimbalDeviceFlags
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.Source§impl FromIterator<GimbalDeviceFlags> for GimbalDeviceFlags
impl FromIterator<GimbalDeviceFlags> for GimbalDeviceFlags
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
Source§impl IntoIterator for GimbalDeviceFlags
impl IntoIterator for GimbalDeviceFlags
Source§impl LowerHex for GimbalDeviceFlags
impl LowerHex for GimbalDeviceFlags
Source§impl Not for GimbalDeviceFlags
impl Not for GimbalDeviceFlags
Source§impl Octal for GimbalDeviceFlags
impl Octal for GimbalDeviceFlags
Source§impl PartialEq for GimbalDeviceFlags
impl PartialEq for GimbalDeviceFlags
Source§impl PublicFlags for GimbalDeviceFlags
impl PublicFlags for GimbalDeviceFlags
Source§impl Serialize for GimbalDeviceFlags
impl Serialize for GimbalDeviceFlags
Source§impl Sub for GimbalDeviceFlags
impl Sub for GimbalDeviceFlags
Source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Source§type Output = GimbalDeviceFlags
type Output = GimbalDeviceFlags
-
operator.Source§impl SubAssign for GimbalDeviceFlags
impl SubAssign for GimbalDeviceFlags
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.