Skip to main content

ModelBuilder

Struct ModelBuilder 

Source
pub struct ModelBuilder { /* private fields */ }
Expand description

Builder for constructing models.

Implementations§

Source§

impl ModelBuilder

Source

pub fn new() -> ModelBuilder

Start building a new model.

Source

pub fn gravity( self, g: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, ) -> ModelBuilder

Set the gravity vector.

Source

pub fn dt(self, dt: f64) -> ModelBuilder

Set the timestep.

Source

pub fn add_revolute_body( self, name: &str, parent: i32, parent_to_joint: SpatialTransform, inertia: SpatialInertia, ) -> ModelBuilder

Add a body with a revolute joint attached to the given parent.

parent is the index of the parent body, or -1 for world. parent_to_joint is the transform from parent body frame to joint frame. inertia is the body’s spatial inertia in its own frame.

Source

pub fn add_prismatic_body( self, name: &str, parent: i32, parent_to_joint: SpatialTransform, axis: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, inertia: SpatialInertia, ) -> ModelBuilder

Add a body with a prismatic joint attached to the given parent.

Source

pub fn add_spherical_body( self, name: &str, parent: i32, parent_to_joint: SpatialTransform, inertia: SpatialInertia, ) -> ModelBuilder

Add a body with a spherical (ball) joint attached to the given parent.

Source

pub fn add_free_body( self, name: &str, parent: i32, parent_to_joint: SpatialTransform, inertia: SpatialInertia, ) -> ModelBuilder

Add a body with a free joint (6 DOF) attached to the given parent.

Source

pub fn add_fixed_body( self, name: &str, parent: i32, parent_to_joint: SpatialTransform, inertia: SpatialInertia, ) -> ModelBuilder

Add a body with a fixed joint (0 DOF) attached to the given parent.

Source

pub fn add_body( self, name: &str, parent: i32, joint: Joint, inertia: SpatialInertia, ) -> ModelBuilder

Add a generic joint and body.

Source

pub fn add_free_body_with_geometry( self, name: &str, parent: i32, parent_to_joint: SpatialTransform, inertia: SpatialInertia, geometry: Body, ) -> ModelBuilder

Add a free body with collision geometry (useful for dropping objects).

Source

pub fn build(self) -> Model

Build the model.

Trait Implementations§

Source§

impl Default for ModelBuilder

Source§

fn default() -> ModelBuilder

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

Auto Trait Implementations§

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,