Struct bevy :: math :: DVec3 Copy item path

impl DVec3

pub const ZERO: DVec3 = _

All zeroes.

pub const ONE: DVec3 = _

All ones.

pub const NEG_ONE: DVec3 = _

All negative ones.

pub const MIN: DVec3 = _

All f64::MIN.

pub const MAX: DVec3 = _

All f64::MAX.

pub const NAN: DVec3 = _

All f64::NAN.

pub const INFINITY: DVec3 = _

All f64::INFINITY.

pub const NEG_INFINITY: DVec3 = _

All f64::NEG_INFINITY.

pub const X: DVec3 = _

A unit vector pointing along the positive X axis.

pub const Y: DVec3 = _

A unit vector pointing along the positive Y axis.

pub const Z: DVec3 = _

A unit vector pointing along the positive Z axis.

pub const NEG_X: DVec3 = _

A unit vector pointing along the negative X axis.

pub const NEG_Y: DVec3 = _

A unit vector pointing along the negative Y axis.

pub const NEG_Z: DVec3 = _

A unit vector pointing along the negative Z axis.

pub const AXES: [DVec3; 3] = _

The unit axes.

pub const fn new(x: f64, y: f64, z: f64) -> DVec3

Creates a new vector.

Examples found in repository ?

examples/stress_tests/many_cubes.rs (line 438)

fn spherical_polar_to_cartesian(p: DVec2) -> DVec3 {
    let (sin_theta, cos_theta) = p.x.sin_cos();
    let (sin_phi, cos_phi) = p.y.sin_cos();
    DVec3::new(cos_theta * sin_phi, sin_theta * sin_phi, cos_phi)
}

More examples

Hide additional examples

examples/stress_tests/many_lights.rs (line 136)

fn spherical_polar_to_cartesian(p: DVec2) -> DVec3 {
    let (sin_theta, cos_theta) = p.x.sin_cos();
    let (sin_phi, cos_phi) = p.y.sin_cos();
    DVec3::new(cos_theta * sin_phi, sin_theta * sin_phi, cos_phi)
}

pub const fn splat(v: f64) -> DVec3

Creates a vector with all elements set to v.

pub fn select(mask: BVec3, if_true: DVec3, if_false: DVec3) -> DVec3

Creates a vector from the elements in if_true and if_false, selecting which to use for each element of self.

A true element in the mask uses the corresponding element from if_true, and false uses the element from if_false.

pub const fn from_array(a: [f64; 3]) -> DVec3

Creates a new vector from an array.

pub const fn to_array(&self) -> [f64; 3]

[x, y, z]

pub const fn from_slice(slice: &[f64]) -> DVec3

Creates a vector from the first 3 values in slice.

§Panics

Panics if slice is less than 3 elements long.

pub fn write_to_slice(self, slice: &mut [f64])

Writes the elements of self to the first 3 elements in slice.

§Panics

Panics if slice is less than 3 elements long.

pub fn extend(self, w: f64) -> DVec4

Creates a 4D vector from self and the given w value.

pub fn truncate(self) -> DVec2

Creates a 2D vector from the x and y elements of self, discarding z.

Truncation may also be performed by using self.xy().

pub fn dot(self, rhs: DVec3) -> f64

Computes the dot product of self and rhs.

pub fn dot_into_vec(self, rhs: DVec3) -> DVec3

Returns a vector where every component is the dot product of self and rhs.

pub fn cross(self, rhs: DVec3) -> DVec3

Computes the cross product of self and rhs.

pub fn min(self, rhs: DVec3) -> DVec3

Returns a vector containing the minimum values for each element of self and rhs.

In other words this computes [self.x.min(rhs.x), self.y.min(rhs.y), ..].

pub fn max(self, rhs: DVec3) -> DVec3

Returns a vector containing the maximum values for each element of self and rhs.

In other words this computes [self.x.max(rhs.x), self.y.max(rhs.y), ..].

