Struct nalgebra::geometry::Scale

source · [−]
#[repr(C)]
pub struct Scale<T, const D: usize> {
    pub vector: SVector<T, D>,
}
Expand description

A scale which supports non-uniform scaling.

Fields

vector: SVector<T, D>

The scale coordinates, i.e., how much is multiplied to a point’s coordinates when it is scaled.

Implementations

Inverts self.

Example
let t = Scale3::new(1.0, 2.0, 3.0);
assert_eq!(t * t.try_inverse().unwrap(), Scale3::identity());
assert_eq!(t.try_inverse().unwrap() * t, Scale3::identity());

// Work in all dimensions.
let t = Scale2::new(1.0, 2.0);
assert_eq!(t * t.try_inverse().unwrap(), Scale2::identity());
assert_eq!(t.try_inverse().unwrap() * t, Scale2::identity());

// Returns None if any coordinate is 0.
let t = Scale2::new(0.0, 2.0);
assert_eq!(t.try_inverse(), None);

Inverts self.

Example

unsafe {
    let t = Scale3::new(1.0, 2.0, 3.0);
    assert_eq!(t * t.inverse_unchecked(), Scale3::identity());
    assert_eq!(t.inverse_unchecked() * t, Scale3::identity());

    // Work in all dimensions.
    let t = Scale2::new(1.0, 2.0);
    assert_eq!(t * t.inverse_unchecked(), Scale2::identity());
    assert_eq!(t.inverse_unchecked() * t, Scale2::identity());
}

Inverts self.

Example
let t = Scale3::new(1.0, 2.0, 3.0);
assert_eq!(t * t.pseudo_inverse(), Scale3::identity());
assert_eq!(t.pseudo_inverse() * t, Scale3::identity());

// Work in all dimensions.
let t = Scale2::new(1.0, 2.0);
assert_eq!(t * t.pseudo_inverse(), Scale2::identity());
assert_eq!(t.pseudo_inverse() * t, Scale2::identity());

// Inverts only non-zero coordinates.
let t = Scale2::new(0.0, 2.0);
assert_eq!(t * t.pseudo_inverse(), Scale2::new(0.0, 1.0));
assert_eq!(t.pseudo_inverse() * t, Scale2::new(0.0, 1.0));

Converts this Scale into its equivalent homogeneous transformation matrix.

Example
let t = Scale3::new(10.0, 20.0, 30.0);
let expected = Matrix4::new(10.0, 0.0, 0.0, 0.0,
                            0.0, 20.0, 0.0, 0.0,
                            0.0, 0.0, 30.0, 0.0,
                            0.0, 0.0, 0.0, 1.0);
assert_eq!(t.to_homogeneous(), expected);

let t = Scale2::new(10.0, 20.0);
let expected = Matrix3::new(10.0, 0.0, 0.0,
                            0.0, 20.0, 0.0,
                            0.0, 0.0, 1.0);
assert_eq!(t.to_homogeneous(), expected);

Inverts self in-place.

Example
let t = Scale3::new(1.0, 2.0, 3.0);
let mut inv_t = Scale3::new(1.0, 2.0, 3.0);
assert!(inv_t.try_inverse_mut());
assert_eq!(t * inv_t, Scale3::identity());
assert_eq!(inv_t * t, Scale3::identity());

// Work in all dimensions.
let t = Scale2::new(1.0, 2.0);
let mut inv_t = Scale2::new(1.0, 2.0);
assert!(inv_t.try_inverse_mut());
assert_eq!(t * inv_t, Scale2::identity());
assert_eq!(inv_t * t, Scale2::identity());

// Does not perform any operation if a coordinate is 0.
let mut t = Scale2::new(0.0, 2.0);
assert!(!t.try_inverse_mut());

Translate the given point.

This is the same as the multiplication self * pt.

Example
let t = Scale3::new(1.0, 2.0, 3.0);
let transformed_point = t.transform_point(&Point3::new(4.0, 5.0, 6.0));
assert_eq!(transformed_point, Point3::new(4.0, 10.0, 18.0));

Translate the given point by the inverse of this Scale.

Example
let t = Scale3::new(1.0, 2.0, 3.0);
let transformed_point = t.try_inverse_transform_point(&Point3::new(4.0, 6.0, 6.0)).unwrap();
assert_eq!(transformed_point, Point3::new(4.0, 3.0, 2.0));

// Returns None if the inverse doesn't exist.
let t = Scale3::new(1.0, 0.0, 3.0);
let transformed_point = t.try_inverse_transform_point(&Point3::new(4.0, 6.0, 6.0));
assert_eq!(transformed_point, None);

Creates a new identity scale.

Example
let t = Scale2::identity();
let p = Point2::new(1.0, 2.0);
assert_eq!(t * p, p);

// Works in all dimensions.
let t = Scale3::identity();
let p = Point3::new(1.0, 2.0, 3.0);
assert_eq!(t * p, p);

Cast the components of self to another type.

Example
let tra = Scale2::new(1.0f64, 2.0);
let tra2 = tra.cast::<f32>();
assert_eq!(tra2, Scale2::new(1.0f32, 2.0));

Initializes this Scale from its components.

Example
let t = Scale1::new(1.0);
assert!(t.vector.x == 1.0);

Initializes this Scale from its components.

Example
let t = Scale2::new(1.0, 2.0);
assert!(t.vector.x == 1.0 && t.vector.y == 2.0);

