Struct Vector

pub struct Vector {
    pub guid: String,
    pub name: String,
    _x: f32,
    _y: f32,
    _z: f32,
    _length: f32,
    _has_length: bool,
}

A 3D vector with visual properties and JSON serialization support.

Fields

guid: String

name: String

_x: f32

_y: f32

_z: f32

_length: f32

_has_length: bool

Implementations

impl Vector

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

Creates a new Vector with specified coordinates.

pub fn zero() -> Self

Creates a zero vector.

pub fn x_axis() -> Self

Creates a unit vector along X-axis.

Returns

Vector Unit vector (1, 0, 0).

pub fn y_axis() -> Self

Creates a unit vector along Y-axis.

Returns

Vector Unit vector (0, 1, 0).

pub fn x(&self) -> f32

Getters for coordinates

pub fn y(&self) -> f32

pub fn z(&self) -> f32

pub fn set_x(&mut self, v: f32)

Setters for coordinates (invalidate cached length)

pub fn set_y(&mut self, v: f32)

pub fn set_z(&mut self, v: f32)

pub fn z_axis() -> Self

Creates a unit vector along Z-axis.

Returns

Vector Unit vector (0, 0, 1).

pub fn from_start_and_end(start: &Vector, end: &Vector) -> Self

Creates a vector from start point to end point.

Parameters

start : &Vector The starting point. end : &Vector The ending point.

Returns

Vector The vector from start to end (end - start).

fn invalidate_length_cache(&mut self)

Invalidates the cached length when coordinates change.

pub fn compute_length(&self) -> f32

Computes the length (magnitude) of the vector without caching.

Returns

f32 The length of the vector.

pub fn magnitude(&mut self) -> f32

Gets the (cached) magnitude. Avoids recalculating if unchanged.

Returns

f32 The magnitude (length) of the vector.

pub fn length_squared(&self) -> f32

Computes the squared length of the vector (avoids sqrt for performance).

pub fn normalize_self(&mut self)

Normalizes the vector in place.

pub fn normalize(&self) -> Self

Returns a normalized copy of the vector.

pub fn reverse(&mut self)

Reverses the vector direction in place.

pub fn scale(&mut self, factor: f32)

Scales the vector by a factor.

pub fn scale_up(&mut self)

Scales the vector up by the global scale factor.

pub fn scale_down(&mut self)

Scales the vector down by the global scale factor.

pub fn dot(&self, other: &Vector) -> f32

Computes the dot product with another vector.

Parameters

other : &Vector Other vector.

Returns

f32 Dot product value.

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

Computes the cross product with another vector.

Parameters

other : &Vector Other vector.

Returns

Vector Cross product vector (orthogonal to inputs).

pub fn angle(&self, other: &Vector, sign_by_cross_product: bool) -> f32

Computes the angle between this vector and another in degrees.

pub fn projection(&self, onto: &Vector) -> (Vector, f32, Vector, f32)

Projects this vector onto another vector and returns detailed results.

Returns a tuple of:

• projection vector of self onto onto
• projected length (scalar projection)
• perpendicular projected vector (self - projection)
• perpendicular projected vector length

pub fn projection_with( &self, onto: &Vector, tolerance: f32, ) -> (Vector, f32, Vector, f32)

Same as projection but allows specifying a tolerance.

pub fn is_parallel_to(&self, other: &Vector) -> i32

Checks if this vector is parallel to another vector. Returns: 1 for parallel, -1 for antiparallel, 0 for not parallel.

pub fn get_leveled_vector(&self, vertical_height: f32) -> Vector

Gets a leveled vector (replicates statics bug with degrees passed to cos).

pub fn perpendicular_to(&mut self, v: &Vector) -> bool

Set this vector to be perpendicular to v (matches Python semantics). Returns true on success, false otherwise.

pub fn cosine_law( triangle_edge_length_a: f32, triangle_edge_length_b: f32, angle_in_degrees_between_edges: f32, degrees: bool, ) -> f32

Computes the cosine law for triangle edge length.

pub fn sine_law_angle( triangle_edge_length_a: f32, angle_in_degrees_in_front_of_a: f32, triangle_edge_length_b: f32, degrees: bool, ) -> f32

Computes the sine law for triangle angle.

pub fn sine_law_length( triangle_edge_length_a: f32, angle_in_degrees_in_front_of_a: f32, angle_in_degrees_in_front_of_b: f32, degrees: bool, ) -> f32

Computes the sine law for triangle edge length.

pub fn angle_between_vector_xy_components(vector: &Vector) -> f32

Computes the angle between vector XY components in degrees.

pub fn angle_between_vector_xy_components_degrees(vector: &Vector) -> f32

Deprecated: use angle_between_vector_xy_components.

pub fn sum_of_vectors(vectors: &[Vector]) -> Vector

Sums a collection of vectors.

pub fn coordinate_direction_3angles(&self, degrees: bool) -> [f32; 3]

Computes coordinate direction angles (alpha, beta, gamma) in degrees.

pub fn coordinate_direction_2angles(&self, degrees: bool) -> [f32; 2]

Computes coordinate direction angles (phi, theta) in degrees.

pub fn jsondump(&self) -> Result<String, Box<dyn Error>>

Serializes the Vector to a JSON string.

