Struct bevy_xpbd_2d::components::Position

pub struct Position(pub Vector);

The global position of a rigid body or a collider.

Relation to Transform and GlobalTransform

Position is used for physics internally and kept in sync with Transform by the SyncPlugin. It rarely needs to be used directly in your own code, as Transform can still be used for almost everything. Using Position should only be required for managing positions in systems running in the SubstepSchedule. However, if you prefer, you can also use Position for everything.

The reasons why the engine uses a separate Position component can be found here.

Example

use bevy::prelude::*;
use bevy_xpbd_2d::prelude::*;

fn setup(mut commands: Commands) {
    commands.spawn((
        RigidBody::Dynamic,
         Position::from_xy(0.0, 20.0),
    ));
}

Tuple Fields

0: Vector

Implementations

impl Position

pub fn new(position: Vector) -> Self

Creates a Position component with the given global position.

pub fn from_xy(x: Scalar, y: Scalar) -> Self

Creates a Position component with the global position (x, y).

Methods from Deref<Target = Vector>

pub const ZERO: Vec2 = _

pub const ONE: Vec2 = _

pub const NEG_ONE: Vec2 = _

pub const MIN: Vec2 = _

pub const MAX: Vec2 = _

pub const NAN: Vec2 = _

pub const INFINITY: Vec2 = _

pub const NEG_INFINITY: Vec2 = _

pub const X: Vec2 = _

pub const Y: Vec2 = _

pub const NEG_X: Vec2 = _

pub const NEG_Y: Vec2 = _

pub const AXES: [Vec2; 2] = _

pub fn to_array(&self) -> [f32; 2]

[x, y]

pub fn as_dvec2(&self) -> DVec2

Casts all elements of self to f64.

pub fn as_ivec2(&self) -> IVec2

Casts all elements of self to i32.

pub fn as_uvec2(&self) -> UVec2

Casts all elements of self to u32.

pub fn as_i64vec2(&self) -> I64Vec2

Casts all elements of self to i64.

pub fn as_u64vec2(&self) -> U64Vec2

Casts all elements of self to u64.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Position

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl Deref for Position

type Target = Vec2

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Position

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Vec2> for Position

fn from(original: Vector) -> Position

Converts to this type from the input type.

impl FromReflect for Position

where Vector: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Position

where Vector: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl PartialEq for Position

fn eq(&self, other: &Position) -> 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 Position

where Vector: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the [TypeInfo] of the type represented by this value.

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 into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

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_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

fn type_name(&self) -> &str

👎Deprecated since 0.12.0: view the method documentation to find alternatives to this method.

Returns the type path of the underlying type.

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.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TupleStruct for Position

where Vector: FromReflect + TypePath,

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

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

fn field_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 field_len(&self) -> usize

Returns the number of fields in the tuple struct.

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

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

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a [DynamicTupleStruct].

impl TypePath for Position

where Vector: FromReflect + TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Position

where Vector: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Position

impl StructuralPartialEq for Position