pub fn clamp(self, min: DVec3, max: DVec3) -> DVec3

Component-wise clamping of values, similar to f64::clamp.

Each element in min must be less-or-equal to the corresponding element in max.

§Panics

Will panic if min is greater than max when glam_assert is enabled.

pub fn min_element(self) -> f64

Returns the horizontal minimum of self.

In other words this computes min(x, y, ..).

pub fn max_element(self) -> f64

Returns the horizontal maximum of self.

In other words this computes max(x, y, ..).

pub fn cmpeq(self, rhs: DVec3) -> BVec3

Returns a vector mask containing the result of a == comparison for each element of self and rhs.

In other words, this computes [self.x == rhs.x, self.y == rhs.y, ..] for all elements.

pub fn cmpne(self, rhs: DVec3) -> BVec3

Returns a vector mask containing the result of a != comparison for each element of self and rhs.

In other words this computes [self.x != rhs.x, self.y != rhs.y, ..] for all elements.

pub fn cmpge(self, rhs: DVec3) -> BVec3

Returns a vector mask containing the result of a >= comparison for each element of self and rhs.

In other words this computes [self.x >= rhs.x, self.y >= rhs.y, ..] for all elements.

pub fn cmpgt(self, rhs: DVec3) -> BVec3

Returns a vector mask containing the result of a > comparison for each element of self and rhs.

In other words this computes [self.x > rhs.x, self.y > rhs.y, ..] for all elements.

pub fn cmple(self, rhs: DVec3) -> BVec3

Returns a vector mask containing the result of a <= comparison for each element of self and rhs.

In other words this computes [self.x <= rhs.x, self.y <= rhs.y, ..] for all elements.

pub fn cmplt(self, rhs: DVec3) -> BVec3

Returns a vector mask containing the result of a < comparison for each element of self and rhs.

In other words this computes [self.x < rhs.x, self.y < rhs.y, ..] for all elements.

pub fn abs(self) -> DVec3

Returns a vector containing the absolute value of each element of self.

pub fn signum(self) -> DVec3

Returns a vector with elements representing the sign of self.

1.0 if the number is positive, +0.0 or INFINITY
-1.0 if the number is negative, -0.0 or NEG_INFINITY
NAN if the number is NAN

pub fn copysign(self, rhs: DVec3) -> DVec3

Returns a vector with signs of rhs and the magnitudes of self.

pub fn is_negative_bitmask(self) -> u32

Returns a bitmask with the lowest 3 bits set to the sign bits from the elements of self.

A negative element results in a 1 bit and a positive element in a 0 bit. Element x goes into the first lowest bit, element y into the second, etc.

pub fn is_finite(self) -> bool

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

pub fn is_nan(self) -> bool

Returns true if any elements are NaN.

pub fn is_nan_mask(self) -> BVec3

Performs is_nan on each element of self, returning a vector mask of the results.

In other words, this computes [x.is_nan(), y.is_nan(), z.is_nan(), w.is_nan()].

pub fn length(self) -> f64

Computes the length of self.

pub fn length_squared(self) -> f64

Computes the squared length of self.

This is faster than length() as it avoids a square root operation.

pub fn length_recip(self) -> f64

Computes 1.0 / length().

For valid results, self must not be of length zero.

pub fn distance(self, rhs: DVec3) -> f64

Computes the Euclidean distance between two points in space.

pub fn distance_squared(self, rhs: DVec3) -> f64

Compute the squared euclidean distance between two points in space.

pub fn div_euclid(self, rhs: DVec3) -> DVec3

Returns the element-wise quotient of [Euclidean division] of self by rhs.

pub fn rem_euclid(self, rhs: DVec3) -> DVec3

Returns the element-wise remainder of Euclidean division of self by rhs.

pub fn normalize(self) -> DVec3

Returns self normalized to length 1.0.

For valid results, self must not be of length zero, nor very close to zero.

Panics

Will panic if self is zero length when glam_assert is enabled.

pub fn try_normalize(self) -> Option<DVec3>

