Struct let_engine::Object

pub struct Object {
    pub transform: Transform,
    pub appearance: Appearance,
    /* private fields */
}

Object to be rendered on the screen and get the physics processed of.

Fields

transform: Transform

appearance: Appearance

Implementations

impl Object

New

pub fn new() -> Self

Returns a default object

pub fn init(&mut self, layer: &Layer)

Initializes the object into a layer.

pub fn init_with_parent( &mut self, layer: &Layer, parent: &Object ) -> Result<(), ObjectError>

Initializes the object into a layer with a parent object.

pub fn init_with_optional_parent( &mut self, layer: &Layer, parent: Option<&Object> ) -> Result<(), ObjectError>

Initializes the object into a layer with an optional parent object.

pub fn remove(&mut self) -> Result<(), ObjectError>

Removes the object from it’s layer.

impl Object

Setters

pub fn set_isometry(&mut self, position: Vec2, rotation: f32)

Sets the position and rotation of an object.

pub fn public_transform(&self) -> Transform

Returns the public position where the object is going to be rendered.

pub fn appearance(&self) -> &Appearance

Returns a reference to the appearance of the object.

pub fn id(&self) -> usize

Returns the identification number of the object specific the layer it is inside right now.

Returns 0 in case it is not initialized to a layer yet.

pub fn update(&mut self) -> Result<(), ObjectError>

Updates the object to match the object information located inside the system of the layer. Useful when having physics.

pub fn sync(&mut self) -> Result<(), ObjectError>

Updates the object inside the layer system to match with this one. Useful when doing anything to the object and submitting it with this function.

pub fn collider(&self) -> Option<&Collider>

Returns the collider of the object in case it has one.

pub fn set_collider(&mut self, collider: Option<Collider>)

Sets the collider of the object.

pub fn collider_mut(&mut self) -> Option<&mut Collider>

Returns a mutable reference to the collider.

pub fn rigid_body(&self) -> Option<&RigidBody>

Returns the rigid bodyh of the object in case it has one.

pub fn set_rigid_body(&mut self, rigid_body: Option<RigidBody>)

Sets the rigid body of the object.

pub fn rigid_body_mut(&mut self) -> Option<&mut RigidBody>

Returns a mutable reference to the rigid body.

pub fn local_collider_position(&self) -> Vec2

Returns the local position of the collider.

pub fn set_local_collider_position(&mut self, pos: Vec2)

Sets the local position of the collider of this object in case it has one.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Object

fn default() -> Object

Returns the “default value” for a type.