Struct heron_core::Velocity

source · [−]

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

Expand description

Component that defines the linear and angular velocity.

It must be inserted on the same entity of a RigidBody

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(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

angular: AxisAngle

Angular velocity in radians-per-second around an axis

Implementations

source

impl Velocity

source

pub fn from_linear(linear: Vec3) -> Self

Returns a linear velocity from a vector

source

pub fn from_angular(angular: AxisAngle) -> Self

Returns an angular velocity from a vector

source

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

Returns a new version with the given linear velocity

source

pub fn with_angular(self, angular: AxisAngle) -> Self

Returns a new version with the given angular velocity

Trait Implementations

source

impl Clone for Velocity

source

fn clone(&self) -> Velocity

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Component for Velocity where
Self: Send + Sync + 'static,

type Storage = TableStorage

source

impl Debug for Velocity

source

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

Formats the value using the given formatter. Read more

source

impl Default for Velocity

source

fn default() -> Velocity

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

source

impl From<AxisAngle> for Velocity

source

fn from(angular: AxisAngle) -> Self

Performs the conversion.

source

impl From<Quat> for Velocity

source

fn from(quat: Quat) -> Self

Performs the conversion.

source

impl From<Vec2> for Velocity

source

fn from(v: Vec2) -> Self

Performs the conversion.

source

impl From<Vec3> for Velocity

source

fn from(linear: Vec3) -> Self

Performs the conversion.

source

impl From<Velocity> for Vec3

source

fn from(_: Velocity) -> Self

Performs the conversion.

source

impl From<Velocity> for AxisAngle

source

fn from(_: Velocity) -> Self

Performs the conversion.

source

impl From<Velocity> for Quat

source

fn from(_: Velocity) -> Self

Performs the conversion.

source

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

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

source

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

This method tests for !=.

source

impl Reflect for Velocity

source

fn type_name(&self) -> &str

source

fn any(&self) -> &dyn Any

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Returns a serializable value, if serialization is supported. Otherwise None will be returned. Read more

source

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

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned. Read more

source

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

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned. Read more

source

impl Struct for Velocity

source

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

source

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

source

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

source

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

source

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

source

fn field_len(&self) -> usize

source

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

source

fn clone_dynamic(&self) -> DynamicStruct

source

impl Copy for Velocity

source

impl StructuralPartialEq for Velocity

Auto Trait Implementations

impl RefUnwindSafe for Velocity

impl Send for Velocity

impl Sync for Velocity

impl Unpin for Velocity

impl UnwindSafe for Velocity

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromWorld for T where
T: Default,

pub fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World]

impl<S> GetField for S where
S: Struct,

pub fn get_field<T>(&self, name: &str) -> Option<&T> where
T: Reflect,

pub fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T> where
T: Reflect,

impl<T> GetPath for T where
T: Reflect,

pub fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

pub fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

fn get_path_mut<T>(
 &'r mut self,
 path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
 T: Reflect,

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub 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,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct heron_core::Velocity

Fields

Implementations

impl Velocity

pub fn from_linear(linear: Vec3) -> Self

pub fn from_angular(angular: AxisAngle) -> Self

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

pub fn with_angular(self, angular: AxisAngle) -> Self

Trait Implementations

impl Clone for Velocity

fn clone(&self) -> Velocity

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

impl Component for Velocity where Self: Send + Sync + 'static,

type Storage = TableStorage

impl Debug for Velocity

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

impl Default for Velocity

fn default() -> Velocity

impl From<AxisAngle> for Velocity

fn from(angular: AxisAngle) -> Self

impl From<Quat> for Velocity

fn from(quat: Quat) -> Self

impl From<Vec2> for Velocity

fn from(v: Vec2) -> Self

impl From<Vec3> for Velocity

fn from(linear: Vec3) -> Self

impl From<Velocity> for Vec3

fn from(_: Velocity) -> Self

impl From<Velocity> for AxisAngle

fn from(_: Velocity) -> Self

impl From<Velocity> for Quat

fn from(_: Velocity) -> Self

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

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

impl Reflect for Velocity

fn type_name(&self) -> &str

fn any(&self) -> &dyn Any

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

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

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

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

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

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

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

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

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

impl Struct for Velocity

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

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

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

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

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

fn field_len(&self) -> usize

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

fn clone_dynamic(&self) -> DynamicStruct

impl Copy for Velocity

impl StructuralPartialEq for Velocity

Auto Trait Implementations

impl RefUnwindSafe for Velocity

impl Send for Velocity

impl Sync for Velocity

impl Unpin for Velocity

impl UnwindSafe for Velocity

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl Component for Velocity where
Self: Send + Sync + 'static,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> FromWorld for T where
T: Default,

impl<S> GetField for S where
S: Struct,

pub fn get_field<T>(&self, name: &str) -> Option<&T> where
T: Reflect,

pub fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T> where
T: Reflect,

impl<T> GetPath for T where
T: Reflect,

pub fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

pub fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Resource for T where
T: 'static + Send + Sync,