Returns self normalized to length 1.0 if possible, else returns None.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be None.

pub fn normalize_or_zero(self) -> DVec3

Returns self normalized to length 1.0 if possible, else returns zero.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be zero.

pub fn is_normalized(self) -> bool

Returns whether self is length 1.0 or not.

Uses a precision threshold of 1e-6.

pub fn project_onto(self, rhs: DVec3) -> DVec3

Returns the vector projection of self onto rhs.

rhs must be of non-zero length.

§Panics

Will panic if rhs is zero length when glam_assert is enabled.

pub fn reject_from(self, rhs: DVec3) -> DVec3

Returns the vector rejection of self from rhs.

The vector rejection is the vector perpendicular to the projection of self onto rhs, in rhs words the result of self - self.project_onto(rhs).

rhs must be of non-zero length.

§Panics

Will panic if rhs has a length of zero when glam_assert is enabled.

pub fn project_onto_normalized(self, rhs: DVec3) -> DVec3

Returns the vector projection of self onto rhs.

rhs must be normalized.

§Panics

Will panic if rhs is not normalized when glam_assert is enabled.

pub fn reject_from_normalized(self, rhs: DVec3) -> DVec3

Returns the vector rejection of self from rhs.

The vector rejection is the vector perpendicular to the projection of self onto rhs, in rhs words the result of self - self.project_onto(rhs).

rhs must be normalized.

§Panics

Will panic if rhs is not normalized when glam_assert is enabled.

pub fn round(self) -> DVec3

Returns a vector containing the nearest integer to a number for each element of self. Round half-way cases away from 0.0.

pub fn floor(self) -> DVec3

Returns a vector containing the largest integer less than or equal to a number for each element of self.

pub fn ceil(self) -> DVec3

Returns a vector containing the smallest integer greater than or equal to a number for each element of self.

pub fn trunc(self) -> DVec3

Returns a vector containing the integer part each element of self. This means numbers are always truncated towards zero.

pub fn fract(self) -> DVec3

Returns a vector containing the fractional part of the vector, e.g. self - self.floor().

Note that this is fast but not precise for large numbers.

pub fn exp(self) -> DVec3

Returns a vector containing e^self (the exponential function) for each element of self.

pub fn powf(self, n: f64) -> DVec3

Returns a vector containing each element of self raised to the power of n.

pub fn recip(self) -> DVec3

Returns a vector containing the reciprocal 1.0/n of each element of self.

pub fn lerp(self, rhs: DVec3, s: f64) -> DVec3

Performs a linear interpolation between self and rhs based on the value s.

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to rhs. When s is outside of range [0, 1], the result is linearly extrapolated.

pub fn abs_diff_eq(self, rhs: DVec3, max_abs_diff: f64) -> bool

Returns true if the absolute difference of all elements between self and rhs is less than or equal to max_abs_diff.

This can be used to compare if two vectors contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

pub fn clamp_length(self, min: f64, max: f64) -> DVec3

Returns a vector with a length no less than min and no more than max

§Panics

Will panic if min is greater than max when glam_assert is enabled.

pub fn clamp_length_max(self, max: f64) -> DVec3

Returns a vector with a length no more than max

pub fn clamp_length_min(self, min: f64) -> DVec3

Returns a vector with a length no less than min

pub fn mul_add(self, a: DVec3, b: DVec3) -> DVec3

Fused multiply-add. Computes (self * a) + b element-wise with only one rounding error, yielding a more accurate result than an unfused multiply-add.

Using mul_add may be more performant than an unfused multiply-add if the target architecture has a dedicated fma CPU instruction. However, this is not always true, and will be heavily dependant on designing algorithms with specific target hardware in mind.

pub fn angle_between(self, rhs: DVec3) -> f64

Returns the angle (in radians) between two vectors.

The inputs do not need to be unit vectors however they must be non-zero.

pub fn any_orthogonal_vector(&self) -> DVec3

