Struct bevy_transform::components::Transform
source · pub struct Transform {
pub translation: Vec3,
pub rotation: Quat,
pub scale: Vec3,
}
Expand description
Describe the position of an entity. If the entity has a parent, the position is relative to its parent position.
- To place or move an entity, you should set its
Transform
. - To get the global transform of an entity, you should get its
GlobalTransform
. - To be displayed, an entity must have both a
Transform
and aGlobalTransform
.- You may use the
TransformBundle
to guarantee this.
- You may use the
Transform
and GlobalTransform
Transform
is the position of an entity relative to its parent position, or the reference
frame if it doesn’t have a Parent
.
GlobalTransform
is the position of an entity relative to the reference frame.
GlobalTransform
is updated from Transform
by systems in the system set
TransformPropagate
.
This system runs during PostUpdate
. If you
update the Transform
of an entity during this set or after, you will notice a 1 frame lag
before the GlobalTransform
is updated.
Examples
Fields§
§translation: Vec3
Position of the entity. In 2d, the last value of the Vec3
is used for z-ordering.
See the translations
example for usage.
rotation: Quat
Rotation of the entity.
See the 3d_rotation
example for usage.
scale: Vec3
Scale of the entity.
See the scale
example for usage.
Implementations§
source§impl Transform
impl Transform
sourcepub const IDENTITY: Self = _
pub const IDENTITY: Self = _
An identity Transform
with no translation, rotation, and a scale of 1 on all axes.
sourcepub const fn from_xyz(x: f32, y: f32, z: f32) -> Self
pub const fn from_xyz(x: f32, y: f32, z: f32) -> Self
Creates a new Transform
at the position (x, y, z)
. In 2d, the z
component
is used for z-ordering elements: higher z
-value will be in front of lower
z
-value.
sourcepub fn from_matrix(matrix: Mat4) -> Self
pub fn from_matrix(matrix: Mat4) -> Self
Extracts the translation, rotation, and scale from matrix
. It must be a 3d affine
transformation matrix.
sourcepub const fn from_translation(translation: Vec3) -> Self
pub const fn from_translation(translation: Vec3) -> Self
Creates a new Transform
, with translation
. Rotation will be 0 and scale 1 on
all axes.
sourcepub const fn from_rotation(rotation: Quat) -> Self
pub const fn from_rotation(rotation: Quat) -> Self
Creates a new Transform
, with rotation
. Translation will be 0 and scale 1 on
all axes.
sourcepub const fn from_scale(scale: Vec3) -> Self
pub const fn from_scale(scale: Vec3) -> Self
Creates a new Transform
, with scale
. Translation will be 0 and rotation 0 on
all axes.
sourcepub fn looking_at(self, target: Vec3, up: Vec3) -> Self
pub fn looking_at(self, target: Vec3, up: Vec3) -> Self
Returns this Transform
with a new rotation so that Transform::forward
points towards the target
position and Transform::up
points towards up
.
In some cases it’s not possible to construct a rotation. Another axis will be picked in those cases:
- if
target
is the same as the transform translation,Vec3::Z
is used instead - if
up
is zero,Vec3::Y
is used instead - if the resulting forward direction is parallel with
up
, an orthogonal vector is used as the “right” direction
sourcepub fn looking_to(self, direction: Vec3, up: Vec3) -> Self
pub fn looking_to(self, direction: Vec3, up: Vec3) -> Self
Returns this Transform
with a new rotation so that Transform::forward
points in the given direction
and Transform::up
points towards up
.
In some cases it’s not possible to construct a rotation. Another axis will be picked in those cases:
- if
direction
is zero,Vec3::Z
is used instead - if
up
is zero,Vec3::Y
is used instead - if
direction
is parallel withup
, an orthogonal vector is used as the “right” direction
sourcepub const fn with_translation(self, translation: Vec3) -> Self
pub const fn with_translation(self, translation: Vec3) -> Self
Returns this Transform
with a new translation.
sourcepub const fn with_rotation(self, rotation: Quat) -> Self
pub const fn with_rotation(self, rotation: Quat) -> Self
Returns this Transform
with a new rotation.
sourcepub const fn with_scale(self, scale: Vec3) -> Self
pub const fn with_scale(self, scale: Vec3) -> Self
Returns this Transform
with a new scale.
sourcepub fn compute_matrix(&self) -> Mat4
pub fn compute_matrix(&self) -> Mat4
Returns the 3d affine transformation matrix from this transforms translation, rotation, and scale.
sourcepub fn compute_affine(&self) -> Affine3A
pub fn compute_affine(&self) -> Affine3A
Returns the 3d affine transformation matrix from this transforms translation, rotation, and scale.
sourcepub fn left(&self) -> Vec3
pub fn left(&self) -> Vec3
Equivalent to -local_x()
sourcepub fn down(&self) -> Vec3
pub fn down(&self) -> Vec3
Equivalent to -local_y()
sourcepub fn forward(&self) -> Vec3
pub fn forward(&self) -> Vec3
Equivalent to -local_z()
sourcepub fn rotate(&mut self, rotation: Quat)
pub fn rotate(&mut self, rotation: Quat)
sourcepub fn rotate_axis(&mut self, axis: Vec3, angle: f32)
pub fn rotate_axis(&mut self, axis: Vec3, angle: f32)
sourcepub fn rotate_local(&mut self, rotation: Quat)
pub fn rotate_local(&mut self, rotation: Quat)
sourcepub fn rotate_local_axis(&mut self, axis: Vec3, angle: f32)
pub fn rotate_local_axis(&mut self, axis: Vec3, angle: f32)
Rotates this Transform
around its local axis
by angle
(in radians).
sourcepub fn rotate_local_x(&mut self, angle: f32)
pub fn rotate_local_x(&mut self, angle: f32)
Rotates this Transform
around its local X
axis by angle
(in radians).
sourcepub fn rotate_local_y(&mut self, angle: f32)
pub fn rotate_local_y(&mut self, angle: f32)
Rotates this Transform
around its local Y
axis by angle
(in radians).
sourcepub fn rotate_local_z(&mut self, angle: f32)
pub fn rotate_local_z(&mut self, angle: f32)
Rotates this Transform
around its local Z
axis by angle
(in radians).
sourcepub fn translate_around(&mut self, point: Vec3, rotation: Quat)
pub fn translate_around(&mut self, point: Vec3, rotation: Quat)
sourcepub fn rotate_around(&mut self, point: Vec3, rotation: Quat)
pub fn rotate_around(&mut self, point: Vec3, rotation: Quat)
sourcepub fn look_at(&mut self, target: Vec3, up: Vec3)
pub fn look_at(&mut self, target: Vec3, up: Vec3)
Rotates this Transform
so that Transform::forward
points towards the target
position,
and Transform::up
points towards up
.
In some cases it’s not possible to construct a rotation. Another axis will be picked in those cases:
- if
target
is the same as the transtorm translation,Vec3::Z
is used instead - if
up
is zero,Vec3::Y
is used instead - if the resulting forward direction is parallel with
up
, an orthogonal vector is used as the “right” direction
sourcepub fn look_to(&mut self, direction: Vec3, up: Vec3)
pub fn look_to(&mut self, direction: Vec3, up: Vec3)
Rotates this Transform
so that Transform::forward
points in the given direction
and Transform::up
points towards up
.
In some cases it’s not possible to construct a rotation. Another axis will be picked in those cases:
- if
direction
is zero,Vec3::NEG_Z
is used instead - if
up
is zero,Vec3::Y
is used instead - if
direction
is parallel withup
, an orthogonal vector is used as the “right” direction
sourcepub fn mul_transform(&self, transform: Transform) -> Self
pub fn mul_transform(&self, transform: Transform) -> Self
Multiplies self
with transform
component by component, returning the
resulting Transform
sourcepub fn transform_point(&self, point: Vec3) -> Vec3
pub fn transform_point(&self, point: Vec3) -> Vec3
Transforms the given point
, applying scale, rotation and translation.
If this Transform
has a parent, this will transform a point
that is
relative to the parent’s Transform
into one relative to this Transform
.
If this Transform
does not have a parent, this will transform a point
that is in global space into one relative to this Transform
.
If you want to transform a point
in global space to the local space of this Transform
,
consider using GlobalTransform::transform_point()
instead.
Trait Implementations§
source§impl Component for Transformwhere
Self: Send + Sync + 'static,
impl Component for Transformwhere Self: Send + Sync + 'static,
§type Storage = TableStorage
type Storage = TableStorage
TableStorage
or SparseStorage
.source§impl From<GlobalTransform> for Transform
impl From<GlobalTransform> for Transform
The transform is expected to be non-degenerate and without shearing, or the output will be invalid.
source§fn from(transform: GlobalTransform) -> Self
fn from(transform: GlobalTransform) -> Self
source§impl From<Transform> for GlobalTransform
impl From<Transform> for GlobalTransform
source§impl From<Transform> for TransformBundle
impl From<Transform> for TransformBundle
source§impl FromReflect for Transformwhere
Vec3: FromReflect,
Quat: FromReflect,
impl FromReflect for Transformwhere Vec3: FromReflect, Quat: FromReflect,
source§fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§impl GetTypeRegistration for Transformwhere
Vec3: FromReflect,
Quat: FromReflect,
impl GetTypeRegistration for Transformwhere Vec3: FromReflect, Quat: FromReflect,
source§impl Mul<Transform> for GlobalTransform
impl Mul<Transform> for GlobalTransform
source§impl PartialEq<Transform> for Transform
impl PartialEq<Transform> for Transform
source§impl Reflect for Transformwhere
Vec3: FromReflect,
Quat: FromReflect,
impl Reflect for Transformwhere Vec3: FromReflect, Quat: FromReflect,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl Struct for Transformwhere
Vec3: FromReflect,
Quat: FromReflect,
impl Struct for Transformwhere Vec3: FromReflect, Quat: FromReflect,
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
name
as a
&mut dyn Reflect
.source§fn field_at(&self, index: usize) -> Option<&dyn Reflect>
fn field_at(&self, index: usize) -> Option<&dyn Reflect>
index
as a
&dyn Reflect
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl TransformPoint for Transform
impl TransformPoint for Transform
source§impl TypePath for Transformwhere
Vec3: FromReflect,
Quat: FromReflect,
impl TypePath for Transformwhere Vec3: FromReflect, Quat: FromReflect,
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for Transformwhere
Vec3: FromReflect,
Quat: FromReflect,
impl Typed for Transformwhere Vec3: FromReflect, Quat: FromReflect,
impl Copy for Transform
impl StructuralPartialEq for Transform
Auto Trait Implementations§
impl RefUnwindSafe for Transform
impl Send for Transform
impl Sync for Transform
impl Unpin for Transform
impl UnwindSafe for Transform
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<C> Bundle for Cwhere
C: Component,
impl<C> Bundle for Cwhere C: Component,
fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )
unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> Cwhere F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a, Aligned>,
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
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
.§fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<C> DynamicBundle for Cwhere
C: Component,
impl<C> DynamicBundle for Cwhere C: Component,
fn get_components( self, func: &mut impl FnMut(StorageType, OwningPtr<'_, Aligned>) )
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given Worldsource§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere S: Struct,
source§impl<T> GetPath for Twhere
T: Reflect,
impl<T> GetPath for Twhere T: Reflect,
source§fn reflect_path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'r, 'p>( &'r self, path: &'p str ) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'r, 'p>( &'r mut self, path: &'p str ) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more