Struct ark_api::IsoTransform

pub struct IsoTransform { /* private fields */ }

An isometric transform represented by translation * rotation.

An isometric transform conserves distances and angles.

The operations are applied right-to-left, so when transforming a point it will first be rotated and finally translated.

Implementations

impl IsoTransform

pub const IDENTITY: IsoTransform = Self{ rotation: Quat::IDENTITY, translation: Vec3A::ZERO,}

The identity transform: doesn’t transform at all. Like multiplying with 1.

pub fn from_rotation_translation( rotation: Quat, translation: Vec3 ) -> IsoTransform

A transform that first rotates around the origin and then moves all points by a set amount.

Equivalent to IsoTransform::from_translation(translation) * IsoTransform::from_quat(rotation).

The given rotation should be normalized.

pub fn from_rotation_around_point(rotation: Quat, point: Vec3) -> IsoTransform

A rotation around a given point

pub fn from_quat(rotation: Quat) -> IsoTransform

A pure rotation without any translation.

The given rotation should be normalized.

pub fn from_translation(translation: Vec3) -> IsoTransform

A pure translation without any rotation.

pub fn from_mat4(t: &Mat4) -> Option<IsoTransform>

Tries to convert a 4x4 matrix to a IsoTransform.

This may return None as a Mat4 can represent things that a IsoTransform cannot, such as scale, shearing and projection.

Panics

Will panic if the determinant of t is zero and the assert feature is enabled.

pub fn look_at_rh(eye: Vec3, target: Vec3, up: Vec3) -> Option<IsoTransform>

Creates a right-handed view transform using a camera position, a point to look at, and an up direction.

The result transforms from world coordinates to view coordinates.

For a view coordinate system with +X=right, +Y=up and +Z=back.

Will return None if any argument is zero, non-finite, or if forward and up are colinear.

pub fn rotation(&self) -> Quat

pub fn set_rotation(&mut self, rotation: Quat)

pub fn translation(&self) -> Vec3

pub fn set_translation(&mut self, translation: Vec3)

pub fn is_finite(&self) -> bool

True if every value is finite

pub fn is_nan(&self) -> bool

Returns true if any elements are NaN.

pub fn to_mat4(self) -> Mat4

Convert to an equivalent Mat4 transformation matrix.

pub fn inverse(&self) -> IsoTransform

Get the transform that undoes this transform so that t.inverse() * t == IDENTITY.

pub fn normalize(&self) -> IsoTransform

Returns self normalized. You generally don’t need to call this unless you’ve multiplied A LOT of IsoTransforms.

pub fn transform_point3(&self, p: Vec3) -> Vec3

Rotate and translate a point.

pub fn transform_vector3(&self, v: Vec3) -> Vec3

Rotate a vector.

Trait Implementations

impl Clone for IsoTransform

fn clone(&self) -> IsoTransform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IsoTransform

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

Formats the value using the given formatter.

impl Default for IsoTransform

Identity transform

fn default() -> IsoTransform

Identity transform

impl<'de> Deserialize<'de> for IsoTransform

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

Deserialize this value from the given Serde deserializer.

impl From<IsoTransform> for Affine3A

fn from(iso: IsoTransform) -> Affine3A

Converts to this type from the input type.

impl From<IsoTransform> for Conformal3

fn from(c: IsoTransform) -> Conformal3

Converts to this type from the input type.

impl From<IsoTransform> for Mat4

fn from(t: IsoTransform) -> Mat4

Converts to this type from the input type.

impl Mul<&IsoTransform> for &IsoTransform

iso * iso -> iso

type Output = IsoTransform

The resulting type after applying the * operator.

fn mul(self, rhs: &IsoTransform) -> IsoTransform

Performs the * operation.

impl Mul<Affine3A> for IsoTransform

iso * affine3a -> affine3a

type Output = Affine3A

The resulting type after applying the * operator.

fn mul(self, rhs: Affine3A) -> Affine3A

Performs the * operation.

impl Mul<Conformal3> for IsoTransform

type Output = Conformal3

The resulting type after applying the * operator.

fn mul(self, rhs: Conformal3) -> Conformal3

Performs the * operation.

impl Mul<IsoTransform> for &IsoTransform

iso * iso -> iso

type Output = IsoTransform

The resulting type after applying the * operator.

fn mul(self, rhs: IsoTransform) -> IsoTransform

Performs the * operation.

impl Mul<IsoTransform> for Affine3A

affine3a * iso -> affine3a

type Output = Affine3A

The resulting type after applying the * operator.

fn mul(self, rhs: IsoTransform) -> Affine3A

Performs the * operation.

impl Mul<IsoTransform> for Conformal3

type Output = Conformal3

The resulting type after applying the * operator.

fn mul(self, rhs: IsoTransform) -> Conformal3

Performs the * operation.

impl Mul<IsoTransform> for IsoTransform

iso * iso -> iso

type Output = IsoTransform

The resulting type after applying the * operator.

fn mul(self, rhs: IsoTransform) -> IsoTransform

Performs the * operation.

impl Mul<IsoTransform> for Mat4

iso * mat4 -> mat4

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: IsoTransform) -> Mat4

Performs the * operation.

impl Mul<Mat4> for IsoTransform

mat4 * iso -> mat4

type Output = Mat4

The resulting type after applying the * operator.

fn mul(self, rhs: Mat4) -> Mat4

Performs the * operation.

impl Mul<Ray3> for IsoTransform

type Output = Ray3

The resulting type after applying the * operator.

fn mul(self, rhs: Ray3) -> Ray3

Performs the * operation.

impl PartialEq<IsoTransform> for IsoTransform

fn eq(&self, other: &IsoTransform) -> 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<'a_, C_> Readable<'a_, C_> for IsoTransformwhere C_: Context,

fn read_from<R_>( _reader_: &mut R_ ) -> Result<IsoTransform, <C_ as Context>::Error>where R_: Reader<'a_, C_>,

fn minimum_bytes_needed() -> usize

fn read_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut( context: &mut C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>where S: Read,

fn read_from_stream_buffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>where S: Read,

fn read_from_file_with_ctx( context: C, path: impl AsRef<Path> ) -> Result<Self, <C as Context>::Error>

impl Serialize for IsoTransform

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

Serialize this value into the given Serde serializer.

impl<C_> Writable<C_> for IsoTransformwhere C_: Context,

fn write_to<T_>(&self, _writer_: &mut T_) -> Result<(), <C_ as Context>::Error>where T_: Writer<C_> + ?Sized,

fn write_to_buffer_with_ctx( &self, context: C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut( &self, context: &mut C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx( &self, context: C ) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut( &self, context: &mut C ) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>( &self, context: C, stream: S ) -> Result<(), <C as Context>::Error>where S: Write,

fn write_to_file_with_ctx( &self, context: C, path: impl AsRef<Path> ) -> Result<(), <C as Context>::Error>

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

impl Copy for IsoTransform

impl StructuralPartialEq for IsoTransform