eqiora.geometry

← Python API index

Build geometry and select its regions and boundaries.

View source

Example: name a rectangle and its edges

python

from eqiora import geometry as g

graph = g.GeometryGraph()
rectangle = graph.rectangle(x_bounds=(0.0, 2.0), y_bounds=(0.0, 1.0))
geometry = graph.build(rectangle, named_topology={
    "body": rectangle.region,
    "left": rectangle.boundaries[0],
    "right": rectangle.boundaries[1],
    "walls": rectangle.boundaries[2:],
})
print(geometry.selection_dimension("body"))
print(geometry.selection_dimension("left"))

Coordinates are in metres. body has dimension 2; left has dimension 1. The boundary order is left, right, bottom, top. Bind these selections to model supports, or continue with meshing.

API

Geometry

Immutable geometry built from a GeometryGraph.

python

@final
class Geometry:
    @property
    def dimension(self) -> int: ...
    @property
    def bounds(self) -> tuple[tuple[float, float]] | tuple[tuple[float, float], tuple[float, float]] | tuple[tuple[float, float], tuple[float, float], tuple[float, float]]: ...
    @property
    def classification_tolerance(self) -> float | None: ...
    @property
    def canonical_bytes(self) -> bytes: ...
    @property
    def digest(self) -> str: ...
    @property
    def selection_names(self) -> tuple[str, ...]: ...
    def selection_dimension(self, name: str) -> int: ...
    def selection(self, name: str) -> GeometrySelection: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...
    def __repr__(self) -> str: ...

GeometryBoundaryHandle

Handle to a boundary created by a geometry operation.

python

@final
class GeometryBoundaryHandle:
    @property
    def dimension(self) -> int: ...
    def __eq__(self, other: object, /) -> bool: ...

GeometryBuildReceipt

Report from building a solid: tolerances, geometric discrepancies, repairs, and how faces changed.

python

@final
class GeometryBuildReceipt:
    @property
    def graph_digest(self) -> str: ...
    @property
    def provider_profile(self) -> str: ...
    @property
    def requested_modeling_tolerance(self) -> float: ...
    @property
    def requested_boolean_tolerance(self) -> float | None: ...
    @property
    def effective_boolean_tolerance(self) -> float | None: ...
    @property
    def maximum_position_discrepancy(self) -> float: ...
    @property
    def maximum_area_discrepancy(self) -> float: ...
    @property
    def maximum_volume_discrepancy(self) -> float: ...
    @property
    def repair(self) -> str: ...
    @property
    def retained_unchanged(self) -> tuple[GeometryFaceHandle, ...]: ...
    @property
    def retained_modified(self) -> tuple[GeometryFaceHandle, ...]: ...
    @property
    def created(self) -> tuple[GeometryFaceHandle, ...]: ...
    @property
    def deleted(self) -> tuple[GeometryFaceHandle, ...]: ...
    @property
    def split(self) -> tuple[GeometryFaceHandle, ...]: ...
    @property
    def merged(self) -> tuple[GeometryFaceHandle, ...]: ...
    def __eq__(self, other: object, /) -> bool: ...

GeometryFaceHandle

Handle to a solid face, valid for one graph session and revision.

python

@final
class GeometryFaceHandle:
    @property
    def canonical_bytes(self) -> bytes: ...
    @property
    def graph_digest(self) -> str: ...
    @property
    def provenance_key(self) -> str: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...

GeometryGraph

Builder for Cartesian, planar, and solid geometry.

python

