518 lines
16 KiB
Python
518 lines
16 KiB
Python
# Copyright (c) 2018-2024 Manfred Moitzi
|
|
# License: MIT License
|
|
from __future__ import annotations
|
|
from typing import TYPE_CHECKING, Sequence, Iterable, Optional, Iterator
|
|
from ezdxf.math import Vec3, UVec, X_AXIS, Y_AXIS, Z_AXIS, Matrix44
|
|
from ezdxf.colors import RGB
|
|
|
|
if TYPE_CHECKING:
|
|
from ezdxf.layouts import BaseLayout
|
|
|
|
__all__ = ["OCS", "UCS", "PassTroughUCS"]
|
|
|
|
|
|
def render_axis(
|
|
layout: BaseLayout,
|
|
start: UVec,
|
|
points: Sequence[UVec],
|
|
colors: RGB = RGB(1, 3, 5),
|
|
) -> None:
|
|
for point, color in zip(points, colors):
|
|
layout.add_line(start, point, dxfattribs={"color": color})
|
|
|
|
|
|
_1_OVER_64 = 1.0 / 64.0
|
|
|
|
|
|
class OCS:
|
|
"""Establish an :ref:`OCS` for a given extrusion vector.
|
|
|
|
Args:
|
|
extrusion: extrusion vector.
|
|
|
|
"""
|
|
|
|
def __init__(self, extrusion: UVec = Z_AXIS):
|
|
Az = Vec3(extrusion).normalize()
|
|
self.transform = not Az.isclose(Z_AXIS)
|
|
if self.transform:
|
|
if (abs(Az.x) < _1_OVER_64) and (abs(Az.y) < _1_OVER_64):
|
|
Ax = Y_AXIS.cross(Az)
|
|
else:
|
|
Ax = Z_AXIS.cross(Az)
|
|
Ax = Ax.normalize()
|
|
Ay = Az.cross(Ax).normalize()
|
|
self.matrix = Matrix44.ucs(Ax, Ay, Az)
|
|
|
|
@property
|
|
def ux(self) -> Vec3:
|
|
"""x-axis unit vector"""
|
|
return self.matrix.ux if self.transform else X_AXIS
|
|
|
|
@property
|
|
def uy(self) -> Vec3:
|
|
"""y-axis unit vector"""
|
|
return self.matrix.uy if self.transform else Y_AXIS
|
|
|
|
@property
|
|
def uz(self) -> Vec3:
|
|
"""z-axis unit vector"""
|
|
return self.matrix.uz if self.transform else Z_AXIS
|
|
|
|
def from_wcs(self, point: UVec) -> Vec3:
|
|
"""Returns OCS vector for WCS `point`."""
|
|
p3 = Vec3(point)
|
|
if self.transform:
|
|
return self.matrix.ocs_from_wcs(p3)
|
|
else:
|
|
return p3
|
|
|
|
def points_from_wcs(self, points: Iterable[UVec]) -> Iterator[Vec3]:
|
|
"""Returns iterable of OCS vectors from WCS `points`."""
|
|
_points = Vec3.generate(points)
|
|
if self.transform:
|
|
from_wcs = self.matrix.ocs_from_wcs
|
|
for point in _points:
|
|
yield from_wcs(point)
|
|
else:
|
|
yield from _points
|
|
|
|
def to_wcs(self, point: UVec) -> Vec3:
|
|
"""Returns WCS vector for OCS `point`."""
|
|
if self.transform:
|
|
return self.matrix.ocs_to_wcs(point)
|
|
else:
|
|
return Vec3(point)
|
|
|
|
def points_to_wcs(self, points: Iterable[UVec]) -> Iterator[Vec3]:
|
|
"""Returns iterable of WCS vectors for OCS `points`."""
|
|
_points = Vec3.generate(points)
|
|
if self.transform:
|
|
to_wcs = self.matrix.ocs_to_wcs
|
|
for point in _points:
|
|
yield to_wcs(point)
|
|
else:
|
|
yield from _points
|
|
|
|
def render_axis(
|
|
self,
|
|
layout: BaseLayout,
|
|
length: float = 1,
|
|
colors: RGB = RGB(1, 3, 5),
|
|
) -> None:
|
|
"""Render axis as 3D lines into a `layout`."""
|
|
render_axis(
|
|
layout,
|
|
start=(0, 0, 0),
|
|
points=(
|
|
self.to_wcs(X_AXIS * length),
|
|
self.to_wcs(Y_AXIS * length),
|
|
self.to_wcs(Z_AXIS * length),
|
|
),
|
|
colors=colors,
|
|
)
|
|
|
|
|
|
class UCS:
|
|
"""Establish a user coordinate system (:ref:`UCS`). The UCS is defined by
|
|
the origin and two unit vectors for the x-, y- or z-axis, all axis in
|
|
:ref:`WCS`. The missing axis is the cross product of the given axis.
|
|
|
|
If x- and y-axis are ``None``: ux = ``(1, 0, 0)``, uy = ``(0, 1, 0)``,
|
|
uz = ``(0, 0, 1)``.
|
|
|
|
Unit vectors don't have to be normalized, normalization is done at
|
|
initialization, this is also the reason why scaling gets lost by copying or
|
|
rotating.
|
|
|
|
Args:
|
|
origin: defines the UCS origin in world coordinates
|
|
ux: defines the UCS x-axis as vector in :ref:`WCS`
|
|
uy: defines the UCS y-axis as vector in :ref:`WCS`
|
|
uz: defines the UCS z-axis as vector in :ref:`WCS`
|
|
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
origin: UVec = (0, 0, 0),
|
|
ux: Optional[UVec] = None,
|
|
uy: Optional[UVec] = None,
|
|
uz: Optional[UVec] = None,
|
|
):
|
|
if ux is None and uy is None:
|
|
_ux: Vec3 = X_AXIS
|
|
_uy: Vec3 = Y_AXIS
|
|
_uz: Vec3 = Z_AXIS
|
|
elif ux is None:
|
|
_uy = Vec3(uy).normalize()
|
|
_uz = Vec3(uz).normalize()
|
|
_ux = Vec3(uy).cross(uz).normalize()
|
|
elif uy is None:
|
|
_ux = Vec3(ux).normalize()
|
|
_uz = Vec3(uz).normalize()
|
|
_uy = Vec3(uz).cross(ux).normalize()
|
|
elif uz is None:
|
|
_ux = Vec3(ux).normalize()
|
|
_uy = Vec3(uy).normalize()
|
|
_uz = Vec3(ux).cross(uy).normalize()
|
|
else: # all axis are given
|
|
_ux = Vec3(ux).normalize()
|
|
_uy = Vec3(uy).normalize()
|
|
_uz = Vec3(uz).normalize()
|
|
|
|
self.matrix: Matrix44 = Matrix44.ucs(_ux, _uy, _uz, Vec3(origin))
|
|
|
|
@property
|
|
def ux(self) -> Vec3:
|
|
"""x-axis unit vector"""
|
|
return self.matrix.ux
|
|
|
|
@property
|
|
def uy(self) -> Vec3:
|
|
"""y-axis unit vector"""
|
|
return self.matrix.uy
|
|
|
|
@property
|
|
def uz(self) -> Vec3:
|
|
"""z-axis unit vector"""
|
|
return self.matrix.uz
|
|
|
|
@property
|
|
def origin(self) -> Vec3:
|
|
"""Returns the origin"""
|
|
return self.matrix.origin
|
|
|
|
@origin.setter
|
|
def origin(self, v: UVec) -> None:
|
|
"""Set origin."""
|
|
self.matrix.origin = v
|
|
|
|
def copy(self) -> UCS:
|
|
"""Returns a copy of this UCS."""
|
|
return UCS(self.origin, self.ux, self.uy, self.uz)
|
|
|
|
def to_wcs(self, point: Vec3) -> Vec3:
|
|
"""Returns WCS point for UCS `point`."""
|
|
return self.matrix.transform(point)
|
|
|
|
def points_to_wcs(self, points: Iterable[Vec3]) -> Iterator[Vec3]:
|
|
"""Returns iterable of WCS vectors for UCS `points`."""
|
|
return self.matrix.transform_vertices(points)
|
|
|
|
def direction_to_wcs(self, vector: Vec3) -> Vec3:
|
|
"""Returns WCS direction for UCS `vector` without origin adjustment."""
|
|
return self.matrix.transform_direction(vector)
|
|
|
|
def from_wcs(self, point: Vec3) -> Vec3:
|
|
"""Returns UCS point for WCS `point`."""
|
|
return self.matrix.ucs_vertex_from_wcs(point)
|
|
|
|
def points_from_wcs(self, points: Iterable[Vec3]) -> Iterator[Vec3]:
|
|
"""Returns iterable of UCS vectors from WCS `points`."""
|
|
from_wcs = self.from_wcs
|
|
for point in points:
|
|
yield from_wcs(point)
|
|
|
|
def direction_from_wcs(self, vector: Vec3) -> Vec3:
|
|
"""Returns UCS vector for WCS `vector` without origin adjustment."""
|
|
return self.matrix.ucs_direction_from_wcs(vector)
|
|
|
|
def to_ocs(self, point: Vec3) -> Vec3:
|
|
"""Returns OCS vector for UCS `point`.
|
|
|
|
The :class:`OCS` is defined by the z-axis of the :class:`UCS`.
|
|
|
|
"""
|
|
wpoint = self.to_wcs(point)
|
|
return OCS(self.uz).from_wcs(wpoint)
|
|
|
|
def points_to_ocs(self, points: Iterable[Vec3]) -> Iterator[Vec3]:
|
|
"""Returns iterable of OCS vectors for UCS `points`.
|
|
|
|
The :class:`OCS` is defined by the z-axis of the :class:`UCS`.
|
|
|
|
Args:
|
|
points: iterable of UCS vertices
|
|
|
|
"""
|
|
wcs = self.to_wcs
|
|
ocs = OCS(self.uz)
|
|
for point in points:
|
|
yield ocs.from_wcs(wcs(point))
|
|
|
|
def to_ocs_angle_deg(self, angle: float) -> float:
|
|
"""Transforms `angle` from current UCS to the parent coordinate system
|
|
(most likely the WCS) including the transformation to the OCS
|
|
established by the extrusion vector :attr:`UCS.uz`.
|
|
|
|
Args:
|
|
angle: in UCS in degrees
|
|
|
|
"""
|
|
return self.ucs_direction_to_ocs_direction(
|
|
Vec3.from_deg_angle(angle)
|
|
).angle_deg
|
|
|
|
def to_ocs_angle_rad(self, angle: float) -> float:
|
|
"""Transforms `angle` from current UCS to the parent coordinate system
|
|
(most likely the WCS) including the transformation to the OCS
|
|
established by the extrusion vector :attr:`UCS.uz`.
|
|
|
|
Args:
|
|
angle: in UCS in radians
|
|
|
|
"""
|
|
return self.ucs_direction_to_ocs_direction(Vec3.from_angle(angle)).angle
|
|
|
|
def ucs_direction_to_ocs_direction(self, direction: Vec3) -> Vec3:
|
|
"""Transforms UCS `direction` vector into OCS direction vector of the
|
|
parent coordinate system (most likely the WCS), target OCS is defined by
|
|
the UCS z-axis.
|
|
"""
|
|
return OCS(self.uz).from_wcs(self.direction_to_wcs(direction))
|
|
|
|
def rotate(self, axis: UVec, angle: float) -> UCS:
|
|
"""Returns a new rotated UCS, with the same origin as the source UCS.
|
|
The rotation vector is located in the origin and has :ref:`WCS`
|
|
coordinates e.g. (0, 0, 1) is the WCS z-axis as rotation vector.
|
|
|
|
Args:
|
|
axis: arbitrary rotation axis as vector in :ref:`WCS`
|
|
angle: rotation angle in radians
|
|
|
|
"""
|
|
t = Matrix44.axis_rotate(Vec3(axis), angle)
|
|
ux, uy, uz = t.transform_vertices([self.ux, self.uy, self.uz])
|
|
return UCS(origin=self.origin, ux=ux, uy=uy, uz=uz)
|
|
|
|
def rotate_local_x(self, angle: float) -> UCS:
|
|
"""Returns a new rotated UCS, rotation axis is the local x-axis.
|
|
|
|
Args:
|
|
angle: rotation angle in radians
|
|
|
|
"""
|
|
t = Matrix44.axis_rotate(self.ux, angle)
|
|
uy, uz = t.transform_vertices([self.uy, self.uz])
|
|
return UCS(origin=self.origin, ux=self.ux, uy=uy, uz=uz)
|
|
|
|
def rotate_local_y(self, angle: float) -> UCS:
|
|
"""Returns a new rotated UCS, rotation axis is the local y-axis.
|
|
|
|
Args:
|
|
angle: rotation angle in radians
|
|
|
|
"""
|
|
t = Matrix44.axis_rotate(self.uy, angle)
|
|
ux, uz = t.transform_vertices([self.ux, self.uz])
|
|
return UCS(origin=self.origin, ux=ux, uy=self.uy, uz=uz)
|
|
|
|
def rotate_local_z(self, angle: float) -> UCS:
|
|
"""Returns a new rotated UCS, rotation axis is the local z-axis.
|
|
|
|
Args:
|
|
angle: rotation angle in radians
|
|
|
|
"""
|
|
t = Matrix44.axis_rotate(self.uz, angle)
|
|
ux, uy = t.transform_vertices([self.ux, self.uy])
|
|
return UCS(origin=self.origin, ux=ux, uy=uy, uz=self.uz)
|
|
|
|
def shift(self, delta: UVec) -> UCS:
|
|
"""Shifts current UCS by `delta` vector and returns `self`.
|
|
|
|
Args:
|
|
delta: shifting vector
|
|
|
|
"""
|
|
self.origin += Vec3(delta)
|
|
return self
|
|
|
|
def moveto(self, location: UVec) -> UCS:
|
|
"""Place current UCS at new origin `location` and returns `self`.
|
|
|
|
Args:
|
|
location: new origin in WCS
|
|
|
|
"""
|
|
self.origin = Vec3(location)
|
|
return self
|
|
|
|
def transform(self, m: Matrix44) -> UCS:
|
|
"""General inplace transformation interface, returns `self` (floating
|
|
interface).
|
|
|
|
Args:
|
|
m: 4x4 transformation matrix (:class:`ezdxf.math.Matrix44`)
|
|
|
|
"""
|
|
self.matrix *= m
|
|
return self
|
|
|
|
@property
|
|
def is_cartesian(self) -> bool:
|
|
"""Returns ``True`` if cartesian coordinate system."""
|
|
return self.matrix.is_cartesian
|
|
|
|
@staticmethod
|
|
def from_x_axis_and_point_in_xy(
|
|
origin: UVec, axis: UVec, point: UVec
|
|
) -> UCS:
|
|
"""Returns a new :class:`UCS` defined by the origin, the x-axis vector
|
|
and an arbitrary point in the xy-plane.
|
|
|
|
Args:
|
|
origin: UCS origin as (x, y, z) tuple in :ref:`WCS`
|
|
axis: x-axis vector as (x, y, z) tuple in :ref:`WCS`
|
|
point: arbitrary point unlike the origin in the xy-plane as
|
|
(x, y, z) tuple in :ref:`WCS`
|
|
|
|
"""
|
|
x_axis = Vec3(axis)
|
|
z_axis = x_axis.cross(Vec3(point) - origin)
|
|
return UCS(origin=origin, ux=x_axis, uz=z_axis)
|
|
|
|
@staticmethod
|
|
def from_x_axis_and_point_in_xz(
|
|
origin: UVec, axis: UVec, point: UVec
|
|
) -> UCS:
|
|
"""Returns a new :class:`UCS` defined by the origin, the x-axis vector
|
|
and an arbitrary point in the xz-plane.
|
|
|
|
Args:
|
|
origin: UCS origin as (x, y, z) tuple in :ref:`WCS`
|
|
axis: x-axis vector as (x, y, z) tuple in :ref:`WCS`
|
|
point: arbitrary point unlike the origin in the xz-plane as
|
|
(x, y, z) tuple in :ref:`WCS`
|
|
|
|
"""
|
|
x_axis = Vec3(axis)
|
|
xz_vector = Vec3(point) - origin
|
|
y_axis = xz_vector.cross(x_axis)
|
|
return UCS(origin=origin, ux=x_axis, uy=y_axis)
|
|
|
|
@staticmethod
|
|
def from_y_axis_and_point_in_xy(
|
|
origin: UVec, axis: UVec, point: UVec
|
|
) -> UCS:
|
|
"""Returns a new :class:`UCS` defined by the origin, the y-axis vector
|
|
and an arbitrary point in the xy-plane.
|
|
|
|
Args:
|
|
origin: UCS origin as (x, y, z) tuple in :ref:`WCS`
|
|
axis: y-axis vector as (x, y, z) tuple in :ref:`WCS`
|
|
point: arbitrary point unlike the origin in the xy-plane as
|
|
(x, y, z) tuple in :ref:`WCS`
|
|
|
|
"""
|
|
y_axis = Vec3(axis)
|
|
xy_vector = Vec3(point) - origin
|
|
z_axis = xy_vector.cross(y_axis)
|
|
return UCS(origin=origin, uy=y_axis, uz=z_axis)
|
|
|
|
@staticmethod
|
|
def from_y_axis_and_point_in_yz(
|
|
origin: UVec, axis: UVec, point: UVec
|
|
) -> UCS:
|
|
"""Returns a new :class:`UCS` defined by the origin, the y-axis vector
|
|
and an arbitrary point in the yz-plane.
|
|
|
|
Args:
|
|
origin: UCS origin as (x, y, z) tuple in :ref:`WCS`
|
|
axis: y-axis vector as (x, y, z) tuple in :ref:`WCS`
|
|
point: arbitrary point unlike the origin in the yz-plane as
|
|
(x, y, z) tuple in :ref:`WCS`
|
|
|
|
"""
|
|
y_axis = Vec3(axis)
|
|
yz_vector = Vec3(point) - origin
|
|
x_axis = yz_vector.cross(y_axis)
|
|
return UCS(origin=origin, ux=x_axis, uy=y_axis)
|
|
|
|
@staticmethod
|
|
def from_z_axis_and_point_in_xz(
|
|
origin: UVec, axis: UVec, point: UVec
|
|
) -> UCS:
|
|
"""Returns a new :class:`UCS` defined by the origin, the z-axis vector
|
|
and an arbitrary point in the xz-plane.
|
|
|
|
Args:
|
|
origin: UCS origin as (x, y, z) tuple in :ref:`WCS`
|
|
axis: z-axis vector as (x, y, z) tuple in :ref:`WCS`
|
|
point: arbitrary point unlike the origin in the xz-plane as
|
|
(x, y, z) tuple in :ref:`WCS`
|
|
|
|
"""
|
|
z_axis = Vec3(axis)
|
|
y_axis = z_axis.cross(Vec3(point) - origin)
|
|
return UCS(origin=origin, uy=y_axis, uz=z_axis)
|
|
|
|
@staticmethod
|
|
def from_z_axis_and_point_in_yz(
|
|
origin: UVec, axis: UVec, point: UVec
|
|
) -> UCS:
|
|
"""Returns a new :class:`UCS` defined by the origin, the z-axis vector
|
|
and an arbitrary point in the yz-plane.
|
|
|
|
Args:
|
|
origin: UCS origin as (x, y, z) tuple in :ref:`WCS`
|
|
axis: z-axis vector as (x, y, z) tuple in :ref:`WCS`
|
|
point: arbitrary point unlike the origin in the yz-plane as
|
|
(x, y, z) tuple in :ref:`WCS`
|
|
|
|
"""
|
|
z_axis = Vec3(axis)
|
|
yz_vector = Vec3(point) - origin
|
|
x_axis = yz_vector.cross(z_axis)
|
|
return UCS(origin=origin, ux=x_axis, uz=z_axis)
|
|
|
|
def render_axis(
|
|
self,
|
|
layout: BaseLayout,
|
|
length: float = 1,
|
|
colors: RGB = RGB(1, 3, 5),
|
|
):
|
|
"""Render axis as 3D lines into a `layout`."""
|
|
render_axis(
|
|
layout,
|
|
start=self.origin,
|
|
points=(
|
|
self.to_wcs(X_AXIS * length),
|
|
self.to_wcs(Y_AXIS * length),
|
|
self.to_wcs(Z_AXIS * length),
|
|
),
|
|
colors=colors,
|
|
)
|
|
|
|
|
|
class PassTroughUCS(UCS):
|
|
"""UCS is equal to the WCS and OCS (extrusion = 0, 0, 1)"""
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def to_wcs(self, point: Vec3) -> Vec3:
|
|
return point
|
|
|
|
def points_to_wcs(self, points: Iterable[Vec3]) -> Iterator[Vec3]:
|
|
return iter(points)
|
|
|
|
def to_ocs(self, point: Vec3) -> Vec3:
|
|
return point
|
|
|
|
def points_to_ocs(self, points: Iterable[Vec3]) -> Iterator[Vec3]:
|
|
return iter(points)
|
|
|
|
def to_ocs_angle_deg(self, angle: float) -> float:
|
|
return angle
|
|
|
|
def to_ocs_angle_rad(self, angle: float) -> float:
|
|
return angle
|
|
|
|
def from_wcs(self, point: Vec3) -> Vec3:
|
|
return point
|
|
|
|
def points_from_wcs(self, points: Iterable[Vec3]) -> Iterator[Vec3]:
|
|
return iter(points)
|