Struct bones_framework::render::camera::CameraShake

#[repr(C)]
pub struct CameraShake {
    pub trauma: f32,
    pub max_angle_rad: f32,
    pub max_offset: Vec2,
    pub decay_rate: f32,
    pub speed: f32,
    pub center: Vec3,
}

Component for an entity with camera shake.

Fields

trauma: f32

Value from 0-1 that indicates the intensity of the shake. Should usually be set with CameraShake::add_trauma and not manually decayed.

max_angle_rad: f32

The maximum offset angle in radians that the camera shake can cause.

max_offset: Vec2

The maximum offset position that the camera shake can cause.

decay_rate: f32

The the length of time in seconds for the camera trauma to decay from 1 to 0.

speed: f32

The speed that the screen is shook.

center: Vec3

The camera will always restore to this position.

Implementations

impl CameraShake

pub fn new( max_angle_deg: f32, max_offset: Vec2, speed: f32, decay_rate: f32, ) -> Self

Create a new CameraShake component with the provided maximum offset angle (in degrees) and position as well as the trauma decay rate in seconds.

pub fn with_trauma( trauma: f32, max_angle_deg: f32, max_offset: Vec2, speed: f32, decay_rate: f32, ) -> Self

Create a new CameraShake component with the provided maximum offset angle (in degrees) and position and its initial trauma set to some value (clamped between 0 and 1).

pub fn add_trauma(&mut self, value: f32)

Adds trauma to the camera, capping it at 1.0

Trait Implementations

impl Clone for CameraShake

fn clone(&self) -> CameraShake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CameraShake

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

Formats the value using the given formatter.

impl Default for CameraShake

fn default() -> Self

Returns the “default value” for a type.

impl HasSchema for CameraShake

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut

impl Copy for CameraShake