Returns some vector that is orthogonal to the given one.

The input vector must be finite and non-zero.

The output vector is not necessarily unit length. For that use Self::any_orthonormal_vector() instead.

pub fn any_orthonormal_vector(&self) -> DVec3

Returns any unit vector that is orthogonal to the given one.

The input vector must be unit length.

§Panics

Will panic if self is not normalized when glam_assert is enabled.

pub fn any_orthonormal_pair(&self) -> (DVec3, DVec3)

Given a unit vector return two other vectors that together form an orthonormal basis. That is, all three vectors are orthogonal to each other and are normalized.

§Panics

Will panic if self is not normalized when glam_assert is enabled.

pub fn as_vec3(&self) -> Vec3

Casts all elements of self to f32.

Examples found in repository ?

examples/stress_tests/many_lights.rs (line 88)

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
) {
    warn!(include_str!("warning_string.txt"));

    const LIGHT_RADIUS: f32 = 0.3;
    const LIGHT_INTENSITY: f32 = 1000.0;
    const RADIUS: f32 = 50.0;
    const N_LIGHTS: usize = 100_000;

    commands.spawn(PbrBundle {
        mesh: meshes.add(Sphere::new(RADIUS).mesh().ico(9).unwrap()),
        material: materials.add(Color::WHITE),
        transform: Transform::from_scale(Vec3::NEG_ONE),
        ..default()
    });

    let mesh = meshes.add(Cuboid::default());
    let material = materials.add(StandardMaterial {
        base_color: DEEP_PINK.into(),
        ..default()
    });

    // NOTE: This pattern is good for testing performance of culling as it provides roughly
    // the same number of visible meshes regardless of the viewing angle.
    // NOTE: f64 is used to avoid precision issues that produce visual artifacts in the distribution
    let golden_ratio = 0.5f64 * (1.0f64 + 5.0f64.sqrt());

    // Spawn N_LIGHTS many lights
    commands.spawn_batch((0..N_LIGHTS).map(move |i| {
        let mut rng = thread_rng();

        let spherical_polar_theta_phi = fibonacci_spiral_on_sphere(golden_ratio, i, N_LIGHTS);
        let unit_sphere_p = spherical_polar_to_cartesian(spherical_polar_theta_phi);

        PointLightBundle {
            point_light: PointLight {
                range: LIGHT_RADIUS,
                intensity: LIGHT_INTENSITY,
                color: Color::hsl(rng.gen_range(0.0..360.0), 1.0, 0.5),
                ..default()
            },
            transform: Transform::from_translation((RADIUS as f64 * unit_sphere_p).as_vec3()),
            ..default()
        }
    }));

    // camera
    match std::env::args().nth(1).as_deref() {
        Some("orthographic") => commands.spawn(Camera3dBundle {
            projection: OrthographicProjection {
                scale: 20.0,
                scaling_mode: ScalingMode::FixedHorizontal(1.0),
                ..default()
            }
            .into(),
            ..default()
        }),
        _ => commands.spawn(Camera3dBundle::default()),
    };

    // add one cube, the only one with strong handles
    // also serves as a reference point during rotation
    commands.spawn(PbrBundle {
        mesh,
        material,
        transform: Transform {
            translation: Vec3::new(0.0, RADIUS, 0.0),
            scale: Vec3::splat(5.0),
            ..default()
        },
        ..default()
    });
}

More examples

Hide additional examples

examples/stress_tests/many_cubes.rs (line 161)

