Skip to main content

State

Struct State 

Source
pub struct State {
    pub q: DVec,
    pub v: DVec,
    pub ctrl: DVec,
    pub time: f64,
    pub body_xform: Vec<SpatialTransform>,
    pub qfrc_external: DVec,
}
Expand description

Mutable simulation state.

Fields§

§q: DVec

Generalized positions (joint angles/displacements).

§v: DVec

Generalized velocities.

§ctrl: DVec

Control inputs.

If the model has actuators, entry i is the raw control of actuator i (clamped to its ctrlrange and scaled by its gear before reaching the dynamics — see Model::actuator_forces). If the model has no actuators, entries are raw per-DOF generalized forces.

§time: f64

Simulation time.

§body_xform: Vec<SpatialTransform>

Body-to-world transforms for each body.

§qfrc_external: DVec

External generalized forces (e.g., from contacts).

Implementations§

Source§

impl State

Source

pub fn new(nq: usize, nv: usize, nbodies: usize) -> Self

Create a zero-initialized state for nq position DOFs and nv velocity DOFs.

Source

pub fn new_with_nu(nq: usize, nv: usize, nu: usize, nbodies: usize) -> Self

Create a zero-initialized state, sizing ctrl for nu actuators.

ctrl is sized max(nv, nu) so that both conventions (per-DOF forces for unactuated models, per-actuator controls otherwise) fit.

Source

pub fn kinetic_energy(&self, mass_matrix: &DMat) -> f64

Compute total kinetic energy given mass matrix. KE = 0.5 * v^T * M * v

Trait Implementations§

Source§

impl Clone for State

Source§

fn clone(&self) -> State

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for State

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for State

§

impl RefUnwindSafe for State

§

impl Send for State

§

impl Sync for State

§

impl Unpin for State

§

impl UnsafeUnpin for State

§

impl UnwindSafe for State

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> 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.