Struct let_engine::objects::scenes::Layer

pub struct Layer { /* private fields */ }

A layer struct holding it’s own object hierarchy, camera and physics iteration.

Implementations

impl Layer

pub fn set_camera(&self, camera: &Object) -> Result<(), ObjectError>

Sets the camera of this layer.

pub fn camera_scaling(&self) -> CameraScaling

Returns the scaling of the camera settings.

pub fn zoom(&self) -> f32

Returns the zoom of the camera settings.

pub fn set_zoom(&self, zoom: f32)

pub fn set_camera_settings(&self, settings: CameraSettings)

Sets the camera settings.

pub fn camera_settings(&self) -> CameraSettings

Gets the camera settins.

pub fn side_to_world(&self, direction: Vec2, dimensions: Vec2) -> Vec2

Returns the position of a given side with given window dimensions to world space.

x -1.0 to 1.0 for left to right

y -1.0 to 1.0 for up to down

pub fn contains_object(&self, object_id: &usize) -> bool

Checks if the layer contains this object.

pub fn move_to(&self, object: &Object, index: usize) -> Result<(), ObjectError>

Moves an object on the given index in it’s parents children order.

Returns

pub fn move_up(&self, object: &Object) -> Result<(), ObjectError>

Moves an object one up in it’s parents children order.

pub fn move_down(&self, object: &Object) -> Result<(), ObjectError>

Moves an object one down in it’s parents children order.

pub fn move_to_top(&self, object: &Object) -> Result<(), ObjectError>

Moves an object all the way to the top of it’s parents children list.

pub fn move_to_bottom(&self, object: &Object) -> Result<(), ObjectError>

Moves an object all the way to the bottom of it’s parents children list.

pub fn children_count(&self, parent: &Object) -> Result<usize, ObjectError>

impl Layer

Physics

pub fn query_nearest_collider_at(&self, position: Vec2) -> Option<usize>

Returns the nearest collider id from a specific location.

pub fn cast_ray( &self, position: Vec2, direction: Vec2, time_of_impact: Real, solid: bool ) -> Option<usize>

Returns id of the first collider intersecting with given ray.

pub fn cast_ray_and_get_normal( &self, position: Vec2, direction: Vec2, time_of_impact: Real, solid: bool ) -> Option<(usize, Vec2)>

Returns id of the first collider intersecting with given ray and returns a normal.

pub fn intersections_with_ray( &self, position: Vec2, direction: Vec2, time_of_impact: Real, solid: bool ) -> Vec<usize>

Returns id of the first collider intersecting with given ray.

pub fn intersection_with_shape( &self, shape: Shape, position: (Vec2, f32) ) -> Option<usize>

Cast a shape and return the first collider intersecting with it.

pub fn intersections_with_shape( &self, shape: Shape, position: (Vec2, f32) ) -> Vec<usize>

Cast a shape and return the first collider intersecting with it.

pub fn gravity(&self) -> Vec2

Gets the gravity parameter.

pub fn set_gravity(&self, gravity: Vec2)

Sets the gravity parameter.

pub fn physics_enabled(&self) -> bool

Returns if physics is enabled.

pub fn set_physics_enabled(&self, enabled: bool)

Set physics to be enabled or disabled.

pub fn physics_parameters(&self) -> IntegrationParameters

Takes the physics simulation parameters.

pub fn set_physics_parameters(&self, parameters: IntegrationParameters)

Sets the physics simulation parameters.

pub fn add_joint( &self, object1: &Object, object2: &Object, data: impl Into<GenericJoint>, wake_up: bool ) -> Result<ImpulseJointHandle, NoRigidBodyError>

Adds a joint between object 1 and 2.

pub fn joint(&self, handle: ImpulseJointHandle) -> Option<GenericJoint>

Returns if the joint exists.

pub fn set_joint( &self, data: impl Into<GenericJoint>, handle: ImpulseJointHandle ) -> Result<(), NoJointError>

Updates a joint.

pub fn remove_joint(&self, handle: ImpulseJointHandle, wake_up: bool)

Removes a joint.

Trait Implementations

impl Hash for Layer

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

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 Layer

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

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

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

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

impl Eq for Layer