fn setup(
    mut commands: Commands,
    args: Res<Args>,
    mesh_assets: ResMut<Assets<Mesh>>,
    material_assets: ResMut<Assets<StandardMaterial>>,
    images: ResMut<Assets<Image>>,
) {
    warn!(include_str!("warning_string.txt"));

    let args = args.into_inner();
    let images = images.into_inner();
    let material_assets = material_assets.into_inner();
    let mesh_assets = mesh_assets.into_inner();

    let meshes = init_meshes(args, mesh_assets);

    let material_textures = init_textures(args, images);
    let materials = init_materials(args, &material_textures, material_assets);

    // We're seeding the PRNG here to make this example deterministic for testing purposes.
    // This isn't strictly required in practical use unless you need your app to be deterministic.
    let mut material_rng = ChaCha8Rng::seed_from_u64(42);
    match args.layout {
        Layout::Sphere => {
            // NOTE: This pattern is good for testing performance of culling as it provides roughly
            // the same number of visible meshes regardless of the viewing angle.
            const N_POINTS: usize = WIDTH * HEIGHT * 4;
            // NOTE: f64 is used to avoid precision issues that produce visual artifacts in the distribution
            let radius = WIDTH as f64 * 2.5;
            let golden_ratio = 0.5f64 * (1.0f64 + 5.0f64.sqrt());
            for i in 0..N_POINTS {
                let spherical_polar_theta_phi =
                    fibonacci_spiral_on_sphere(golden_ratio, i, N_POINTS);
                let unit_sphere_p = spherical_polar_to_cartesian(spherical_polar_theta_phi);
                let (mesh, transform) = meshes.choose(&mut material_rng).unwrap();
                let mut cube = commands.spawn(PbrBundle {
                    mesh: mesh.clone(),
                    material: materials.choose(&mut material_rng).unwrap().clone(),
                    transform: Transform::from_translation((radius * unit_sphere_p).as_vec3())
                        .looking_at(Vec3::ZERO, Vec3::Y)
                        .mul_transform(*transform),
                    ..default()
                });
                if args.no_frustum_culling {
                    cube.insert(NoFrustumCulling);
                }
                if args.no_automatic_batching {
                    cube.insert(NoAutomaticBatching);
                }
            }

            // camera
            commands.spawn(Camera3dBundle::default());
            // Inside-out box around the meshes onto which shadows are cast (though you cannot see them...)
            commands.spawn((
                PbrBundle {
                    mesh: mesh_assets.add(Cuboid::from_size(Vec3::splat(radius as f32 * 2.2))),
                    material: material_assets.add(StandardMaterial::from(Color::WHITE)),
                    transform: Transform::from_scale(-Vec3::ONE),
                    ..default()
                },
                NotShadowCaster,
            ));
        }
        _ => {
            // NOTE: This pattern is good for demonstrating that frustum culling is working correctly
            // as the number of visible meshes rises and falls depending on the viewing angle.
            let scale = 2.5;
            for x in 0..WIDTH {
                for y in 0..HEIGHT {
                    // introduce spaces to break any kind of moiré pattern
                    if x % 10 == 0 || y % 10 == 0 {
                        continue;
                    }
                    // cube
                    commands.spawn(PbrBundle {
                        mesh: meshes.choose(&mut material_rng).unwrap().0.clone(),
                        material: materials.choose(&mut material_rng).unwrap().clone(),
                        transform: Transform::from_xyz((x as f32) * scale, (y as f32) * scale, 0.0),
                        ..default()
                    });
                    commands.spawn(PbrBundle {
                        mesh: meshes.choose(&mut material_rng).unwrap().0.clone(),
                        material: materials.choose(&mut material_rng).unwrap().clone(),
                        transform: Transform::from_xyz(
                            (x as f32) * scale,
                            HEIGHT as f32 * scale,
                            (y as f32) * scale,
                        ),
                        ..default()
                    });
                    commands.spawn(PbrBundle {
                        mesh: meshes.choose(&mut material_rng).unwrap().0.clone(),
                        material: materials.choose(&mut material_rng).unwrap().clone(),
                        transform: Transform::from_xyz((x as f32) * scale, 0.0, (y as f32) * scale),
                        ..default()
                    });
                    commands.spawn(PbrBundle {
                        mesh: meshes.choose(&mut material_rng).unwrap().0.clone(),
                        material: materials.choose(&mut material_rng).unwrap().clone(),
                        transform: Transform::from_xyz(0.0, (x as f32) * scale, (y as f32) * scale),
                        ..default()
                    });
                }
            }
            // camera
            let center = 0.5 * scale * Vec3::new(WIDTH as f32, HEIGHT as f32, WIDTH as f32);
            commands.spawn(Camera3dBundle {
                transform: Transform::from_translation(center),
                ..default()
            });
            // Inside-out box around the meshes onto which shadows are cast (though you cannot see them...)
            commands.spawn((
                PbrBundle {
                    mesh: mesh_assets.add(Cuboid::from_size(2.0 * 1.1 * center)),
                    material: material_assets.add(StandardMaterial::from(Color::WHITE)),
                    transform: Transform::from_scale(-Vec3::ONE).with_translation(center),
                    ..default()
                },
                NotShadowCaster,
            ));
        }
    }

    commands.spawn(DirectionalLightBundle {
        directional_light: DirectionalLight {
            shadows_enabled: args.shadows,
            ..default()
        },
        transform: Transform::IDENTITY.looking_at(Vec3::new(0.0, -1.0, -1.0), Vec3::Y),
        ..default()
    });
}

