ruled_surface

RuledSurface

Bases: Surface

Creates a ruled surface based on two opposing boundary curves.

Attributes:

Name	Type	Description
curve1	Curve	Curve defining one surface boundary.
curve2	Curve	Curve defining opposing surface boundary.

Source code in pymesh/geo/surfaces/ruled_surface.py

class RuledSurface(Surface):
    """Creates a ruled surface based on two opposing boundary curves.

    Attributes:
        curve1 (Curve): Curve defining one surface boundary.
        curve2 (Curve): Curve defining opposing surface boundary.
    """

    curve1 = AsInstanceOf(Curve)
    curve2 = AsInstanceOf(Curve)

    def __init__(self, curve1: Curve, curve2: Curve):
        """Initialization method.

        Args:
            curve1: Curve defining one surface boundary.
            curve2: Curve defining opposing surface boundary.

        Raises:
            TypeError: If curve1 or curve2 are not of type Curve.
        """
        self._all_surfaces.append(self)
        self.curve1 = curve1
        self.curve2 = curve2

    def __eq__(self, other):
        return self.curve1 == other.curve1 and self.curve2 == other.curve2

    def __repr__(self):
        return f"{type(self).__name__}(curve1={self.curve1!r}, curve2={self.curve2!r})"

    def get_max_lengths(self) -> tuple[float]:
        length_u = max(self.curve1.length, self.curve2.length)
        length_w = max(
            float(np.sqrt(np.sum((self.curve1.start - self.curve2.start) ** 2))),
            float(np.sqrt(np.sum((self.curve1.end - self.curve2.end) ** 2))),
        )
        return length_u, length_w

    def path(
        self, u: int | float, w: int | float, uflip: bool = False, wflip: bool = False
    ) -> NDArray3[np.float64]:
        u, w = validate_surface_path_parameters(u, w, uflip, wflip)
        return (1 - w) * self.curve1.path(u) + w * self.curve2.path(u)

    def copy(self) -> Self:
        copy = RuledSurface(self.curve1.copy(), self.curve2.copy())
        copy._is_normal_flipped = self._is_normal_flipped
        return copy

    def move(
        self, dx: int | float = 0.0, dy: int | float = 0.0, dz: int | float = 0.0
    ) -> Self:
        self.curve1.move(dx, dy, dz)
        self.curve2.move(dx, dy, dz)
        return self

    def rotate(
        self,
        angle: int | float,
        a: int | float,
        b: int | float,
        c: int | float,
        x0: int | float = 0.0,
        y0: int | float = 0.0,
        z0: int | float = 0.0,
    ) -> Self:
        self.curve1.rotate(angle, a, b, c, x0, y0, z0)
        self.curve2.rotate(angle, a, b, c, x0, y0, z0)
        return self

    def mirror(
        self,
        a: int | float,
        b: int | float,
        c: int | float,
        x0: int | float = 0.0,
        y0: int | float = 0.0,
        z0: int | float = 0.0,
    ) -> Self:
        self.curve1.mirror(a, b, c, x0, y0, z0)
        self.curve2.mirror(a, b, c, x0, y0, z0)
        return self

__init__

__init__(curve1, curve2)

Initialization method.

Parameters:

Name	Type	Description	Default
curve1	Curve	Curve defining one surface boundary.	required
curve2	Curve	Curve defining opposing surface boundary.	required

Raises:

Type	Description
TypeError	If curve1 or curve2 are not of type Curve.

Source code in pymesh/geo/surfaces/ruled_surface.py

def __init__(self, curve1: Curve, curve2: Curve):
    """Initialization method.

    Args:
        curve1: Curve defining one surface boundary.
        curve2: Curve defining opposing surface boundary.

    Raises:
        TypeError: If curve1 or curve2 are not of type Curve.
    """
    self._all_surfaces.append(self)
    self.curve1 = curve1
    self.curve2 = curve2