pub fn jsonload(json_data: &str) -> Result<Self, Box<dyn Error>>

Deserializes a Vector from a JSON string.

pub fn to_json(&self, filepath: &str) -> Result<(), Box<dyn Error>>

Serializes the Vector to a JSON file.

pub fn from_json(filepath: &str) -> Result<Self, Box<dyn Error>>

Deserializes a Vector from a JSON file.

Trait Implementations

impl Add<&Vector> for Line

type Output = Line

The resulting type after applying the + operator.

fn add(self, other: &Vector) -> Line

Performs the + operation.

impl Add<&Vector> for Polyline

fn add(self, other: &Vector) -> Polyline

Translates the polyline by a vector and returns a new polyline.

Arguments

• other - The translation vector.

type Output = Polyline

The resulting type after applying the + operator.

impl Add<Vector> for Plane

type Output = Plane

The resulting type after applying the + operator.

fn add(self, other: Vector) -> Plane

Performs the + operation.

impl Add<Vector> for Point

type Output = Point

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector> for PointCloud

type Output = PointCloud

The resulting type after applying the + operator.

fn add(self, other: Vector) -> PointCloud

Performs the + operation.

impl Add for &Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, other: &Vector) -> Vector

Performs the + operation.

impl Add for Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, other: Vector) -> Vector

Performs the + operation.

impl AddAssign<&Vector> for Line

fn add_assign(&mut self, other: &Vector)

Performs the += operation.

impl AddAssign<&Vector> for Polyline

fn add_assign(&mut self, other: &Vector)

Translates all points in the polyline by a vector.

Arguments

• other - The translation vector.

impl AddAssign<&Vector> for Vector

fn add_assign(&mut self, other: &Vector)

Performs the += operation.

impl AddAssign<Vector> for Plane

fn add_assign(&mut self, other: Vector)

Performs the += operation.

impl AddAssign<Vector> for Point

fn add_assign(&mut self, rhs: Vector)

Performs the += operation.

impl AddAssign<Vector> for PointCloud

fn add_assign(&mut self, other: Vector)

Performs the += operation.

impl AddAssign for Vector

fn add_assign(&mut self, other: Vector)

Performs the += operation.

impl Clone for Vector

fn clone(&self) -> Vector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vector

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

Formats the value using the given formatter.

impl Default for Vector

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vector

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Vector

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

Formats the value using the given formatter.

impl Div<f32> for &Vector

type Output = Vector

The resulting type after applying the / operator.

fn div(self, scalar: f32) -> Vector

Performs the / operation.

impl Div<f32> for Vector

type Output = Vector

The resulting type after applying the / operator.

fn div(self, scalar: f32) -> Vector

Performs the / operation.

impl DivAssign<f32> for Vector

fn div_assign(&mut self, scalar: f32)

Performs the /= operation.

impl Index<usize> for Vector

type Output = f32

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vector

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Mul<f32> for &Vector

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, scalar: f32) -> Vector

Performs the * operation.

impl Mul<f32> for Vector

type Output = Vector

The resulting type after applying the * operator.

fn mul(self, scalar: f32) -> Vector

Performs the * operation.

impl MulAssign<f32> for Vector

fn mul_assign(&mut self, scalar: f32)

Performs the *= operation.

impl Neg for &Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Vector

Performs the unary - operation.

impl Neg for Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Vector

Performs the unary - operation.

impl PartialEq for Vector

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Vector> for Line

type Output = Line

The resulting type after applying the - operator.

fn sub(self, other: &Vector) -> Line

Performs the - operation.

impl Sub<&Vector> for Polyline

fn sub(self, other: &Vector) -> Polyline

Translates the polyline by the negative of a vector and returns a new polyline.

Arguments

• other - The vector to subtract.

type Output = Polyline

The resulting type after applying the - operator.

impl Sub<Vector> for Plane

type Output = Plane

The resulting type after applying the - operator.

fn sub(self, other: Vector) -> Plane

Performs the - operation.

impl Sub<Vector> for Point

type Output = Point

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector> for PointCloud

type Output = PointCloud

The resulting type after applying the - operator.

fn sub(self, other: Vector) -> PointCloud

Performs the - operation.

impl Sub for &Vector

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, other: &Vector) -> Vector

Performs the - operation.

impl Sub for Vector

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, other: Vector) -> Vector

Performs the - operation.

impl SubAssign<&Vector> for Line

fn sub_assign(&mut self, other: &Vector)

Performs the -= operation.

impl SubAssign<&Vector> for Polyline

fn sub_assign(&mut self, other: &Vector)

Translates all points in the polyline by the negative of a vector.

Arguments

• other - The vector to subtract.

impl SubAssign<&Vector> for Vector

fn sub_assign(&mut self, other: &Vector)

Performs the -= operation.

impl SubAssign<Vector> for Plane

fn sub_assign(&mut self, other: Vector)

Performs the -= operation.

impl SubAssign<Vector> for Point

fn sub_assign(&mut self, rhs: Vector)

Performs the -= operation.

impl SubAssign<Vector> for PointCloud

fn sub_assign(&mut self, other: Vector)

Performs the -= operation.

impl SubAssign for Vector

fn sub_assign(&mut self, other: Vector)

Performs the -= operation.

impl StructuralPartialEq for Vector