Skip to main content

World

Struct World 

Source
pub struct World {
    pub model: Model,
    pub state: State,
    pub sensors: Vec<Sensor>,
    pub sensor_history: Vec<Vec<SensorOutput>>,
    pub tendons: Vec<Tendon>,
}
Expand description

A complete simulation world with sensors and actuators.

Fields§

§model: Model

The kinematic model.

§state: State

Current simulation state.

§sensors: Vec<Sensor>

Sensors attached to the world.

§sensor_history: Vec<Vec<SensorOutput>>

History of sensor readings (one vec per timestep).

§tendons: Vec<Tendon>

Tendons (cable actuators) in the world.

Implementations§

Source§

impl World

Source

pub fn new(model: Model) -> World

Create a new world from a model.

Source

pub fn with_state(model: Model, state: State) -> World

Create a new world with initial state.

Source

pub fn add_sensor(&mut self, sensor: Sensor)

Add a sensor to the world.

Source

pub fn add_tendon(&mut self, tendon: Tendon)

Add a tendon to the world.

Source

pub fn step<F>(&mut self, step_fn: F)
where F: FnOnce(&Model, &mut State),

Step the simulation forward using a custom step function.

The step_fn should advance the state by one timestep. Records sensor outputs after the step.

Source

pub fn latest_sensor_readings(&self) -> Option<&Vec<SensorOutput>>

Get the most recent sensor readings.

Source

pub fn clear_history(&mut self)

Clear sensor history.

Source

pub fn history_len(&self) -> usize

Get number of timesteps recorded.

Auto Trait Implementations§

§

impl Freeze for World

§

impl RefUnwindSafe for World

§

impl Send for World

§

impl Sync for World

§

impl Unpin for World

§

impl UnsafeUnpin for World

§

impl UnwindSafe for World

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> 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<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,