Struct System

Source
pub struct System<INTG: Integrator> { /* private fields */ }
Expand description

A system representing the computational model for the simulation.

There are three categories of entities that are found in the system (model):

  • Objects – Static, Dynamic, Nodetect
  • Forces – Gravity
  • Constraints – ‘Planar’, ‘Penetration’ (TODO)

Implementations§

Source§

impl<INTG: Integrator> System<INTG>

Source

pub fn new() -> Self
where INTG: Default,

Source

pub fn step(&self) -> u64

Source

pub fn objects_dynamic(&self) -> &VecMap<Dynamic>

Source

pub fn objects_nodetect(&self) -> &VecMap<Nodetect>

Source

pub fn objects_static(&self) -> &VecMap<Static>

Source

pub fn get_object(&self, id: Id) -> VariantRef<'_>

Source

pub fn segment_query( &self, segment: Segment3<f64>, ignore_list: &[Id], ) -> Vec<(f64, Point3<f64>, Id)>

Source

pub fn handle_event(&mut self, input: Input) -> Vec<Output>

Input event handling.

  • CreateObject – if an object is found to be in non-colliding contact with any other objects, those contacts will be registered with the collision system as persistent contacts for the upcoming step
  • DestroyObject
  • SetGravity
  • ClearGravity
  • Step – advance the simulation by a single timestep:
    1. Derivative evaluation: forces are accumulated and acceleration computed

    2. Velocities are integrated

    3. Velocity constraints are solved

    4. Positions are integrated using the new velocity (semi-implicit Euler)

    5. Position constraints are solved

    6. Collision detects and resolves collisions in the normalized sub-timestep [0.0-1.0).

      Note that colliding contacts detected at t==1.0 will not produce a collision response event (the next step will detect and resolve this collision), however resting or separating contacts detected at t==1.0 will be registered as a persistent contact for the next simulation step.

Source

pub fn new_object_key(&self, kind: Kind) -> Option<Key>

Returns None if object container is full

Source

pub fn contacts(&self) -> Vec<Vec<(Id, Id, Contact)>>

Trait Implementations§

Source§

impl<INTG: Clone + Integrator> Clone for System<INTG>

Source§

fn clone(&self) -> System<INTG>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<INTG: Debug + Integrator> Debug for System<INTG>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<INTG: Default + Integrator> Default for System<INTG>

Source§

fn default() -> System<INTG>

Returns the “default value” for a type. Read more
Source§

impl<'de, INTG: Integrator> Deserialize<'de> for System<INTG>

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<INTG: Integrator> Serialize for System<INTG>

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<INTG> Freeze for System<INTG>

§

impl<INTG> RefUnwindSafe for System<INTG>
where INTG: RefUnwindSafe,

§

impl<INTG> Send for System<INTG>
where INTG: Send,

§

impl<INTG> Sync for System<INTG>
where INTG: Sync,

§

impl<INTG> Unpin for System<INTG>
where INTG: Unpin,

§

impl<INTG> UnwindSafe for System<INTG>
where INTG: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> MaybeSerDes for T