Skip to main content

Image

Struct Image 

Source
pub struct Image { /* private fields */ }
Expand description

Image as projection of Scope wrt Frame.

Implementations§

Source§

impl Image

Source

pub fn new(frame: Frame, scope: Scope, max: Vec2) -> Self

Computes initial transformations from frame, scope, and screen’s width and height.

Source

pub fn compute(&mut self, frame: Frame, scope: Scope) -> Option<bool>

Recomputes only cached matrices whose parameters have changed, see Self::set_compute().

Returns Some(true) on success, Some(false) on failure, and None with no changes.

Source

pub const fn set_compute(&mut self, compute_mat: bool, compute_inv: bool)

Sets whether to compute transformation and inverse transformation with Self::compute().

Default is (true, true). Takes effect with next Self::compute().

Source

pub const fn set_passive(&mut self, use_passive: bool)

Sets whether to use passive transformations.

Default is false. Takes effect with next Self::compute().

Source

pub const fn pos(&self) -> Vec2

Current position in screen space of hovering input or pointing device.

Source

pub const fn set_pos(&mut self, pos: Vec2)

Sets current position in screen space of hovering input or pointing device.

Source

pub const fn max(&self) -> Vec2

Maximum position in screen space as screen’s width and height.

Source

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

Sets maximum position in screen space as screen’s width and height.

Takes effect with next Self::compute().

Source

pub const fn upp(&self) -> f32

Cached unit per pixel on focus plane to scale/project positions/vectors onto focus plane.

Source

pub const fn view_rigid(&self) -> Rigid

Cached view transformation from camera to world space or inversely if passive.

See Self::set_passive().

Source

pub const fn view(&self) -> Mat4

Cached view matrix.

Source

pub const fn projection(&self) -> Mat4

Cached projection matrix.

Source

pub const fn transformation(&self) -> Mat4

Cached projection view matrix.

Source

pub const fn inverse_transformation(&self) -> Mat4

Cached inverse projection view matrix.

Source

pub const fn clamp_pos_wrt_max(pos: Vec2, max: Vec2) -> Vec2

Clamps position in screen space wrt its maximum in screen space.

Source

pub const fn clamp_pos(&self, pos: Vec2) -> Vec2

Clamps position in screen space.

Source

pub fn transform_pos_and_max_wrt_max(pos: Vec2, max: Vec2) -> (Vec2, Vec2)

Transforms position and its maximum from screen to camera space wrt its maximum.

Source

pub fn transform_pos(&self, pos: Vec2) -> Vec2

Transforms position from screen to camera space.

Source

pub const fn transform_vec(vec: Vec2) -> Vec2

Transforms vector from screen to camera space.

Source

pub fn project_pos(&self, pos: Vec2) -> Vec3

Transforms position from screen to camera space and projects it onto focus plane.

Source

pub fn project_vec(&self, vec: Vec2) -> Vec3

Transforms vector from screen to camera space and projects it onto focus plane.

Trait Implementations§

Source§

impl Clone for Image

Source§

fn clone(&self) -> Image

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Image

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Image

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Image

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for Image

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for Image

Source§

impl StructuralPartialEq for Image

Auto Trait Implementations§

§

impl Freeze for Image

§

impl RefUnwindSafe for Image

§

impl Send for Image

§

impl Sync for Image

§

impl Unpin for Image

§

impl UnsafeUnpin for Image

§

impl UnwindSafe for Image

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,