Struct Parent 

pub struct Parent { /* private fields */ }

Component indicating the parent entity of this entity.

When an entity has a Parent component, its transform (if any) is considered to be in the parent’s local coordinate space. The hierarchy propagation system will compute the global transform by combining the parent’s global transform with this entity’s local transform.

Memory Layout

Parent (8 bytes total):
┌────────────────┬────────────────┐
│  index (u32)   │ generation(u32)│  <- Entity
└────────────────┴────────────────┘

Example

use goud_engine::ecs::Entity;
use goud_engine::ecs::components::Parent;

let parent_entity = Entity::new(0, 1);
let parent_component = Parent::new(parent_entity);

assert_eq!(parent_component.get(), parent_entity);

Implementations

impl Parent

pub const fn new(parent: Entity) -> Parent

Creates a new Parent component pointing to the given entity.

Arguments

• parent - The entity that should be this entity’s parent

Example

use goud_engine::ecs::Entity;
use goud_engine::ecs::components::Parent;

let parent_entity = Entity::new(42, 1);
let parent = Parent::new(parent_entity);

pub const fn get(&self) -> Entity

Returns the parent entity.

Example

use goud_engine::ecs::Entity;
use goud_engine::ecs::components::Parent;

let parent_entity = Entity::new(10, 2);
let parent = Parent::new(parent_entity);

assert_eq!(parent.get(), parent_entity);

pub fn set(&mut self, parent: Entity)

Sets the parent entity.

This allows changing the parent without removing and re-adding the component.

Arguments

• parent - The new parent entity

Example

use goud_engine::ecs::Entity;
use goud_engine::ecs::components::Parent;

let mut parent = Parent::new(Entity::new(0, 1));
parent.set(Entity::new(5, 1));

assert_eq!(parent.get(), Entity::new(5, 1));

Trait Implementations

impl Clone for Parent

fn clone(&self) -> Parent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parent

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

Formats the value using the given formatter.

impl Default for Parent

fn default() -> Parent

Returns a Parent with PLACEHOLDER entity.

This is primarily for initialization purposes. A valid parent should be set before the entity is used in a hierarchy.

impl<'de> Deserialize<'de> for Parent

fn deserialize<__D>( __deserializer: __D, ) -> Result<Parent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Parent

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

Formats the value using the given formatter.

impl From<Entity> for Parent

fn from(entity: Entity) -> Parent

Converts to this type from the input type.

impl From<Parent> for Entity

fn from(parent: Parent) -> Entity

Converts to this type from the input type.

impl Hash for Parent

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Parent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Parent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Component for Parent

impl Copy for Parent

impl Eq for Parent

impl StructuralPartialEq for Parent