Initializes this Scale from its components.

Example
let t = Scale3::new(1.0, 2.0, 3.0);
assert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0);

Initializes this Scale from its components.

Example
let t = Scale4::new(1.0, 2.0, 3.0, 4.0);
assert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0 && t.vector.w == 4.0);

Initializes this Scale from its components.

Example
let t = Scale5::new(1.0, 2.0, 3.0, 4.0, 5.0);
assert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0 && t.vector.w == 4.0 && t.vector.a == 5.0);

Initializes this Scale from its components.

Example
let t = Scale6::new(1.0, 2.0, 3.0, 4.0, 5.0, 6.0);
assert!(t.vector.x == 1.0 && t.vector.y == 2.0 && t.vector.z == 3.0 && t.vector.w == 4.0 && t.vector.a == 5.0 && t.vector.b == 6.0);

Trait Implementations

Used for specifying relative comparisons.
The default tolerance to use when testing values that are close together. Read more
A test for equality that uses the absolute difference to compute the approximate equality of two numbers. Read more
The inverse of AbsDiffEq::abs_diff_eq.
Return an arbitrary value. Read more
Return an iterator of values that are smaller than itself. Read more
The archived representation of this type. Read more
The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type. Read more
Creates the archived version of this value at the given position and writes it to the given output. Read more
source

impl<__C: ?Sized, T, const D: usize> CheckBytes<__C> for Scale<T, D>where
    SVector<T, D>: CheckBytes<__C>,

The error that may result from checking the type.
Checks whether the given pointer points to a valid value within the given context. Read more
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
The resulting type after dereferencing.
Dereferences the value.
The resulting type after dereferencing.
Dereferences the value.
The resulting type after dereferencing.
Dereferences the value.
The resulting type after dereferencing.
Dereferences the value.
The resulting type after dereferencing.
Dereferences the value.
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
Mutably dereferences the value.
Mutably dereferences the value.
Mutably dereferences the value.
Mutably dereferences the value.
Mutably dereferences the value.
Deserialize this value from the given Serde deserializer. Read more
source

impl<__D: Fallible + ?Sized, T, const D: usize> Deserialize<Scale<T, D>, __D> for Archived<Scale<T, D>>where
    SVector<T, D>: Archive,
    Archived<SVector<T, D>>: Deserialize<SVector<T, D>, __D>,

Deserializes using the given deserializer
Formats the value using the given formatter. Read more

Generate an arbitrary random variate for testing purposes.

Create an iterator that generates random values of T, using rng as the source of randomness. Read more
Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Converts to this type from the input type.
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
The resulting type after applying the * operator.
Performs the * operation. Read more
Performs the *= operation. Read more
Performs the *= operation. Read more
Performs the *= operation. Read more
Returns the multiplicative identity element of Self, 1. Read more
Sets self to the multiplicative identity element of Self, 1.
Returns true if self is equal to the multiplicative identity. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
The default relative tolerance for testing values that are far-apart. Read more
A test for equality that uses a relative comparison if the values are far apart.
The inverse of RelativeEq::relative_eq.
source

impl<__S: Fallible + ?Sized, T, const D: usize> Serialize<__S> for Scale<T, D>where
    SVector<T, D>: Serialize<__S>,

Writes the dependencies for the object and returns a resolver that can create the archived type. Read more
Serialize this value into the given Serde serializer. Read more
The type of the elements of each lane of this SIMD value.
Type of the result of comparing two SIMD values like self.
The number of lanes of this SIMD value.
Initializes an SIMD value with each lanes set to val.
Extracts the i-th lane of self. Read more
Extracts the i-th lane of self without bound-checking.
Replaces the i-th lane of self by val. Read more
Replaces the i-th lane of self by val without bound-checking.
Merges self and other depending on the lanes of cond. Read more
Applies a function to each lane of self. Read more
Applies a function to each lane of self paired with the corresponding lane of b. Read more
The inclusion map: converts self to the equivalent element of its superset.
Checks if element is actually part of the subset Self (and can be converted to it).
Use with care! Same as self.to_superset but without any property checks. Always succeeds.
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
The inclusion map: converts self to the equivalent element of its superset.
Checks if element is actually part of the subset Self (and can be converted to it).
Use with care! Same as self.to_superset but without any property checks. Always succeeds.
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
The inclusion map: converts self to the equivalent element of its superset.
Checks if element is actually part of the subset Self (and can be converted to it).
Use with care! Same as self.to_superset but without any property checks. Always succeeds.
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
The default ULPs to tolerate when testing values that are far-apart. Read more
A test for equality that uses units in the last place (ULP) if the values are far apart.
The inverse of UlpsEq::ulps_eq.
Calls zeroed. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
The archived version of the pointer metadata for this type.
Converts some archived metadata to the pointer metadata for itself.
The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
The resolver for the metadata of this type. Read more
Creates the archived version of the metadata for this value at the given position and writes it to the given output. Read more
Resolves a relative pointer to this value with the given from and to and writes it to the given output. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern. Read more
If this function returns true, then it must be valid to reinterpret bits as &Self.
Deserializes using the given deserializer

Returns the argument unchanged.

Calls U::from(self).

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

The type for metadata in pointers and references to Self.
Should always be Self
Writes the object and returns the position of the archived type.
Serializes the metadata for the given type.
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.