Struct heron_core::Velocity

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

Component that defines the linear and angular velocity.

It must be inserted on the same entity of a RigidBody

This component can be used for controlling and reading the velocity of the rigid body.

Example

fn spawn(mut commands: Commands) {
    commands.spawn_bundle(todo!("Spawn your sprite/mesh, incl. at least a GlobalTransform"))
        .insert(CollisionShape::Sphere { radius: 1.0 })
        .insert(
            Velocity::from_linear(Vec3::X * 10.0)
                .with_angular(AxisAngle::new(Vec3::Z, 0.5 * PI))
        );
}

Fields

linear: Vec3

Linear velocity in units-per-second on each axis

The unit is your game unit, be it meter, pixel or anything else

angular: AxisAngle

Angular velocity in radians-per-second around an axis

Implementations

impl Velocity

pub fn from_linear(linear: Vec3) -> Self

Returns a linear velocity from a vector

pub fn from_angular(angular: AxisAngle) -> Self

Returns an angular velocity from a vector

pub fn with_linear(self, linear: Vec3) -> Self

Returns a new version with the given linear velocity

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.

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

Performs copy-assignment from source.

impl Component for Velocitywhere
    Self: Send + Sync + 'static,

type Storage = TableStorage

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

Converts to this type from the input type.

impl From<Quat> for Velocity

fn from(quat: Quat) -> Self

Converts to this type from the input type.

impl From<Vec2> for Velocity

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec3> for Velocity

fn from(linear: Vec3) -> Self

Converts to this type from the input type.

impl From<Velocity> for AxisAngle

fn from(_: Velocity) -> Self

Converts to this type from the input type.

impl From<Velocity> for Quat

fn from(_: Velocity) -> Self

Converts to this type from the input type.

impl From<Velocity> for Vec3

fn from(_: Velocity) -> Self

Converts to this type from the input type.

impl GetTypeRegistration for Velocity

fn get_type_registration() -> TypeRegistration

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for Velocity

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the [TypeInfo] of the underlying type.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl Struct for Velocity

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the struct’s fields.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl Typed for Velocity

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Velocity

impl StructuralPartialEq for Velocity