import{_ as s,c as i,o as a,a4 as t}from"./chunks/framework.DpC1ZpOZ.js";const E=JSON.parse('{"title":"mbcp.mp_math.vector","description":"","frontmatter":{"title":"mbcp.mp_math.vector","lastUpdated":false},"headers":[],"relativePath":"en/api/mp_math/vector.md","filePath":"en/api/mp_math/vector.md"}'),n={name:"en/api/mp_math/vector.md"},e=t(`

mbcp.mp_math.vector ​

Description: 本模块定义了3维向量的类Vector3，以及一些常用的向量。

class Vector3 ​

func __init__(self, x: float, y: float, z: float) ​

Description: 3维向量

Arguments:

Source code or View on GitHub
python
def __init__(self, x: float, y: float, z: float):
    """
        3维向量
        Args:
            x ([\`float\`](https%3A//docs.python.org/3/library/functions.html#float)): x轴分量
            y (\`float\`): y轴分量
            z (\`float\`): z轴分量
        """
    self.x = x
    self.y = y
    self.z = z

func approx(self, other: Vector3, epsilon: float = APPROX) -> bool ​

Description: 判断两个向量是否近似相等。

Arguments:

Return: bool: 是否近似相等

Source code or View on GitHub
python
def approx(self, other: 'Vector3', epsilon: float=APPROX) -> bool:
    """
        判断两个向量是否近似相等。
        Args:
            other ([\`Vector3\`](#class-vector3)): 另一个向量
            epsilon ([\`float\`](https%3A//docs.python.org/3/library/functions.html#float)): 误差

        Returns:
            [\`bool\`](https%3A//docs.python.org/3/library/functions.html#bool): 是否近似相等
        """
    return all([abs(self.x - other.x) < epsilon, abs(self.y - other.y) < epsilon, abs(self.z - other.z) < epsilon])

func cal_angle(self, other: Vector3) -> AnyAngle ​

Description: 计算两个向量之间的夹角。

Arguments:

Return: AnyAngle: 夹角

Source code or View on GitHub
python
def cal_angle(self, other: 'Vector3') -> 'AnyAngle':
    """
        计算两个向量之间的夹角。
        Args:
            other ([\`Vector3\`](#class-vector3)): 另一个向量
        Returns:
            [\`AnyAngle\`](./angle#class-anyangle): 夹角
        """
    return AnyAngle(math.acos(self @ other / (self.length * other.length)), is_radian=True)

func cross(self, other: Vector3) -> Vector3 ​

Description: 向量积 叉乘：v1 cross v2 -> v3

叉乘为0，则两向量平行。 其余结果的模为平行四边形的面积。

Arguments:

Return: Vector3: 叉乘结果

Source code or View on GitHub
python
def cross(self, other: 'Vector3') -> 'Vector3':
    """
        向量积 叉乘：v1 cross v2 -> v3

        叉乘为0，则两向量平行。
        其余结果的模为平行四边形的面积。

        返回如下行列式的结果：

        \`\`i  j  k\`\`

        \`\`x1 y1 z1\`\`

        \`\`x2 y2 z2\`\`

        Args:
            other ([\`Vector3\`](#class-vector3)): 另一个向量
        Returns:
            [\`Vector3\`](#class-vector3): 叉乘结果
        """
    return Vector3(self.y * other.z - self.z * other.y, self.z * other.x - self.x * other.z, self.x * other.y - self.y * other.x)

func is_approx_parallel(self, other: Vector3, epsilon: float = APPROX) -> bool ​

Description: 判断两个向量是否近似平行。

Arguments:

Return: bool: 是否近似平行

Source code or View on GitHub
python
def is_approx_parallel(self, other: 'Vector3', epsilon: float=APPROX) -> bool:
    """
        判断两个向量是否近似平行。
        Args:
            other ([\`Vector3\`](#class-vector3)): 另一个向量
            epsilon ([\`float\`](https%3A//docs.python.org/3/library/functions.html#float)): 误差
        Returns:
            [\`bool\`](https%3A//docs.python.org/3/library/functions.html#bool): 是否近似平行
        """
    return self.cross(other).length < epsilon

func is_parallel(self, other: Vector3) -> bool ​

Description: 判断两个向量是否平行。

Arguments:

Return: bool: 是否平行

Source code or View on GitHub
python
def is_parallel(self, other: 'Vector3') -> bool:
    """
        判断两个向量是否平行。
        Args:
            other ([\`Vector3\`](#class-vector3)): 另一个向量
        Returns:
            [\`bool\`](https%3A//docs.python.org/3/library/functions.html#bool): 是否平行
        """
    return self.cross(other).approx(zero_vector3)

func normalize(self) ​

Description: 将向量归一化。

自体归一化，不返回值。

Source code or View on GitHub
python
def normalize(self):
    """
        将向量归一化。

        自体归一化，不返回值。
        """
    length = self.length
    self.x /= length
    self.y /= length
    self.z /= length

@property

func np_array(self) -> np.ndarray ​

Return: np.ndarray: numpy数组

Source code or View on GitHub
python
@property
def np_array(self) -> 'np.ndarray':
    """
        返回numpy数组
        Returns:
            [\`np.ndarray\`](https%3A//numpy.org/doc/stable/reference/generated/numpy.ndarray.html): numpy数组
        """
    return np.array([self.x, self.y, self.z])

@property

func length(self) -> float ​

Description: 向量的模。

Return: float: 模

Source code or View on GitHub
python
@property
def length(self) -> float:
    """
        向量的模。
        Returns:
            [\`float\`](https%3A//docs.python.org/3/library/functions.html#float): 模
        """
    return math.sqrt(self.x ** 2 + self.y ** 2 + self.z ** 2)

@property

func unit(self) -> Vector3 ​

Description: 获取该向量的单位向量。

Return: Vector3: 单位向量

Source code or View on GitHub
python
@property
def unit(self) -> 'Vector3':
    """
        获取该向量的单位向量。
        Returns:
            [\`Vector3\`](#class-vector3): 单位向量
        """
    return self / self.length

func __abs__(self) ​

Source code or View on GitHub
python
def __abs__(self):
    return self.length

@overload

func self + other: Vector3 => Vector3 ​

Source code or View on GitHub
python
@overload
def __add__(self, other: 'Vector3') -> 'Vector3':
    ...

@overload

func self + other: Point3 => Point3 ​

Source code or View on GitHub
python
@overload
def __add__(self, other: 'Point3') -> 'Point3':
    ...

func self + other ​

Description: V + P -> P

V + V -> V

Arguments:

Return: Vector3 | Point3: 新的向量或点

Source code or View on GitHub
python
def __add__(self, other):
    """
        V + P -> P

        V + V -> V
        Args:
            other ([\`Vector3\`](#class-vector3) | [\`Point3\`](./point#class-point3)): 另一个向量或点
        Returns:
            [\`Vector3\`](#class-vector3) | [\`Point3\`](./point#class-point3): 新的向量或点
        """
    if isinstance(other, Vector3):
        return Vector3(self.x + other.x, self.y + other.y, self.z + other.z)
    elif isinstance(other, Point3):
        return Point3(self.x + other.x, self.y + other.y, self.z + other.z)
    else:
        raise TypeError(f"unsupported operand type(s) for +: 'Vector3' and '{type(other)}'")

func __eq__(self, other) ​

Description: 判断两个向量是否相等。

Arguments:

Return: bool: 是否相等

Source code or View on GitHub
python
def __eq__(self, other):
    """
        判断两个向量是否相等。
        Args:
            other ([\`Vector3\`](#class-vector3)): 另一个向量
        Returns:
            [\`bool\`](https%3A//docs.python.org/3/library/functions.html#bool): 是否相等
        """
    return approx(self.x, other.x) and approx(self.y, other.y) and approx(self.z, other.z)

func self + other: Point3 => Point3 ​

Description: P + V -> P

别去点那边实现了。

Arguments:

Return: Point3: 新的点

Source code or View on GitHub
python
def __radd__(self, other: 'Point3') -> 'Point3':
    """
        P + V -> P

        别去点那边实现了。
        Args:
            other ([\`Point3\`](./point#class-point3)): 另一个点
        Returns:
            [\`Point3\`](./point#class-point3): 新的点
        """
    return Point3(self.x + other.x, self.y + other.y, self.z + other.z)

@overload

func self - other: Vector3 => Vector3 ​

Source code or View on GitHub
python
@overload
def __sub__(self, other: 'Vector3') -> 'Vector3':
    ...

@overload

func self - other: Point3 => Point3 ​

Source code or View on GitHub
python
@overload
def __sub__(self, other: 'Point3') -> 'Point3':
    ...

func self - other ​

Description: V - P -> P

V - V -> V

Arguments:

Return: Vector3 | Point3: 新的向量

Source code or View on GitHub
python
def __sub__(self, other):
    """
        V - P -> P

        V - V -> V
        Args:
            other ([\`Vector3\`](#class-vector3) | [\`Point3\`](./point#class-point3)): 另一个向量或点
        Returns:
            [\`Vector3\`](#class-vector3) | [\`Point3\`](./point#class-point3): 新的向量
        """
    if isinstance(other, Vector3):
        return Vector3(self.x - other.x, self.y - other.y, self.z - other.z)
    elif isinstance(other, Point3):
        return Point3(self.x - other.x, self.y - other.y, self.z - other.z)
    else:
        raise TypeError(f'unsupported operand type(s) for -: "Vector3" and "{type(other)}"')

func self - other: Point3 ​

Description: P - V -> P

Arguments:

Return: Point3: 新的点

Source code or View on GitHub
python
def __rsub__(self, other: 'Point3'):
    """
        P - V -> P
        Args:
            other ([\`Point3\`](./point#class-point3)): 另一个点
        Returns:
            [\`Point3\`](./point#class-point3): 新的点
        """
    if isinstance(other, Point3):
        return Point3(other.x - self.x, other.y - self.y, other.z - self.z)
    else:
        raise TypeError(f"unsupported operand type(s) for -: '{type(other)}' and 'Vector3'")

@overload

func self * other: Vector3 => Vector3 ​

Source code or View on GitHub
python
@overload
def __mul__(self, other: 'Vector3') -> 'Vector3':
    ...

@overload

func self * other: RealNumber => Vector3 ​

Source code or View on GitHub
python
@overload
def __mul__(self, other: RealNumber) -> 'Vector3':
    ...

func self * other: int | float | Vector3 => Vector3 ​

Description: 数组运算 非点乘。点乘使用@，叉乘使用cross。

Arguments:

Return: Vector3: 数组运算结果

Source code or View on GitHub
python
def __mul__(self, other: 'int | float | Vector3') -> 'Vector3':
    """
        数组运算 非点乘。点乘使用@，叉乘使用cross。
        Args:
            other ([\`Vector3\`](#class-vector3) | [\`float\`](https%3A//docs.python.org/3/library/functions.html#float)): 另一个向量或数
        Returns:
            [\`Vector3\`](#class-vector): 数组运算结果
        """
    if isinstance(other, Vector3):
        return Vector3(self.x * other.x, self.y * other.y, self.z * other.z)
    elif isinstance(other, (float, int)):
        return Vector3(self.x * other, self.y * other, self.z * other)
    else:
        raise TypeError(f"unsupported operand type(s) for *: 'Vector3' and '{type(other)}'")

func self * other: RealNumber => Vector3 ​

Source code or View on GitHub
python
def __rmul__(self, other: 'RealNumber') -> 'Vector3':
    return self.__mul__(other)

func self @ other: Vector3 => RealNumber ​

Description: 点乘。

Arguments:

Return: float: 点乘结果

Source code or View on GitHub
python
def __matmul__(self, other: 'Vector3') -> 'RealNumber':
    """
        点乘。
        Args:
            other ([\`Vector3\`](#class-vector3)): 另一个向量
        Returns:
            [\`float\`](https%3A//docs.python.org/3/library/functions.html#float): 点乘结果
        """
    return self.x * other.x + self.y * other.y + self.z * other.z

func self / other: RealNumber => Vector3 ​

Source code or View on GitHub
python
def __truediv__(self, other: RealNumber) -> 'Vector3':
    return Vector3(self.x / other, self.y / other, self.z / other)

func - self => Vector3 ​

Description: 取负。

Return: Vector3: 负向量

Source code or View on GitHub
python
def __neg__(self) -> 'Vector3':
    """
        取负。
        Returns:
            [\`Vector3\`](#class-vector3): 负向量
        """
    return Vector3(-self.x, -self.y, -self.z)

var zero_vector3 ​

var x_axis ​

var y_axis ​

var z_axis ​

`,138),l=[e];function h(p,k,r,o,d,c){return a(),i("div",null,l)}const y=s(n,[["render",h]]);export{E as __pageData,y as default};