Enum ark_api::world::CombineMode

#[non_exhaustive]
pub enum CombineMode {
    Average,
    Min,
    Multiply,
    Max,
}

How to combine a physical property of two interacting physics bodies to use in a calculation e.g. friction when sliding. Property values are between bounded (0.0..=1.0) NOTE: highest value combine mode specified on both bodies takes precedence

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Average

Use the average (mean) value of the two property values

Min

Use the smallest value of the two property values

Multiply

Use the multiplication of the two values property values

Max

Use the largest value of the two property values

Trait Implementations

impl CheckedBitPattern for CombineMode

type Bits = u32

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

fn is_valid_bit_pattern(bits: &<CombineMode as CheckedBitPattern>::Bits) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

impl Clone for CombineMode

fn clone(&self) -> CombineMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CombineMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CombineMode

fn deserialize<__D>( __deserializer: __D ) -> Result<CombineMode, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CombineMode

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 PartialEq<CombineMode> for CombineMode

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a_, C_> Readable<'a_, C_> for CombineModewhere C_: Context,

fn read_from<R_>( _reader_: &mut R_ ) -> Result<CombineMode, <C_ as Context>::Error>where R_: Reader<'a_, C_>,

fn minimum_bytes_needed() -> usize

fn read_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut( context: &mut C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>where S: Read,

fn read_from_stream_buffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>where S: Read,

fn read_from_file_with_ctx( context: C, path: impl AsRef<Path> ) -> Result<Self, <C as Context>::Error>

impl Serialize for CombineMode

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u32> for CombineMode

type Error = TryFromPrimitiveError<CombineMode>

The type returned in the event of a conversion error.

fn try_from( number: u32 ) -> Result<CombineMode, TryFromPrimitiveError<CombineMode>>

Performs the conversion.

impl TryFromPrimitive for CombineMode

type Primitive = u32

const NAME: &'static str = "CombineMode"

fn try_from_primitive( number: <CombineMode as TryFromPrimitive>::Primitive ) -> Result<CombineMode, TryFromPrimitiveError<CombineMode>>

impl ValueConverterTrait<CombineMode> for ValueConverter

fn into_value(v: CombineMode) -> Value

Wraps the passed-in value in a Value enum.

fn from_value(v: &Value) -> CombineMode

Extracts the value from a Value enum.

impl<C_> Writable<C_> for CombineModewhere C_: Context,

fn write_to<T_>(&self, _writer_: &mut T_) -> Result<(), <C_ as Context>::Error>where T_: Writer<C_> + ?Sized,

fn write_to_buffer_with_ctx( &self, context: C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut( &self, context: &mut C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx( &self, context: C ) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut( &self, context: &mut C ) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>( &self, context: C, stream: S ) -> Result<(), <C as Context>::Error>where S: Write,

fn write_to_file_with_ctx( &self, context: C, path: impl AsRef<Path> ) -> Result<(), <C as Context>::Error>

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

impl Copy for CombineMode

impl Eq for CombineMode

impl NoUninit for CombineMode

impl StructuralEq for CombineMode

impl StructuralPartialEq for CombineMode