Struct amethyst_utils::auto_fov::AutoFov

pub struct AutoFov { /* fields omitted */ }

A component describing the behavior of the camera in accordance with the screen dimensions

Methods

impl AutoFov

pub fn new() -> Self

Creates a new instance with the default values for all fields

pub fn base_fovx(&self) -> f32

The horizontal FOV value at the aspect ratio in the field base_aspect_ratio

This value should be between the min_fovx and max_fovx values. Value in radians. Defaults to 1.861684535, which is the horizontal FOV value when the vertial FOV and aspect ratio for a camera is set to 1.0471975512(60 deg) and 16/9, respectively.

pub fn fovx_growth_rate(&self) -> f32

The factor determining how sensitive the FOV change should be

Defaults to 1.0.

pub fn fixed_growth_rate(&self) -> bool

If the FOV grow rate specified in the field fovx_growth_rate should be applied as-is

Defaults to false. When false, the fovx_growth_rate field is multiplied with the camera's current vertical FOV value.

pub fn base_aspect_ratio(&self) -> (usize, usize)

The aspect ratio when the camera's horizontal FOV is identical to base_fovx

Defaults to (16, 9).

pub fn min_fovx(&self) -> f32

The minimum value the horizontal FOV can have

This value should be larger than 0. Defaults to 0.1.

pub fn max_fovx(&self) -> f32

The maximum value the horizontal FOV can have

This value should be larger than 0. Defaults to PI. The rendered view will be stretched if the screen aspect ratio keeps growing after the point where the camera's horizontal FOV reaches this maximum value.

pub fn set_base_fovx(&mut self, base_fovx: f32)

Sets base_fovx to the given value

This function panics if the given value is not between min_fovx and max_fovx.

pub fn set_fovx_growth_rate(&mut self, fovx_growth_rate: f32)

Sets fovx_growth_rate to the given value

pub fn set_fixed_growth_rate(&mut self, fix: bool, new_growth_rate: Option<f32>)

Sets fixed_growth_rate to the given value

You can optionally give the new fovx_growth_rate value to be set.

pub fn set_base_aspect_ratio(&mut self, horizontal: usize, vertical: usize)

Sets base_aspect_ratio to the given value

This function panics if the horizontal or vertical ratio value is zero.

pub fn set_min(&mut self, min: f32)

Sets min_fovx to the given value

This function panics if the given min_fovx is not larger than zero or is larger than max_fovx.

pub fn set_max(&mut self, max: f32)

Sets max_fovx to the given value

This function panics if the given max_fovx is smaller than min_fovx.

pub fn set_min_max(&mut self, min: f32, max: f32)

Sets min_fovx and max_fovx to the given vaues

This function panics if the given min_fovx is not larger than zero, or if the given max_fovx is smaller than the given min_fovx.

pub fn new_fovx(&self, current_aspect_ratio: f32, fovy: f32) -> f32

Computes the new horizontal FOV from the current screen aspect ratio and vertical FOV

Trait Implementations

impl Default for AutoFov

fn default() -> Self

Returns the "default value" for a type.

impl Clone for AutoFov

fn clone(&self) -> AutoFov

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AutoFov

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

Formats the value using the given formatter.

impl Serialize for AutoFov

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for AutoFov where
    AutoFov: Default, 

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

Deserialize this value from the given Serde deserializer.

impl<'pfd> PrefabData<'pfd> for AutoFov

type SystemData = WriteStorage<'pfd, AutoFov>

SystemData needed to perform the load

type Result = ()

The result type returned by the load operation

fn add_to_entity(
    &self,
    entity: Entity,
    system_data: &mut Self::SystemData,
    _: &[Entity],
    _: &[Entity]
) -> Result<(), Error>

Add the data for this prefab onto the given Entity

fn load_sub_assets(
    &mut self,
    _progress: &mut ProgressCounter,
    _system_data: &mut Self::SystemData
) -> Result<bool, Error>

Trigger asset loading for any sub assets.

impl Component for AutoFov

type Storage = HashMapStorage<Self>

Associated storage type for this component.