Struct Vec3

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

Used to represent an exact position in the world where an entity could be. For blocks, BlockPos is used instead.

Fields

x: f64

y: f64

z: f64

Implementations

impl Vec3

pub fn with_delta(&self, delta: &impl PositionDeltaTrait) -> Vec3

pub fn length_squared(&self) -> f64

pub fn normalize(&self) -> Vec3

pub fn multiply(&self, x: f64, y: f64, z: f64) -> Vec3

pub fn scale(&self, amount: f64) -> Vec3

impl Vec3

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

pub fn length_sqr(&self) -> f64

Get the distance of this vector to the origin by doing x^2 + y^2 + z^2.

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

Get the squared distance from this position to another position. Equivalent to (self - other).length_sqr().

pub fn horizontal_distance_sqr(&self) -> f64

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

pub fn down(&self, y: f64) -> Self

Return a new instance of this position with the y coordinate decreased by the given number.

pub fn up(&self, y: f64) -> Self

Return a new instance of this position with the y coordinate increased by the given number.

pub fn north(&self, z: f64) -> Self

Return a new instance of this position with the z coordinate subtracted by the given number.

pub fn east(&self, x: f64) -> Self

Return a new instance of this position with the x coordinate increased by the given number.

pub fn south(&self, z: f64) -> Self

Return a new instance of this position with the z coordinate increased by the given number.

pub fn west(&self, x: f64) -> Self

Return a new instance of this position with the x coordinate subtracted by the given number.

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

impl Vec3

pub fn length(&self) -> f64

Get the distance of this vector to the origin by doing sqrt(x^2 + y^2 + z^2).

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

Get the distance from this position to another position. Equivalent to (self - other).length().

Trait Implementations

impl Add for &Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Default for Vec3

fn default() -> Vec3

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vec3

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Vec3

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

Display a position as x y z.

impl From<&(f64, f64, f64)> for Vec3

fn from(pos: &(f64, f64, f64)) -> Self

Converts to this type from the input type.

impl From<&Vec3> for BlockPos

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.

impl From<&Vec3> for ChunkBlockPos

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.

impl From<&Vec3> for ChunkPos

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.

impl From<(f64, f64, f64)> for Vec3

fn from(pos: (f64, f64, f64)) -> Self

Converts to this type from the input type.

impl From<Vec3> for (f64, f64, f64)

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for BlockPos

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for ChunkBlockPos

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for ChunkPos

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl FromStr for Vec3

Parses a string in the format “X Y Z” into a Vec3.

The input string should contain three floating-point values separated by spaces, representing the x, y, and z components of the vector respectively. This can be used to parse user input or from Vec3::to_string.

type Err = &'static str

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 McBufReadable for Vec3

fn read_from(buf: &mut Cursor<&[u8]>) -> Result<Self, BufReadError>

impl McBufWritable for Vec3

fn write_into(&self, buf: &mut impl Write) -> Result<(), Error>

impl Mul<f64> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Vec3

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Rem<f64> for Vec3

type Output = Vec3

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for Vec3

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for &Vec3

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

Find the difference between two positions.

type Output = Vec3

The resulting type after applying the - operator.

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Vec3

impl StructuralPartialEq for Vec3