"""
build123d ENUMs
name: build_enums.py
by: Gumyr
date: Oct 11th 2022
desc:
A collection of enums used throughout build123d.
license:
Copyright 2022 Gumyr
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
from __future__ import annotations
from enum import Enum, auto, IntEnum, unique
from typing import TypeAlias, Union
from OCP.GccEnt import (
GccEnt_unqualified,
GccEnt_enclosing,
GccEnt_enclosed,
GccEnt_outside,
GccEnt_noqualifier,
)
[ドキュメント]
class Align(Enum):
"""Align object about Axis"""
MIN = auto()
CENTER = auto()
MAX = auto()
NONE = None
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
Align2DType: TypeAlias = Union[
Union[Align, None],
tuple[Union[Align, None], Union[Align, None]],
]
Align3DType: TypeAlias = Union[
Union[Align, None],
tuple[Union[Align, None], Union[Align, None], Union[Align, None]],
]
class ApproxOption(Enum):
"""DXF export spline approximation strategy"""
ARC = auto()
NONE = auto()
SPLINE = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class AngularDirection(Enum):
"""Angular rotation direction"""
CLOCKWISE = auto()
COUNTER_CLOCKWISE = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class CenterOf(Enum):
"""Center Options"""
GEOMETRY = auto()
MASS = auto()
BOUNDING_BOX = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
@unique
class ContinuityLevel(IntEnum):
"""
Continuity level for evaluating geometric connections.
Used to determine how smoothly adjacent geometry joins together,
such as at shared vertices between edges or shared edges between faces.
Levels:
- C0 (G0): Positional continuity—elements meet at a point but may have sharp angles.
- C1 (G1): Tangent continuity—elements have the same tangent direction at the junction.
- C2 (G2): Curvature continuity—elements have matching curvature at the junction.
These levels correspond to common CAD definitions and are compatible with OCCT's GeomAbs_Shape.
"""
C0 = 0
C1 = 1
C2 = 2
class Extrinsic(Enum):
"""Order to apply extrinsic rotations by axis"""
XYZ = auto()
XZY = auto()
YZX = auto()
YXZ = auto()
ZXY = auto()
ZYX = auto()
XYX = auto()
XZX = auto()
YZY = auto()
YXY = auto()
ZXZ = auto()
ZYZ = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class FrameMethod(Enum):
"""Moving frame calculation method"""
FRENET = auto()
CORRECTED = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class GeomType(Enum):
"""CAD geometry object type"""
PLANE = auto()
CYLINDER = auto()
CONE = auto()
SPHERE = auto()
TORUS = auto()
BEZIER = auto()
BSPLINE = auto()
REVOLUTION = auto()
EXTRUSION = auto()
OFFSET = auto()
LINE = auto()
CIRCLE = auto()
ELLIPSE = auto()
HYPERBOLA = auto()
PARABOLA = auto()
OTHER = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class HeadType(Enum):
"""Arrow head types"""
STRAIGHT = auto()
CURVED = auto()
FILLETED = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class Intrinsic(Enum):
"""Order to apply intrinsic rotations by axis"""
XYZ = auto()
XZY = auto()
YZX = auto()
YXZ = auto()
ZXY = auto()
ZYX = auto()
XYX = auto()
XZX = auto()
YZY = auto()
YXY = auto()
ZXZ = auto()
ZYZ = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class Keep(Enum):
"""Split options"""
ALL = auto()
BOTTOM = auto()
BOTH = auto()
INSIDE = auto()
OUTSIDE = auto()
TOP = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class Kind(Enum):
"""Offset corner transition"""
ARC = auto()
INTERSECTION = auto()
TANGENT = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class Mode(Enum):
"""Combination Mode"""
ADD = auto()
SUBTRACT = auto()
INTERSECT = auto()
REPLACE = auto()
PRIVATE = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class FontStyle(Enum):
"""Text Font Styles"""
REGULAR = auto()
BOLD = auto()
ITALIC = auto()
BOLDITALIC = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class Sagitta(Enum):
"""Sagitta selection"""
SHORT = 0
LONG = -1
BOTH = 1
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class LengthMode(Enum):
"""Method of specifying length along PolarLine"""
DIAGONAL = auto()
HORIZONTAL = auto()
VERTICAL = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class MeshType(Enum):
"""3MF mesh types typically for 3D printing"""
OTHER = auto()
MODEL = auto()
SUPPORT = auto()
SOLIDSUPPORT = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class NumberDisplay(Enum):
"""Methods for displaying numbers"""
DECIMAL = auto()
FRACTION = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class PageSize(Enum):
"""Align object about Axis"""
A0 = auto()
A1 = auto()
A2 = auto()
A3 = auto()
A4 = auto()
A5 = auto()
A6 = auto()
A7 = auto()
A8 = auto()
A9 = auto()
A10 = auto()
LETTER = auto()
LEGAL = auto()
LEDGER = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class Tangency(Enum):
"""Tangency constraint for solvers edge selection"""
UNQUALIFIED = GccEnt_unqualified
ENCLOSING = GccEnt_enclosing
ENCLOSED = GccEnt_enclosed
OUTSIDE = GccEnt_outside
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class PositionMode(Enum):
"""Position along curve mode"""
LENGTH = auto()
PARAMETER = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class PrecisionMode(Enum):
"""
When you export a model to a STEP file, the precision of the geometric data
(such as the coordinates of points, the definitions of curves and surfaces, etc.)
can significantly impact the file size and the fidelity of the model when it is
imported into another CAD system. Higher precision means that the geometric
data is described with more detail, which can improve the accuracy of the model
in the target system but can also increase the file size.
"""
SESSION = 2
GREATEST = 1
AVERAGE = 0
LEAST = -1
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class Select(Enum):
"""Selector scope - all, last operation or new objects"""
ALL = auto()
LAST = auto()
NEW = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class Side(Enum):
"""2D Offset types"""
LEFT = auto()
RIGHT = auto()
BOTH = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class SortBy(Enum):
"""Sorting criteria"""
LENGTH = auto()
RADIUS = auto()
AREA = auto()
VOLUME = auto()
DISTANCE = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class TextAlign(Enum):
"""Text Alignment"""
BOTTOM = auto()
CENTER = auto()
LEFT = auto()
RIGHT = auto()
TOP = auto()
TOPFIRSTLINE = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class Transition(Enum):
"""Sweep discontinuity handling option"""
RIGHT = auto()
ROUND = auto()
TRANSFORMED = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
class Unit(Enum):
"""Standard Units"""
MC = auto() # MICRO
MM = auto() # MILLIMETER
CM = auto() # CENTIMETER
M = auto() # METER
IN = auto() # INCH
FT = auto() # FOOT
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"
[ドキュメント]
class Until(Enum):
"""Extrude limit"""
NEXT = auto()
LAST = auto()
PREVIOUS = auto()
FIRST = auto()
def __repr__(self):
return f"<{self.__class__.__name__}.{self.name}>"