Struct gemini_engine::elements3d::view3d::Vec3D

pub struct Vec3D {
    pub x: f64,
    pub y: f64,
    pub z: f64,
}

A point in 3D space, using f64s

Fields

x: f64

X-coordinate

y: f64

Y-coordinate

z: f64

Z-coordinate

Implementations

impl Vec3D

pub const ZERO: Self = _

The Vec3D’s ZERO value

pub const ONE: Self = _

The Vec3D’s ONE value

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

Create a Vec3D from the provided f64 values

Examples found in repository

examples/spinning-cube.rs (line 14)

fn main() {
    let mut view = View::new(200, 90, ColChar::BACKGROUND);

    let viewport = Viewport::new(
        Transform3D::new_tr(Vec3D::new(0.0, 1.5, 4.0), Vec3D::new(-0.4, 0.0, 0.0)),
        FOV,
        view.center(),
    );

    let mut cube = Mesh3D::default_cube();

    fps_gameloop!(
        {
            view.clear();
            cube.transform.rotation.y -= 0.05;
        },
        {
            view.blit(
                &viewport.render(vec![&cube], DisplayMode::Solid),
                Wrapping::Ignore,
            );
            let _ = view.display_render();
        },
        FPS,
        |elapsed: gameloop::Duration, frame_skip| {
            println!(
                "Elapsed: {:.2?}µs | Frame skip: {}",
                elapsed.as_micros(),
                frame_skip
            );
        }
    );
}

examples/donut.rs (line 17)

fn main() {
    let mut view = View::new(82, 32, ColChar::EMPTY);
    let viewport = Viewport::new(
        Transform3D::new_tr(Vec3D::new(0.0, 0.0, 20.0), Vec3D::ZERO),
        FOV,
        view.center(),
    );

    let lights = vec![
        Light::new_ambient(0.3),
        Light::new_directional(0.7, Vec3D::new(1.0, -1.0, -1.0)),
    ];

    let mut donut = Mesh3D::torus(1.8, 1.0, 32, 16);

    fps_gameloop!(
        {
            donut.transform.rotation.x += 0.05;
            donut.transform.rotation.z += 0.05;
        },
        {
            view.clear();
            view.blit(
                &viewport.render(
                    vec![&donut],
                    DisplayMode::Illuminated {
                        lights: lights.clone(),
                    },
                ),
                Wrapping::Ignore,
            );
            let _ = view.display_render();
        },
        FPS
    );
}

pub const fn as_tuple(&self) -> (f64, f64, f64)

Return the Vec3D as a tuple

pub fn dot(&self, other: Self) -> f64

Return the dot product in combination with another Vec3D

pub fn dot_self(&self) -> f64

Returns the dot product in combination with itself

pub fn magnitude(&self) -> f64

The length/magnitude of the Vec3D

pub fn cross(&self, other: Self) -> Self

The cross product of two vectors is a vector perpendicular to both of them. See a more detailed explanation

pub fn normal(self) -> Self

Generate a normal from the Vec3D

Trait Implementations

impl Add for Vec3D

type Output = Vec3D

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Vec3D

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec3D

fn clone(&self) -> Vec3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec3D

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

Formats the value using the given formatter.

impl Display for Vec3D

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

Formats the value using the given formatter.

impl Div<f64> for Vec3D

type Output = Vec3D

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl Div for Vec3D

type Output = Vec3D

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign<f64> for Vec3D

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl DivAssign for Vec3D

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T: Into<f64>> From<(T, T, T)> for Vec3D

fn from(value: (T, T, T)) -> Self

Converts to this type from the input type.

impl FromStr for Vec3D

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Mul<Vec3D> for Transform3D

fn mul(self, rhs: Vec3D) -> Self::Output

Apply the transform to the Vec3D

type Output = Vec3D

The resulting type after applying the * operator.

impl Mul<f64> for Vec3D

type Output = Vec3D

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul for Vec3D

type Output = Vec3D

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for Vec3D

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl MulAssign for Vec3D

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Vec3D

type Output = Vec3D

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Vec3D

fn eq(&self, other: &Vec3D) -> 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 Rem for Vec3D

type Output = Vec3D

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl RemAssign for Vec3D

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Sub for Vec3D

type Output = Vec3D

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Vec3D

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for Vec3D

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Vec3D

impl StructuralPartialEq for Vec3D