Struct ark_api::world::Transform

pub struct Transform { /* private fields */ }

Transform component.

Use to move and rotate entities (without physics).

Implementations

impl Transform

pub fn position(&self) -> ValueAccessorReadWriteAnimate<Vec3>

Returns a ValueAccessor for the local position of the entity.

Used to set/get/animate the position. Moves the entity to this position. If physics (non-kinematic) are enabled, it’s recommended to use forces instead of explicitly moving the entity.

pub fn rotation(&self) -> ValueAccessorReadWriteAnimate<Quat>

Returns a ValueAccessor for the local rotation of the entity.

Used to set/get/animate the rotation (in quaternion format).

If physics (non-kinematic) are enabled, it’s recommended to use forces/torques instead of explicitly rotating the entity.

pub fn scale(&self) -> ValueAccessorReadWriteAnimate<f32>

Returns a ValueAccessor for the local scale of the entity.

Used to set/get/animate the scale. Scale animation is not recommended for entities with physics enabled.

NOTE: scale values must be greater than 0.0

pub fn parent(&self) -> ValueAccessorReadWrite<Entity>

Sets/gets the parent of the entity in the transform hierarchy.

Does not work for dynamic physics. If you change an object to use dynamic physics, the parent will be removed. Works for kinematic physics objects though.

pub fn world_position(&self) -> ValueAccessorReadWriteAnimate<Vec3>

Returns a ValueAccessor for the world position of the entity.

Used to get the current world position.

pub fn world_rotation(&self) -> ValueAccessorReadWriteAnimate<Quat>

Returns a ValueAccessor for the world rotation of the entity.

Used to get the current rotation (in quaternion format).

pub fn world_scale(&self) -> ValueAccessorReadWriteAnimate<f32>

Returns a ValueAccessor for the world scale of the entity.

Used to get the scale. Will be the scale of the last frame.

pub fn entity_to_parent(&self) -> Conformal3

Returns the entity-to-parent transform as a Conformal3.

pub fn set_entity_to_parent(&self, entity_to_parent: &Conformal3)

Set the entity-to-parent transform.

pub fn parent_to_entity(&self) -> Conformal3

Returns the parent-to-entity transform as a Conformal3.

pub fn set_parent_to_entity(&self, parent_to_entity: &Conformal3)

Set the parent-to-entity transform from a Conformal3.

pub fn entity_to_world(&self) -> Conformal3

Returns the entity-to-world transform as a decomposed Conformal3 (translation, rotation, uniform scale).

pub fn set_entity_to_world(&self, entity_to_world: &Conformal3)

Sets the entity-to-world transform from a Conformal3 (translation, rotation, uniform scale).

pub fn world_to_entity(&self) -> Conformal3

Returns the world-to-entity transform as an Conformal3.

pub fn set_world_to_entity(&self, world_to_entity: &Conformal3)

Set the world-to-entity transform.

impl Transform

pub fn children(&self) -> Vec<Entity>

Retrieves all the direct transform children of this entity

pub fn descendants(&self) -> Vec<Entity>

Retrieves all the transform descendants of this entity.

Trait Implementations

impl ComponentTrait for Transform

fn get_type() -> ComponentType

The type of the component, as a ComponentType enum.

fn from_entity(handle: Entity) -> Self

Adopt an Entity, wrap in a component struct.

fn try_from_entity(handle: Entity) -> Option<Self>

Try to adopt an Entity, wrapping it in a component struct.

fn entity(&self) -> Entity

Get the entity that the component belongs to.

impl Debug for Transform

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

Formats the value using the given formatter.