Struct amethyst_core::transform::components::Parent

pub struct Parent {
    pub entity: Entity,
}

Component for defining a parent entity.

The entity with this component has a parent, rather than is a parent.

If the parent entity contains a transform, then the child's transform will be applied relative to the parent's transform. For example, if a parent rotates 45 degrees around the Z axis, then the child's coordinate system will start out also rotated by 45 degrees around the Z axis.

If the parent entity has its own parent (and so on) then the transforms will all be applied in order from the oldest ancestor to the child.

Fields

entity: Entity

The parent entity

Methods

impl Parent

pub fn new(entity: Entity) -> Self

Constructs a new Parent.

Trait Implementations

impl Eq for Parent

impl Clone for Parent

fn clone(&self) -> Parent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Parent> for Parent

fn partial_cmp(&self, other: &Parent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Parent) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Parent) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Parent) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Parent) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<Parent> for Parent

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

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

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

This method tests for !=.

impl Ord for Parent

fn cmp(&self, other: &Parent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Debug for Parent

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

Formats the value using the given formatter.

impl Component for Parent

type Storage = FlaggedStorage<Self, DenseVecStorage<Self>>

Associated storage type for this component.

impl Parent for Parent

fn parent_entity(&self) -> Entity

Retrieves the parent Entity.