simetri.graphics.all_enums

   1"""All enumerations."""
   2
   3from typing import Union
   4from typing_extensions import TypeAlias
   5from strenum import StrEnum
   6
   7
   8def get_enum_value(enum_class: StrEnum, value: str) -> str:
   9    """Get the value of an enumeration."""
  10    if isinstance(value, enum_class):
  11        res = value.value
  12    else:
  13        res = enum_class[value.upper()].value
  14
  15    return res
  16
  17
  18class Align(StrEnum):
  19    """Align is used to set the alignment of the text in tags.
  20    Used for Tag and Text objects. This is based on TikZ.
  21
  22    Valid values are: NONE, CENTER, FLUSH_CENTER, FLUSH_LEFT, FLUSH_RIGHT, JUSTIFY, LEFT, RIGHT.
  23    """
  24
  25    NONE = ""
  26    CENTER = "center"
  27    FLUSH_CENTER = "flush center"
  28    FLUSH_LEFT = "flush left"
  29    FLUSH_RIGHT = "flush right"
  30    JUSTIFY = "justify"
  31    LEFT = "left"
  32    RIGHT = "right"
  33
  34
  35# Anchor points
  36# Used for TikZ. VaLUeS are case sensitive.
  37class Anchor(StrEnum):
  38    """Anchor is used to set the anchor point of the shapes
  39    relative to the boundary box of shapes/batches or
  40    frames of tag objects.
  41
  42    Valid values are: BASE, BASE_EAST, BASE_WEST, BOTTOM, CENTER, EAST, LEFT, MID, MIDEAST, MIDWEST, NORTH,
  43    NORTHEAST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHWEST, TEXT, TOP, WEST.
  44    """
  45
  46    BASE = "base"  # FOR TAGS ONLY
  47    BASE_EAST = "base east"  # FOR TAGS ONLY
  48    BASE_WEST = "base west"  # FOR TAGS ONLY
  49    BOTTOM = "bottom"
  50    MIDPOINT = "midpoint"
  51    EAST = "east"
  52    LEFT = "left"
  53    CENTER = "center"
  54    MID = "mid"
  55    MIDEAST = "mid east"
  56    MIDWEST = "mid west"
  57    NORTH = "north"
  58    NORTHEAST = "north east"
  59    NORTHWEST = "north west"
  60    RIGHT = "right"
  61    SOUTH = "south"
  62    SOUTHEAST = "south east"
  63    SOUTHWEST = "south west"
  64    TEXT = "text"
  65    TOP = "top"
  66    WEST = "west"
  67
  68
  69class ArrowLine(StrEnum):
  70    """ArrowLine is used to set the type of arrow line.
  71
  72    Valid values are: FLATBASE_END, FLATBASE_MIDDLE, FLATBASE_START, FLATBOTH_END, FLATBOTH_MIDDLE,
  73    FLATBOTH_START, FLATTOP_END, FLATTOP_MIDDLE, FLATTOP_START, STRAIGHT_END, STRAIGHT_MIDDLE, STRAIGHT_START.
  74    """
  75
  76    FLATBASE_END = "flatbase end"  # FLAT BASE, ARROW AT THE END
  77    FLATBASE_MIDDLE = "flatbase middle"  # FLAT BASE, ARROW AT THE MIDDLE
  78    FLATBASE_START = "flatbase start"  # FLAT BASE, ARROW AT THE START
  79    FLATBOTH_END = "flatboth end"
  80    FLATBOTH_MIDDLE = "flatboth middle"
  81    FLATBOTH_START = "flatboth start"
  82    FLATTOP_END = "flattop end"  #  FLAT TOP, ARROW AT THE END
  83    FLATTOP_MIDDLE = "flattop middle"
  84    FLATTOP_START = "flattop start"
  85    STRAIGHT_END = "straight end"  # DEFAULT, STRAIGHT LINE, ARROW AT THE END
  86    STRAIGHT_MIDDLE = "straight middle"  # STRAIGHT LINE, ARROW AT THE MIDDLE
  87    STRAIGHT_START = "straight start"  # STRAIGHT LINE, ARROW AT THE START
  88
  89
  90class Axis(StrEnum):
  91    """Cartesian coordinate system axes.
  92
  93    Valid values are: X, Y.
  94    """
  95
  96    X = "x"
  97    Y = "y"
  98
  99
 100# Used for shapes, canvas, and  tags
 101class BackStyle(StrEnum):
 102    """BackStyle is used to set the background style of a shape or tag.
 103    If shape.fill is True, then background will be drawn according to
 104    the shape.back_style value.
 105
 106    Valid values are: COLOR, COLOR_AND_GRID, EMPTY, GRIDLINES, PATTERN, SHADING, SHADING_AND_GRID.
 107    """
 108
 109    COLOR = "COLOR"
 110    COLOR_AND_GRID = "COLOR_AND_GRID"
 111    EMPTY = "EMPTY"
 112    GRIDLINES = "GRIDLINES"
 113    PATTERN = "PATTERN"
 114    SHADING = "SHADING"
 115    SHADING_AND_GRID = "SHADING_AND_GRID"
 116
 117
 118class BlendMode(StrEnum):
 119    """BlendMode is used to set the blend mode of the colors.
 120
 121    Valid values are: COLOR, COLORBURN, COLORDODGE, DARKEN, DIFFERENCE, EXCLUSION, HARDLIGHT, HUE, LIGHTEN,
 122    LUMINOSITY, MULTIPLY, NORMAL, OVERLAY, SATURATION, SCREEN, SOFTLIGHT.
 123    """
 124
 125    COLOR = "color"
 126    COLORBURN = "colorburn"
 127    COLORDODGE = "colordodge"
 128    DARKEN = "darken"
 129    DIFFERENCE = "difference"
 130    EXCLUSION = "exclusion"
 131    HARDLIGHT = "hardlight"
 132    HUE = "hue"
 133    LIGHTEN = "lighten"
 134    LUMINOSITY = "luminosity"
 135    MULTIPLY = "multiply"
 136    NORMAL = "normal"
 137    OVERLAY = "overlay"
 138    SATURATION = "saturation"
 139    SCREEN = "screen"
 140    SOFTLIGHT = "softlight"
 141
 142
 143class ColorSpace(StrEnum):
 144    """ColorSpace is used to set the color space of the colors.
 145
 146    Valid values are: CMYK, GRAY, HCL, HLS, HSV, LAB, RGB, YIQ.
 147    """
 148
 149    CMYK = "CMYK"
 150    GRAY = "GRAY"
 151    HCL = "HCL"
 152    HLS = "HLS"
 153    HSV = "HSV"
 154    LAB = "LAB"
 155    RGB = "RGB"
 156    YIQ = "YIQ"
 157
 158
 159class Connection(StrEnum):
 160    """Connection is used for identifying how two line segments are related
 161    to each other. Intersection check uses some of these values.
 162
 163    Valid values are: CHAIN, COINCIDENT, COLL_CHAIN, CONGRUENT, CONTAINS, COVERS, DISJOINT, END_END, END_START,
 164    FLIPPED, INTERSECT, NONE, OVERLAPS, PARALLEL, START_END, START_START, TOUCHES, WITHIN, YJOINT.
 165    """
 166
 167    CHAIN = "CHAIN"
 168    COINCIDENT = "COINCIDENT"
 169    COLL_CHAIN = "COLL_CHAIN"
 170    CONGRUENT = "CONGRUENT"
 171    CONTAINS = "CONTAINS"
 172    COVERS = "COVERS"
 173    DISJOINT = "DISJOINT"
 174    END_END = "END_END"
 175    END_START = "END_START"
 176    FLIPPED = "FLIPPED"
 177    INTERSECT = "INTERSECT"
 178    NONE = "NONE"
 179    OVERLAPS = "OVERLAPS"
 180    PARALLEL = "PARALLEL"
 181    START_END = "START_END"
 182    START_START = "START_START"
 183    TOUCHES = "TOUCHES"
 184    WITHIN = "WITHIN"
 185    YJOINT = "YJOINT"
 186
 187
 188class Connector(StrEnum):
 189    """Connector is used to set the way connecting lines are drawn.
 190    This is not used yet.
 191
 192    Valid values are: ARC, ARROW_LINE, CURVE, LINE, DOUBLE_LINE, SQUIGLY, ZIGZAG, SQUIGLY_ARROW, ZIGZAG_ARROW,
 193    DOUBLE_ARROW, DOUBLE_SQUIGLY.
 194    """
 195
 196    ARC = "ARC"
 197    ARROW_LINE = "ARROW_LINE"
 198    CURVE = "CURVE"
 199    LINE = "LINE"
 200    DOUBLE_LINE = "DOUBLE_LINE"
 201    SQUIGLY = "squigly"
 202    ZIGZAG = "zigzag"
 203    SQUIGLY_ARROW = "squigly_arrow"
 204    ZIGZAG_ARROW = "zigzag_arrow"
 205    DOUBLE_ARROW = "double_arrow"
 206    DOUBLE_SQUIGLY = "double_squigly"
 207
 208
 209class ConstraintType(StrEnum):
 210    """Constraint types are used with the 2D geometric constraint solver.
 211
 212    Valid values are: COLLINEAR, DISTANCE, LINE_ANGLE, PARALLEL, PERPENDICULAR, EQUAL_SIZE, EQUAL_VALUE,
 213    INNER_TANGENT, OUTER_TANGENT.
 214    """
 215
 216    COLLINEAR = "COLLINEAR"
 217    DISTANCE = "DISTANCE"
 218    LINE_ANGLE = "LINE_ANGLE"
 219    PARALLEL = "PARALLEL"
 220    PERPENDICULAR = "PERPENDICULAR"
 221    EQUAL_SIZE = "EQUAL_SIZE"
 222    EQUAL_VALUE = "EQUAL_VALUE"
 223    INNER_TANGENT = "INNER_TANGENT"
 224    OUTER_TANGENT = "OUTER_TANGENT"
 225
 226
 227class Compiler(StrEnum):
 228    """Used for the LaTeX compiler.
 229    Currently, only XELATEX is used.
 230
 231    Valid values are: LATEX, PDFLATEX, XELATEX, LUALATEX.
 232    """
 233
 234    LATEX = "LATEX"
 235    PDFLATEX = "PDFLATEX"
 236    XELATEX = "XELATEX"
 237    LUALATEX = "LUALATEX"
 238
 239
 240class Control(StrEnum):
 241    """Used with the modifiers.
 242
 243    Valid values are: INITIAL, PAUSE, RESTART, RESUME, STOP.
 244    """
 245
 246    INITIAL = "INITIAL"
 247    PAUSE = "PAUSE"
 248    RESTART = "RESTART"
 249    RESUME = "RESUME"
 250    STOP = "STOP"
 251
 252
 253class Conway(StrEnum):
 254    """Frieze groups in Conway notation.
 255
 256    Valid values are: HOP, JUMP, SIDLE, SPINNING_HOP, SPINNING_JUMP, SPINNING_SIDLE, STEP.
 257    """
 258
 259    HOP = "HOP"
 260    JUMP = "JUMP"
 261    SIDLE = "SIDLE"
 262    SPINNING_HOP = "SPINNING_HOP"
 263    SPINNING_JUMP = "SPINNING_JUMP"
 264    SPINNING_SIDLE = "SPINNING_SIDLE"
 265    STEP = "STEP"
 266
 267
 268class CurveMode(StrEnum):
 269    """CurveMode is used to set how arc objects are drawn.
 270
 271    Valid values are: OPEN, CHORD, PIE.
 272    """
 273
 274    OPEN = "OPEN"
 275    CHORD = "CHORD"
 276    PIE = "PIE"
 277
 278
 279class Dep(StrEnum):
 280    """Depend may be used in the future to set the dependency of the shapes
 281    when they are copied. Dependent copies share the same underlying data.
 282
 283    Valid values are: FALSE, TRUE, GEOM, STYLE.
 284    """
 285
 286    FALSE = "FALSE"  # Independent
 287    TRUE = "TRUE"  # Both geometry and style are dependent
 288    GEOM = "GEOM"  # Only geometry is dependent
 289    STYLE = "STYLE"  # Only style is dependent
 290
 291
 292class DocumentClass(StrEnum):
 293    """DocumentClass is used to set the class of the LaTeX document.
 294
 295    Valid values are: ARTICLE, BEAMER, BOOK, IEEETRAN, LETTER, REPORT, SCRARTCL, SLIDES, STANDALONE.
 296    """
 297
 298    ARTICLE = "article"
 299    BEAMER = "beamer"
 300    BOOK = "book"
 301    IEEETRAN = "ieeetran"
 302    LETTER = "letter"
 303    REPORT = "report"
 304    SCRARTCL = "scrartcl"
 305    SLIDES = "slides"
 306    STANDALONE = "standalone"
 307
 308
 309class FillMode(StrEnum):
 310    """FillMode is used to set the fill mode of the shape.
 311
 312    Valid values are: EVENODD, NONZERO.
 313    """
 314
 315    EVENODD = "even odd"
 316    NONZERO = "non zero"
 317
 318
 319class FontFamily(StrEnum):
 320    """FontFamily is used to set the family of the font.
 321
 322    Valid values are: MONOSPACE, SERIF, SANSSERIF.
 323    """
 324
 325    MONOSPACE = "monospace"  # \ttfamily, \texttt
 326    SERIF = "serif"  # serif \rmfamily, \textrm
 327    SANSSERIF = "sansserif"  # \sffamily, \textsf
 328
 329
 330class FontSize(StrEnum):
 331    """FontSize is used to set the size of the font.
 332
 333    Valid values are: FOOTNOTESIZE, HUGE, HUGE2, LARGE, LARGE2, LARGE3, NORMAL, SCRIPTSIZE, SMALL, TINY.
 334    """
 335
 336    FOOTNOTESIZE = "footnotesize"
 337    HUGE = "huge"  # \huge
 338    HUGE2 = "Huge"  # \Huge
 339    LARGE = "large"  # \large
 340    LARGE2 = "Large"  # \Large
 341    LARGE3 = "LARGE"  # \LARGE
 342    NORMAL = "normalsize"  # \normalsize
 343    SCRIPTSIZE = "scriptsize"  # \scriptsize
 344    SMALL = "small"  # \small
 345    TINY = "tiny"  # \tiny
 346
 347
 348class FontStretch(StrEnum):
 349    """FontStretch is used to set the stretch of the font.
 350    These come from LaTeX.
 351
 352    Valid values are: CONDENSED, EXPANDED, EXTRA_CONDENSED, EXTRA_EXPANDED, NORMAL, SEMI_CONDENSED,
 353    SEMI_EXPANDED, ULTRA_CONDENSED, ULTRA_EXPANDED.
 354    """
 355
 356    CONDENSED = "condensed"
 357    EXPANDED = "expanded"
 358    EXTRA_CONDENSED = "extracondensed"
 359    EXTRA_EXPANDED = "extraexpanded"
 360    NORMAL = "normal"
 361    SEMI_CONDENSED = "semicondensed"
 362    SEMI_EXPANDED = "semiexpanded"
 363    ULTRA_CONDENSED = "ultracondensed"
 364    ULTRA_EXPANDED = "ultraexpanded"
 365
 366
 367class FontStrike(StrEnum):
 368    """FontStrike is used to set the strike of the font.
 369
 370    Valid values are: OVERLINE, THROUGH, UNDERLINE.
 371    """
 372
 373    OVERLINE = "overline"
 374    THROUGH = "through"
 375    UNDERLINE = "underline"
 376
 377
 378class FontWeight(StrEnum):
 379    """FontWeight is used to set the weight of the font.
 380
 381    Valid values are: BOLD, MEDIUM, NORMAL.
 382    """
 383
 384    BOLD = "bold"
 385    MEDIUM = "medium"
 386    NORMAL = "normal"
 387
 388
 389class FrameShape(StrEnum):
 390    """FrameShape is used to set the shape of the frame.
 391    Frames are used for the tags.
 392
 393    Valid values are: CIRCLE, DIAMOND, ELLIPSE, FORBIDDEN, PARALLELOGRAM, POLYGON, RECTANGLE, RHOMBUS,
 394    SPLITCIRCLE, SQUARE, STAR, TRAPEZOID.
 395    """
 396
 397    CIRCLE = "circle"
 398    DIAMOND = "diamond"
 399    ELLIPSE = "ellipse"
 400    FORBIDDEN = "forbidden"
 401    PARALLELOGRAM = "parallelogram"
 402    POLYGON = "polygon"
 403    RECTANGLE = "rectangle"
 404    RHOMBUS = "rhombus"
 405    SPLITCIRCLE = "split circle"
 406    SQUARE = "square"
 407    STAR = "star"
 408    TRAPEZOID = "trapezoid"
 409
 410
 411class Graph(StrEnum):
 412    """Graph is used to set the type of graph.
 413
 414    Valid values are: DIRECTED, DIRECTEDWEIGHTED, UNDIRECTED, UNDIRECTEDWEIGHTED.
 415    """
 416
 417    DIRECTED = "DIRECTED"
 418    DIRECTEDWEIGHTED = "DIRECTEDWEIGHTED"
 419    UNDIRECTED = "UNDIRECTED"
 420    UNDIRECTEDWEIGHTED = "UNDIRECTEDWEIGHTED"
 421
 422
 423class GridType(StrEnum):
 424    """GridType is used to set the type of grid.
 425    Grids are used for creating star patterns.
 426
 427    Valid values are: CIRCULAR, SQUARE, HEXAGONAL, MIXED.
 428    """
 429
 430    CIRCULAR = "CIRCULAR"
 431    SQUARE = "SQUARE"
 432    HEXAGONAL = "HEXAGONAL"
 433    MIXED = "MIXED"  # CIRCULAR + SQUARE
 434
 435
 436# arrow head positions
 437class HeadPos(StrEnum):
 438    """Arrow head positions.
 439
 440    Valid values are: BOTH, END, MIDDLE, START, NONE.
 441    """
 442
 443    BOTH = "BOTH"
 444    END = "END"
 445    MIDDLE = "MIDDLE"
 446    START = "START"
 447    NONE = "NONE"
 448
 449
 450class IUC(StrEnum):
 451    """IUC notation for frieze groups.
 452
 453    Valid values are: P1, P11G, P11M, P1M1, P2, P2MG, P2MM.
 454    """
 455
 456    P1 = "P1"
 457    P11G = "P11G"
 458    P11M = "P11M"
 459    P1M1 = "P1M1"
 460    P2 = "P2"
 461    P2MG = "P2MG"
 462    P2MM = "P2MM"
 463
 464
 465class LineCap(StrEnum):
 466    """LineCap is used to set the type of line cap.
 467
 468    Valid values are: BUTT, ROUND, SQUARE.
 469    """
 470
 471    BUTT = "butt"
 472    ROUND = "round"
 473    SQUARE = "square"
 474
 475
 476class LineDashArray(StrEnum):
 477    """LineDashArray is used to set the type of dashed-line.
 478
 479    Valid values are: DASHDOT, DASHDOTDOT, DASHED, DENSELY_DASHED, DENSELY_DOTTED, DOTTED, LOOSELY_DASHED,
 480    LOOSELY_DOTTED, SOLID.
 481    """
 482
 483    DASHDOT = "dash dot"
 484    DASHDOTDOT = "dash dot dot"
 485    DASHED = "dashed"
 486    DENSELY_DASHED = "densely dashed"
 487    DENSELY_DOTTED = "densely dotted"
 488    DOTTED = "dotted"
 489    LOOSELY_DASHED = "loosely dashed"
 490    LOOSELY_DOTTED = "loosely dotted"
 491    SOLID = "solid"
 492
 493
 494class LineJoin(StrEnum):
 495    """LineJoin is used to set the type of line join.
 496
 497    Valid values are: BEVEL, MITER, ROUND.
 498    """
 499
 500    BEVEL = "bevel"
 501    MITER = "miter"
 502    ROUND = "round"
 503
 504
 505class LineWidth(StrEnum):
 506    """LineWidth is used to set the width of the line.
 507
 508    Valid values are: SEMITHICK, THICK, THIN, ULTRA_THICK, ULTRA_THIN, VERY_THICK, VERY_THIN.
 509    """
 510
 511    SEMITHICK = "semithick"
 512    THICK = "thick"
 513    THIN = "thin"
 514    ULTRA_THICK = "ultra thick"
 515    ULTRA_THIN = "ultra thin"
 516    VERY_THICK = "very thick"
 517    VERY_THIN = "very thin"
 518
 519
 520class MarkerPos(StrEnum):
 521    """MarkerPos is used to set the position of the marker.
 522
 523    Valid values are: CONCAVEHULL, CONVEXHULL, MAINX, OFFSETX.
 524    """
 525
 526    CONCAVEHULL = "CONCAVEHULL"
 527    CONVEXHULL = "CONVEXHULL"
 528    MAINX = "MAINX"
 529    OFFSETX = "OFFSETX"
 530
 531
 532class MarkerType(StrEnum):
 533    """MarkerType is used to set the type of marker.
 534
 535    Valid values are: ASTERISK, BAR, CIRCLE, CROSS, DIAMOND, DIAMOND_F, EMPTY, FCIRCLE, HALF_CIRCLE,
 536    HALF_CIRCLE_F, HALF_DIAMOND, HALF_DIAMOND_F, HALF_SQUARE, HALF_SQUARE_F, HEXAGON, HEXAGON_F, INDICES,
 537    MINUS, OPLUS, OPLUS_F, O_TIMES, O_TIMES_F, PENTAGON, PENTAGON_F, PLUS, SQUARE, SQUARE_F, STAR, STAR2,
 538    STAR3, TEXT, TRIANGLE, TRIANGLE_F.
 539    """
 540
 541    ASTERISK = "asterisk"
 542    BAR = "|"
 543    CIRCLE = "o"
 544    CROSS = "x"
 545    DIAMOND = "diamond"
 546    DIAMOND_F = "diamond*"
 547    EMPTY = ""
 548    FCIRCLE = "*"
 549    HALF_CIRCLE = "halfcircle"
 550    HALF_CIRCLE_F = "halfcircle*"
 551    HALF_DIAMOND = "halfdiamond"
 552    HALF_DIAMOND_F = "halfdiamond*"
 553    HALF_SQUARE = "halfsquare"
 554    HALF_SQUARE_F = "halfsquare*"
 555    HEXAGON = "hexagon"
 556    HEXAGON_F = "hexagon*"
 557    INDICES = "indices"
 558    MINUS = "-"
 559    OPLUS = "oplus"
 560    OPLUS_F = "oplus*"
 561    O_TIMES = "otimes"
 562    O_TIMES_F = "otimes*"
 563    PENTAGON = "pentagon"
 564    PENTAGON_F = "pentagon*"
 565    PLUS = "+"
 566    SQUARE = "square"
 567    SQUARE_F = "square*"
 568    STAR = "star"
 569    STAR2 = "star2"
 570    STAR3 = "star3"
 571    TEXT = "text"
 572    TRIANGLE = "triangle"
 573    TRIANGLE_F = "triangle*"
 574
 575
 576class MusicScale(StrEnum):
 577    """MusicScale is used for musical note scales.
 578    This is used for audio generation for animations.
 579    Not implemented yet!!!
 580
 581    Valid values are: MAJOR, MINOR, CHROMATIC, PENTATONIC, IONIC, DORIAN, PHRYGIAN, LYDIAN, MIXOLYDIAN,
 582    AEOLIAN, LOCRIAN.
 583    """
 584
 585    MAJOR = "major"
 586    MINOR = "minor"
 587    CHROMATIC = "chromatic"
 588    PENTATONIC = "pentatonic"
 589    IONIC = "ionic"
 590    DORIAN = "dorian"
 591    PHRYGIAN = "phrygian"
 592    LYDIAN = "lydian"
 593    MIXOLYDIAN = "mixolydian"
 594    AEOLIAN = "aeolian"
 595    LOCRIAN = "locrian"
 596
 597
 598class Orientation(StrEnum):
 599    """Orientation is used to set the orientation of the dimension
 600    lines.
 601
 602    Valid values are: ANGLED, HORIZONTAL, VERTICAL.
 603    """
 604
 605    ANGLED = "ANGLED"
 606    HORIZONTAL = "HORIZONTAL"
 607    VERTICAL = "VERTICAL"
 608
 609
 610class PageMargins(StrEnum):
 611    """Page margins for the LaTeX documents.
 612    Used in Page class.
 613
 614    Valid values are: CUSTOM, NARROW, STANDARD, WIDE.
 615    """
 616
 617    CUSTOM = "custom"
 618    NARROW = "narrow"
 619    STANDARD = "standard"
 620    WIDE = "wide"
 621
 622
 623class PageNumbering(StrEnum):
 624    """Page numbering style for the LaTeX documents.
 625    Used in Page class.
 626
 627    Valid values are: ALPH, ALPHUPPER, ARABIC, NONE, ROMAN, ROMAN_UPPER.
 628    """
 629
 630    ALPH = "alph"
 631    ALPHUPPER = "ALPH"
 632    ARABIC = "arabic"
 633    NONE = "none"
 634    ROMAN = "roman"
 635    ROMAN_UPPER = "ROMAN"
 636
 637
 638class PageNumberPosition(StrEnum):
 639    """Page number positions for the LaTeX documents.
 640    Used in Page class.
 641
 642    Valid values are: BOTTOM_CENTER, BOTTOM_LEFT, BOTTOM_RIGHT, CUSTOM, TOP_CENTER, TOP_LEFT, TOP_RIGHT.
 643    """
 644
 645    BOTTOM_CENTER = "bottom"
 646    BOTTOM_LEFT = "bottom left"
 647    BOTTOM_RIGHT = "bottom right"
 648    CUSTOM = "custom"
 649    TOP_CENTER = "top"
 650    TOP_LEFT = "top left"
 651    TOP_RIGHT = "top right"
 652
 653
 654class PageOrientation(StrEnum):
 655    """Page orientations for the LaTeX documents.
 656    Used in Page class.
 657
 658    Valid values are: LANDSCAPE, PORTRAIT.
 659    """
 660
 661    LANDSCAPE = "landscape"
 662    PORTRAIT = "portrait"
 663
 664
 665class PageSize(StrEnum):
 666    """Page sizes for the LaTeX documents.
 667    Used in Page class.
 668
 669    Valid values are: LETTER, LEGAL, EXECUTIVE, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10, B11, B12, B13,
 670    A0, A1, A2, A3, A4, A5, A6.
 671    """
 672
 673    LETTER = "letterpaper"
 674    LEGAL = "legalpaper"
 675    EXECUTIVE = "executivepaper"
 676    B0 = "b0paper"
 677    B1 = "b1paper"
 678    B2 = "b2paper"
 679    B3 = "b3paper"
 680    B4 = "b4paper"
 681    B5 = "b5paper"
 682    B6 = "b6paper"
 683    B7 = "b7paper"
 684    B8 = "b8paper"
 685    B9 = "b9paper"
 686    B10 = "b10paper"
 687    B11 = "b11paper"
 688    B12 = "b12paper"
 689    B13 = "b13paper"
 690    A0 = "a0paper"
 691    A1 = "a1paper"
 692    A2 = "a2paper"
 693    A3 = "a3paper"
 694    A4 = "a4paper"
 695    A5 = "a5paper"
 696    A6 = "a6paper"
 697
 698
 699class PathOperation(StrEnum):
 700    """PathOperation is used to set the type of path operation.
 701    Used with LinPath objects.
 702
 703    Valid values are: ARC, ARC_TO, BLEND_ARC, BLEND_CUBIC, BLEND_QUAD, BLEND_SINE, CLOSE, CUBIC_TO, FORWARD,
 704    HOBBY_TO, H_LINE, LINE_TO, MOVE_TO, QUAD_TO, R_LINE, R_MOVE, SEGMENTS, SINE, V_LINE.
 705    """
 706
 707    ARC = "ARC"
 708    ARC_TO = "ARC_TO"
 709    BLEND_ARC = "BLEND_ARC"
 710    BLEND_CUBIC = "BLEND_CUBIC"
 711    BLEND_QUAD = "BLEND_QUAD"
 712    BLEND_SINE = "BLEND_SINE"
 713    CLOSE = "CLOSE"
 714    CUBIC_TO = "CUBIC_TO"
 715    FORWARD = "FORWARD"
 716    HOBBY_TO = "HOBBY_TO"
 717    H_LINE = "H_LINE"
 718    LINE_TO = "LINE_TO"
 719    MOVE_TO = "MOVE_TO"
 720    QUAD_TO = "QUAD_TO"
 721    R_LINE = "RLINE"
 722    R_MOVE = "RMOVE"
 723    SEGMENTS = "SEGMENTS"
 724    SINE = "SINE"
 725    V_LINE = "V_LINE"
 726
 727
 728class PatternType(StrEnum):
 729    """PatternType is used to set the type of pattern.
 730    Used with closed shapes and Tag objects.
 731
 732    Valid values are: BRICKS, CHECKERBOARD, CROSSHATCH, CROSSHATCH_DOTS, DOTS, FIVE_POINTED_STARS, GRID,
 733    HORIZONTAL_LINES, NORTHEAST, NORTHWEST, SIX_POINTED_STARS, VERTICAL_LINES.
 734    """
 735
 736    BRICKS = "bricks"
 737    CHECKERBOARD = "checkerboard"
 738    CROSSHATCH = "crosshatch"
 739    CROSSHATCH_DOTS = "crosshatch dots"
 740    DOTS = "dots"
 741    FIVE_POINTED_STARS = "fivepointed stars"
 742    GRID = "grid"
 743    HORIZONTAL_LINES = "horizontal lines"
 744    NORTHEAST = "north east lines"
 745    NORTHWEST = "north west lines"
 746    SIX_POINTED_STARS = "sixpointed stars"
 747    VERTICAL_LINES = "vertical lines"
 748
 749
 750class Placement(StrEnum):
 751    """Placement is used to set the placement of the tags
 752    relative to another object.
 753
 754    Valid values are: ABOVE, ABOVE_LEFT, ABOVE_RIGHT, BELOW, BELOW_LEFT, BELOW_RIGHT, CENTERED, INSIDE,
 755    LEFT, OUTSIDE, RIGHT.
 756    """
 757
 758    ABOVE = "above"
 759    ABOVE_LEFT = "above left"
 760    ABOVE_RIGHT = "above right"
 761    BELOW = "below"
 762    BELOW_LEFT = "below left"
 763    BELOW_RIGHT = "below right"
 764    CENTERED = "centered"
 765    INSIDE = "inside"
 766    LEFT = "left"
 767    OUTSIDE = "outside"
 768    RIGHT = "right"
 769
 770
 771class Render(StrEnum):
 772    """Render is used to set the type of rendering.
 773
 774    Valid values are: EPS, PDF, SVG, TEX.
 775    """
 776
 777    EPS = "EPS"
 778    PDF = "PDF"
 779    SVG = "SVG"
 780    TEX = "TEX"
 781
 782
 783class Result(StrEnum):
 784    """Result is used for the return values of the functions.
 785
 786    Valid values are: FAILURE, GO, NOPAGES, OVERWRITE, SAVED, STOP, SUCCESS.
 787    """
 788
 789    FAILURE = "FAILURE"
 790    GO = "GO"
 791    NOPAGES = "NO_PAGES"
 792    OVERWRITE = "OVERWRITE"
 793    SAVED = "SAVED"
 794    STOP = "STOP"
 795    SUCCESS = "SUCCESS"
 796
 797
 798class ShadeType(StrEnum):
 799    """ShadeType is used to set the type of shading.
 800
 801    Valid values are: AXIS_LEFT_RIGHT, AXIS_TOP_BOTTOM, AXIS_LEFT_MIDDLE, AXIS_RIGHT_MIDDLE, AXIS_TOP_MIDDLE,
 802    AXIS_BOTTOM_MIDDLE, BALL, BILINEAR, COLORWHEEL, COLORWHEEL_BLACK, COLORWHEEL_WHITE, RADIAL_INNER,
 803    RADIAL_OUTER, RADIAL_INNER_OUTER.
 804    """
 805
 806    AXIS_LEFT_RIGHT = "axis left right"
 807    AXIS_TOP_BOTTOM = "axis top bottom"
 808    AXIS_LEFT_MIDDLE = "axis left middle"
 809    AXIS_RIGHT_MIDDLE = "axis right middle"
 810    AXIS_TOP_MIDDLE = "axis top middle"
 811    AXIS_BOTTOM_MIDDLE = "axis bottom middle"
 812    BALL = "ball"
 813    BILINEAR = "bilinear"
 814    COLORWHEEL = "color wheel"
 815    COLORWHEEL_BLACK = "color wheel black center"
 816    COLORWHEEL_WHITE = "color wheel white center"
 817    RADIAL_INNER = "radial inner"
 818    RADIAL_OUTER = "radial outer"
 819    RADIAL_INNER_OUTER = "radial inner outer"
 820
 821
 822# Anchor lines are called sides.
 823class Side(StrEnum):
 824    """Side is used to with boundary box offset lines.
 825    They determine the position of the offset lines.
 826
 827    Valid values are: BASE, BOTTOM, DIAGONAL1, DIAGONAL2, H_CENTERLINE, LEFT, MID, RIGHT, TOP, V_CENTERLINE.
 828    """
 829
 830    BASE = "BASE"
 831    BOTTOM = "BOTTOM"
 832    DIAGONAL1 = "DIAGONAL1"
 833    DIAGONAL2 = "DIAGONAL2"
 834    H_CENTERLINE = "H_CENTERLINE"
 835    LEFT = "LEFT"
 836    MID = "MID"
 837    RIGHT = "RIGHT"
 838    TOP = "TOP"
 839    V_CENTERLINE = "V_CENTERLINE"
 840
 841
 842class State(StrEnum):
 843    """State is used for modifiers.
 844    Not implemented yet.
 845
 846    Valid values are: INITIAL, PAUSED, RESTARTING, RUNNING, STOPPED.
 847    """
 848
 849    INITIAL = "INITIAL"
 850    PAUSED = "PAUSED"
 851    RESTARTING = "RESTARTING"
 852    RUNNING = "RUNNING"
 853    STOPPED = "STOPPED"
 854
 855
 856class TexLoc(StrEnum):
 857    """TexLoc is used to set the location of the TeX related
 858    objects.
 859
 860    Valid values are: DOCUMENT, PICTURE, PREAMBLE, NONE.
 861    """
 862
 863    DOCUMENT = "DOCUMENT"  # BETWEEN \BEGIN{DOCUMENT} AND \BEGIN{TIKZPICTURE}
 864    PICTURE = "PICTURE"  # AFTER \BEGIN{PICTURE}
 865    PREAMBLE = "PREAMBLE"  # BEFORE \BEGIN{DOCUMENT}
 866    NONE = "NONE"  # Anywhere in the picture.
 867
 868
 869class Topology(StrEnum):
 870    """Topology is used for geometry classification.
 871
 872    Valid values are: CLOSED, COLLINEAR, CONGRUENT, FOLDED, INTERSECTING, OPEN, SELF_INTERSECTING, SIMPLE,
 873    YJOINT.
 874    """
 875
 876    CLOSED = "CLOSED"
 877    COLLINEAR = "COLLINEAR"
 878    CONGRUENT = "CONGRUENT"
 879    FOLDED = "FOLDED"
 880    INTERSECTING = "INTERSECTING"
 881    OPEN = "OPEN"
 882    SELF_INTERSECTING = "SELF_INTERSECTING"
 883    SIMPLE = "SIMPLE"
 884    YJOINT = "YJOINT"
 885
 886
 887class Transformation(StrEnum):
 888    """Transformation is used to set the type of a transformation.
 889
 890    Valid values are: GLIDE, MIRROR, ROTATE, SCALE, SHEAR, TRANSFORM, TRANSLATE.
 891    """
 892
 893    GLIDE = "GLIDE"
 894    MIRROR = "MIRROR"
 895    ROTATE = "ROTATE"
 896    SCALE = "SCALE"
 897    SHEAR = "SHEAR"
 898    TRANSFORM = "TRANSFORM"
 899    TRANSLATE = "TRANSLATE"
 900
 901
 902class Types(StrEnum):
 903    """All objects in simetri.graphics has type and subtype properties.
 904    Types are mostly Batch and Shape,  and subtypes are listed here.
 905    """
 906
 907    ANGULAR_DIMENSION = "ANGULAR DIMENSION"
 908    ANNOTATION = "ANNOTATION"
 909    ARC = "ARC"
 910    ARC_ARROW = "ARC_ARROW"
 911    ARC_SKETCH = "ARC_SKETCH"
 912    ARROW = "ARROW"
 913    ARROW_HEAD = "ARROW_HEAD"
 914    AXIS = "AXIS"
 915    BATCH = "BATCH"
 916    BATCH_SKETCH = "BATCH_SKETCH"
 917    BEZIER = "BEZIER"
 918    BEZIER_SKETCH = "BEZIER_SKETCH"
 919    BBOX_SKETCH = "BBOX_SKETCH"
 920    BOUNDING_BOX = "BOUNDING_BOX"
 921    BRACE = "BRACE"
 922    CANVAS = "CANVAS"
 923    CIRCLE = "CIRCLE"
 924    CIRCLE_SKETCH = "CIRCLE_SKETCH"
 925    CIRCULAR_GRID = "CIRCULAR_GRID"
 926    COLOR = "COLOR"
 927    CS = "CS"
 928    CURVE = "CURVE"
 929    CURVE_SKETCH = "CURVE_SKETCH"
 930    DIMENSION = "DIMENSION"
 931    DIRECTED = "DIRECTED_GRAPH"
 932    DIVISION = "DIVISION"
 933    DOT = "DOT"
 934    DOTS = "DOTS"
 935    EDGE = "EDGE"
 936    ELLIPSE = "ELLIPSE"
 937    ELLIPSE_SKETCH = "ELLIPSE_SKETCH"
 938    ELLIPTIC_ARC = "ELLIPTIC_ARC"
 939    FILL_STYLE = "FILL_STYLE"
 940    FONT = "FONT"
 941    FONT_SKETCH = "FONT_SKETCH"
 942    FONT_STYLE = "FONT_STYLE"
 943    FRAGMENT = "FRAGMENT"
 944    FRAGMENT_SKETCH = "FRAGMENT_SKETCH"
 945    FRAME = "FRAME"
 946    FRAME_SKETCH = "FRAME_SKETCH"
 947    FRAME_STYLE = "FRAME_STYLE"
 948    GRADIENT = "GRADIENT"
 949    GRID = "GRID"
 950    GRID_STYLE = "GRID_STYLE"
 951    HANDLE = "HANDLE"
 952    HEXAGONAL = "HEXAGONAL"
 953    HEX_GRID = "HEX_GRID"
 954    ICANVAS = "ICANVAS"
 955    INTERSECTION = "INTERSECTION"
 956    LABEL = "LABEL"
 957    LACE = "LACE"
 958    LACESKETCH = "LACE_SKETCH"
 959    LINE = "LINE"
 960    LINEAR = "LINEAR"
 961    LINE_SKETCH = "LINE_SKETCH"
 962    LINE_STYLE = "LINE_STYLE"
 963    LINPATH = "LINPATH"
 964    LOOM = "LOOM"
 965    MARKER = "MARKER"
 966    MARKER_STYLE = "MARKER_STYLE"
 967    MASK = "MASK"
 968    MIXED_GRID = "MIXED_GRID"
 969    NONE = "NONE"
 970    OBLIQUE = "OBLIQUE"
 971    OUTLINE = "OUTLINE"
 972    OVERLAP = "OVERLAP"
 973    PAGE = "PAGE"
 974    PAGE_GRID = "PAGE_GRID"
 975    PARALLEL_POLYLINE = "PARALLEL_POLYLINE"
 976    PART = "PART"
 977    PATH_OPERATION = "PATH_OPERATION"
 978    PATH_SKETCH = "PATH_SKETCH"
 979    PATTERN = "PATTERN"
 980    PATTERN_SKETCH = "PATTERN_SKETCH"
 981    PATTERN_STYLE = "PATTERN_STYLE"
 982    PETAL = "PETAL"
 983    PLAIT = "PLAIT"
 984    PLAIT_SKETCH = "PLAIT_SKETCH"
 985    POINT = "POINT"
 986    POINTS = "POINTS"
 987    POLYLINE = "POLYLINE"
 988    Q_BEZIER = "Q_BEZIER"
 989    RADIAL = "RADIAL"
 990    RECT_SKETCH = "RECT_SKETCH"
 991    RECTANGLE = "RECTANGLE"
 992    RECTANGULAR = "RECTANGULAR"
 993    REG_POLY = "REGPOLY"
 994    REG_POLY_SKETCH = "REGPOLY_SKETCH"
 995    REGULAR_POLYGON = "REGULAR_POLYGON"
 996    RHOMBIC = "RHOMBIC"
 997    SECTION = "SECTION"
 998    SEGMENT = "SEGMENT"
 999    SEGMENTS = "SEGMENTS"
