Struct specs_physics::bodies::PhysicsBodyBuilder

pub struct PhysicsBodyBuilder<N: RealField> { /* fields omitted */ }

The PhysicsBodyBuilder implements the builder pattern for PhysicsBodys and is the recommended way of instantiating and customising new PhysicsBody instances.

Example

use specs_physics::{
    nalgebra::{Matrix3, Point3},
    nphysics::{algebra::Velocity3, object::BodyStatus},
    PhysicsBodyBuilder,
};

let physics_body = PhysicsBodyBuilder::from(BodyStatus::Dynamic)
    .gravity_enabled(true)
    .velocity(Velocity3::linear(1.0, 1.0, 1.0))
    .angular_inertia(Matrix3::from_diagonal_element(3.0))
    .mass(1.3)
    .local_center_of_mass(Point3::new(0.0, 0.0, 0.0))
    .build();

Methods

impl<N: RealField> PhysicsBodyBuilder<N>

pub fn gravity_enabled(self, gravity_enabled: bool) -> Self

Sets the gravity_enabled value of the PhysicsBodyBuilder.

pub fn velocity(self, velocity: Velocity3<N>) -> Self

pub fn angular_inertia(self, angular_inertia: Matrix3<N>) -> Self

Sets the angular_inertia value of the PhysicsBodyBuilder.

pub fn mass(self, mass: N) -> Self

Sets the mass value of the PhysicsBodyBuilder.

pub fn local_center_of_mass(self, local_center_of_mass: Point3<N>) -> Self

Sets the local_center_of_mass value of the PhysicsBodyBuilder.

pub fn build(self) -> PhysicsBody<N>

Builds the PhysicsBody from the values set in the PhysicsBodyBuilder instance.

Trait Implementations

impl<N: RealField> From<BodyStatus> for PhysicsBodyBuilder<N>

fn from(body_status: BodyStatus) -> Self

Creates a new PhysicsBodyBuilder from the given BodyStatus. This also populates the PhysicsBody with sane defaults.