Struct heron_core::Velocity

pub struct Velocity {
    pub linear: Vec3,
    pub angular: AxisAngle,
}

Component that defines the linear and angular velocity.

The linear part is in "unit" per second on each axis, represented as a Vec3. (The unit, being your game unit, be it pixel or anything else) The angular part is in radians per second around an axis, represented as a Quat

Example

fn spawn(commands: &mut Commands) {
    commands.spawn(todo!("Spawn your sprite/mesh, incl. at least a GlobalTransform"))
        .with(Body::Sphere { radius: 1.0 })
        .with(
            Velocity::from_linear(Vec3::unit_x() * 10.0)
                .with_angular(AxisAngle::new(Vec3::unit_z(), 0.5 * PI))
        );
}

Fields

linear: Vec3

Linear velocity in units-per-second on each axis

angular: AxisAngle

Angular velocity in radians-per-second around an axis

Implementations

impl Velocity

#[must_use]pub fn from_linear(linear: Vec3) -> Self

Returns a linear velocity from a vector

#[must_use]pub fn from_angular(angular: AxisAngle) -> Self

Returns an angular velocity from a vector

#[must_use]pub fn with_linear(self, linear: Vec3) -> Self

Returns a new version with the given linear velocity

#[must_use]pub fn with_angular(self, angular: AxisAngle) -> Self

Returns a new version with the given angular velocity

Trait Implementations

impl Clone for Velocity

fn clone(&self) -> Velocity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Velocity

impl Debug for Velocity

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

Formats the value using the given formatter.

impl Default for Velocity

fn default() -> Velocity

Returns the "default value" for a type.

impl From<AxisAngle> for Velocity

fn from(angular: AxisAngle) -> Self

Performs the conversion.

impl From<Quat> for Velocity

fn from(quat: Quat) -> Self

Performs the conversion.

impl From<Vec2> for Velocity

fn from(v: Vec2) -> Self

Performs the conversion.

impl From<Vec3> for Velocity

fn from(linear: Vec3) -> Self

Performs the conversion.

impl From<Velocity> for AxisAngle

fn from(Velocity { angular: angular, .. }: Velocity) -> Self

Performs the conversion.

impl NearZero for Velocity

fn is_near_zero(self) -> bool

impl PartialEq<Velocity> for Velocity

fn eq(&self, other: &Velocity) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Velocity) -> bool

This method tests for !=.

impl StructuralPartialEq for Velocity