1000    SHADE_STYLE = "SHADE_STYLE"
1001    SHAPE = "SHAPE"
1002    SHAPE_SKETCH = "SHAPE_SKETCH"
1003    SHAPE_STYLE = "SHAPE_STYLE"
1004    SINE_WAVE = "SINE_WAVE"
1005    SKETCH = "SKETCH"
1006    SKETCH_STYLE = "SKETCH_STYLE"
1007    SQUARE = "SQUARE"
1008    SQUARE_GRID = "SQUARE_GRID"
1009    STAR = "STAR"
1010    STYLE = "STYLE"
1011    SVG_PATH = "SVG_PATH"
1012    SVG_PATH_SKETCH = "SVG_PATH_SKETCH"
1013    TAG = "TAG"
1014    TAG_SKETCH = "TAG_SKETCH"
1015    TAG_STYLE = "TAG_STYLE"
1016    TEX = "TEX"  # USED FOR GENERATING OUTPUTFILE.TEX
1017    TEX_SKETCH = "TEX_SKETCH"
1018    TEXT = "TEXT"
1019    TEXTANCHOR = "TEXT_ANCHOR"
1020    TEXT_ANCHOR_LINE = "TEXT_ANCHORLINE"
1021    TEXT_ANCHOR_POINT = "TEXT_ANCHORPOINT"
1022    THREAD = "THREAD"
1023    TRANSFORM = "TRANSFORM"
1024    TRANSFORMATION = "TRANSFORMATION"
1025    TRIANGLE = "TRIANGLE"
1026    TURTLE = "TURTLE"
1027    UNDIRECTED = "UNDIRECTED_GRAPH"
1028    VERTEX = "VERTEX"
1029    WARP = "WARP"
1030    WEFT = "WEFT"
1031    WEIGHTED = "WEIGHTED_GRAPH"
1032
1033
1034drawable_types = [
1035    Types.ARC,
1036    Types.ARC_ARROW,
1037    Types.ARROW,
1038    Types.ARROW_HEAD,
1039    Types.BATCH,
1040    Types.BEZIER,
1041    Types.BOUNDING_BOX,
1042    Types.CIRCLE,
1043    Types.CIRCULAR_GRID,
1044    Types.DIMENSION,
1045    Types.DIVISION,
1046    Types.DOT,
1047    Types.DOTS,
1048    Types.EDGE,
1049    Types.ELLIPSE,
1050    Types.FRAGMENT,
1051    Types.HEX_GRID,
1052    Types.INTERSECTION,
1053    Types.LACE,
1054    Types.LINPATH,
1055    Types.MIXED_GRID,
1056    Types.OUTLINE,
1057    Types.OVERLAP,
1058    Types.PARALLEL_POLYLINE,
1059    Types.PATTERN,
1060    Types.PLAIT,
1061    Types.POLYLINE,
1062    Types.Q_BEZIER,
1063    Types.RECTANGLE,
1064    Types.SECTION,
1065    Types.SEGMENT,
1066    Types.SHAPE,
1067    Types.SINE_WAVE,
1068    Types.SQUARE_GRID,
1069    Types.STAR,
1070    Types.SVG_PATH,
1071    Types.TAG,
1072    Types.TURTLE,
1073]
1074
1075shape_types = [
1076    Types.ARC,
1077    Types.ARROW_HEAD,
1078    Types.BEZIER,
1079    Types.BRACE,
1080    Types.CIRCLE,
1081    Types.CURVE,
1082    Types.DIVISION,
1083    Types.ELLIPSE,
1084    Types.FRAME,
1085    Types.INTERSECTION,
1086    Types.LINE,
1087    Types.POLYLINE,
1088    Types.Q_BEZIER,
1089    Types.SECTION,
1090    Types.SHAPE,
1091    Types.SINE_WAVE,
1092]
1093
1094batch_types = [
1095    Types.ANGULAR_DIMENSION,
1096    Types.ANNOTATION,
1097    Types.ARC_ARROW,
1098    Types.ARROW,
1099    Types.BATCH,
1100    Types.CIRCULAR_GRID,
1101    Types.DIMENSION,
1102    Types.DOTS,
1103    Types.HEX_GRID,
1104    Types.LACE,
1105    Types.LINPATH,
1106    Types.MARKER,
1107    Types.MIXED_GRID,
1108    Types.OVERLAP,
1109    Types.PARALLEL_POLYLINE,
1110    Types.PATTERN,
1111    Types.SQUARE_GRID,
1112    Types.STAR,
1113    Types.SVG_PATH,
1114    Types.TURTLE,
1115]
1116
1117# Python Version 3.9 cannot handle Union[*drawable_types]
1118Drawable: TypeAlias = Union[
1119    Types.ARC,
1120    Types.ARC_ARROW,
1121    Types.ARROW,
1122    Types.ARROW_HEAD,
1123    Types.BATCH,
1124    Types.CIRCLE,
1125    Types.CIRCULAR_GRID,
1126    Types.DIMENSION,
1127    Types.DOT,
1128    Types.DOTS,
1129    Types.EDGE,
1130    Types.ELLIPSE,
1131    Types.FRAGMENT,
1132    Types.HEX_GRID,
1133    Types.INTERSECTION,
1134    Types.LACE,
1135    Types.LINPATH,
1136    Types.MIXED_GRID,
1137    Types.OUTLINE,
1138    Types.OVERLAP,
1139    Types.PARALLEL_POLYLINE,
1140    Types.PATTERN,
1141    Types.PLAIT,
1142    Types.POLYLINE,
1143    Types.RECTANGLE,
1144    Types.SECTION,
1145    Types.SEGMENT,
1146    Types.SHAPE,
1147    Types.SINE_WAVE,
1148    Types.SQUARE_GRID,
1149    Types.STAR,
1150    Types.SVG_PATH,
1151    Types.TAG,
1152    Types.TURTLE,
1153]
1154
1155
1156anchors = [
1157    "southeast",
1158    "southwest",
1159    "northeast",
1160    "northwest",
1161    "south",
1162    "north",
1163    "east",
1164    "west",
1165    "center",
1166    "midpoint",
1167    "left",
1168    "right",
1169    "top",
1170    "bottom",
1171    "diagonal1",
1172    "diagonal2",
1173    "horiz_centerline",
1174    "vert_centerline",
1175    "left_of",
1176    "right_of",
1177    "above",
1178    "below",
1179    "above_left",
1180    "above_right",
1181    "below_left",
1182    "below_right",
1183    "centered",
1184    "polar_pos",
1185    "s",
1186    "n",
1187    "e",
1188    "w",
1189    "sw",
1190    "se",
1191    "nw",
1192    "ne",
1193    "c",
1194    "d1",
1195    "d",
1196    "corners",
1197    "all_anchors",
1198    "width",
1199    "height",
1200]