pub fn as_vec3a(&self) -> Vec3A

Casts all elements of self to f32.

pub fn as_i16vec3(&self) -> I16Vec3

Casts all elements of self to i16.

pub fn as_u16vec3(&self) -> U16Vec3

Casts all elements of self to u16.

pub fn as_ivec3(&self) -> IVec3

Casts all elements of self to i32.

pub fn as_uvec3(&self) -> UVec3

Casts all elements of self to u32.

pub fn as_i64vec3(&self) -> I64Vec3

Casts all elements of self to i64.

pub fn as_u64vec3(&self) -> U64Vec3

Casts all elements of self to u64.

Trait Implementations§

impl Add<f64> for DVec3

type Output = DVec3

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> DVec3

Performs the + operation. Read more

impl Add for DVec3

type Output = DVec3

The resulting type after applying the + operator.

fn add(self, rhs: DVec3) -> DVec3

Performs the + operation. Read more

impl AddAssign<f64> for DVec3

fn add_assign(&mut self, rhs: f64)

Performs the += operation. Read more

impl AddAssign for DVec3

fn add_assign(&mut self, rhs: DVec3)

Performs the += operation. Read more

impl Animatable for DVec3

fn interpolate(a: &DVec3, b: &DVec3, t: f32) -> DVec3

Interpolates between a and b with a interpolation factor of time. Read more

fn blend(inputs: impl Iterator<Item = BlendInput<DVec3>>) -> DVec3

Blends one or more values together. Read more

fn post_process(&mut self, _world: &World)

Post-processes the value using resources in the World. Most animatable types do not need to implement this.

impl AsMut<[f64; 3]> for DVec3

Available on non-target_arch="spirv" only.

fn as_mut(&mut self) -> &mut [f64; 3]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[f64; 3]> for DVec3

Available on non-target_arch="spirv" only.

fn as_ref(&self) -> &[f64; 3]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DVec3

fn clone(&self) -> DVec3

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for DVec3

Available on non-target_arch="spirv" only.

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

Formats the value using the given formatter. Read more

impl Default for DVec3

fn default() -> DVec3

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for DVec3

fn deserialize<D>( deserializer: D ) -> Result<DVec3, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for DVec3

Available on non-target_arch="spirv" only.

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

Formats the value using the given formatter. Read more

impl Div<f64> for DVec3

type Output = DVec3

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> DVec3

Performs the / operation. Read more

impl Div for DVec3

type Output = DVec3

The resulting type after applying the / operator.

fn div(self, rhs: DVec3) -> DVec3

Performs the / operation. Read more

impl DivAssign<f64> for DVec3

fn div_assign(&mut self, rhs: f64)

Performs the /= operation. Read more

impl DivAssign for DVec3

fn div_assign(&mut self, rhs: DVec3)

Performs the /= operation. Read more