@final
class GeometryGraph:
    def __init__(self) -> None: ...
    def interval(self, *, bounds: tuple[float, float]) -> GeometryOperation: ...
    def rectangle(self, *, x_bounds: tuple[float, float], y_bounds: tuple[float, float]) -> GeometryOperation: ...
    def circle(self, *, center: tuple[float, float], radius: float) -> GeometryOperation: ...
    def subtract(self, rectangle: GeometryOperation, circle: GeometryOperation) -> GeometryOperation: ...
    def partition(self, left: GeometryOperation, right: GeometryOperation, /, *, interface: tuple[GeometryBoundaryHandle, GeometryBoundaryHandle]) -> GeometryOperation: ...
    def rectangle_extrusion(self, *, x_bounds: tuple[float, float], y_bounds: tuple[float, float], plane_z: float, depth: float, modeling_tolerance: float) -> GeometrySolidOperation: ...
    def decode_solid(self, data: bytes) -> GeometrySolidOperation: ...
    def circular_through_cut(self, target: GeometrySolidOperation, /, *, center: tuple[float, float], radius: float, boolean_tolerance: float) -> GeometrySolidOperation: ...
    @overload
    def build(self, operation: GeometryOperation, /, *, named_topology: Mapping[str, GeometryRegionHandle | GeometryBoundaryHandle | Sequence[GeometryRegionHandle | GeometryBoundaryHandle]]) -> Geometry: ...
    @overload
    def build(self, operation: GeometrySolidOperation, /, *, named_topology: None=None) -> GeometryBuildReceipt: ...
    @overload
    def build(self, operation: GeometrySolidOperation, /, *, named_topology: Mapping[str, GeometryFaceHandle | Sequence[GeometryFaceHandle]]) -> Geometry: ...

GeometryOperation

Immutable result of a primitive or Boolean geometry operation.

boundaries are listed in construction order: an interval returns (lower, upper), a rectangle returns (x_lower, x_upper, y_lower, y_upper), a circle returns its sole curve, and subtract returns the four outer boundaries followed by the created cut.

python

@final
class GeometryOperation:
    @property
    def region(self) -> GeometryRegionHandle: ...
    @property
    def boundaries(self) -> tuple[GeometryBoundaryHandle, ...]: ...
    def __eq__(self, other: object, /) -> bool: ...

GeometryRegionHandle

Handle to a region created by a geometry operation.

python

@final
class GeometryRegionHandle:
    @property
    def dimension(self) -> int: ...
    def __eq__(self, other: object, /) -> bool: ...

GeometrySelection

Immutable named selection tied to one Geometry revision.

python

@final
class GeometrySelection:
    @property
    def source_digest(self) -> str: ...
    @property
    def name(self) -> str: ...
    @property
    def dimension(self) -> int: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...
    def __repr__(self) -> str: ...

GeometrySolidOperation

Immutable solid operation belonging to one GeometryGraph.

python

@final
class GeometrySolidOperation:
    @property
    def canonical_bytes(self) -> bytes: ...
    @property
    def graph_digest(self) -> str: ...
    @property
    def x_bounds(self) -> tuple[float, float]: ...
    @property
    def y_bounds(self) -> tuple[float, float]: ...
    @property
    def plane_z(self) -> float: ...
    @property
    def extrusion_depth(self) -> float: ...
    @property
    def requested_modeling_tolerance(self) -> float: ...
    @property
    def requested_boolean_tolerance(self) -> float | None: ...
    @property
    def cut_center(self) -> tuple[float, float] | None: ...
    @property
    def cut_radius(self) -> float | None: ...
    @property
    def bounds(self) -> tuple[tuple[float, float], tuple[float, float], tuple[float, float]]: ...
    @property
    def vertex_count(self) -> int | None: ...
    @property
    def edge_count(self) -> int | None: ...
    @property
    def face_count(self) -> int: ...
    @property
    def closed_shell_count(self) -> int: ...
    @property
    def body_count(self) -> int: ...
    @property
    def genus(self) -> int: ...
    @property
    def volume(self) -> float: ...
    @property
    def surface_area(self) -> float: ...
    @property
    def repair(self) -> str: ...
    @property
    def selection_names(self) -> tuple[str, ...]: ...
    def face_handle(self, name: str) -> GeometryFaceHandle: ...
    def resolve_face(self, handle: GeometryFaceHandle) -> str: ...
    def face_area(self, handle: GeometryFaceHandle) -> float: ...
    def face_boundary_loop_count(self, handle: GeometryFaceHandle) -> int: ...
    def rectangular_face_vertices(self, handle: GeometryFaceHandle) -> tuple[tuple[float, float, float], ...] | None: ...
    def rectangular_face_centroid(self, handle: GeometryFaceHandle) -> tuple[float, float, float] | None: ...
    def planar_face_outward_normal(self, handle: GeometryFaceHandle) -> tuple[float, float, float] | None: ...
    def __eq__(self, other: object, /) -> bool: ...
    def __hash__(self) -> int: ...