-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmicrogen.shape.html
More file actions
2582 lines (2384 loc) · 457 KB
/
Copy pathmicrogen.shape.html
File metadata and controls
2582 lines (2384 loc) · 457 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>microgen.shape package — Microgen 2.0.0b1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="_static/jupyter-sphinx.css" />
<link rel="stylesheet" type="text/css" href="_static/thebelab.css" />
<link rel="canonical" href="https://3mah.github.io/microgen-docs/microgen.shape.html"/>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=391fd9ae"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/thebelab-helper.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-mml-chtml.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="microgen.shape.strut_lattice subpackage" href="microgen.shape.strut_lattice.html" />
<link rel="prev" title="Microgen modules" href="modules.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #24445C" >
<a href="index.html" class="icon icon-home">
Microgen
<img src="_static/microgen.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p style="padding: 0.5em 1.618em; margin-bottom: 0;">
<a href="https://3mah.github.io/" style="color: #d9d9d9; font-weight: bold; text-decoration: none;">
← Back to 3MAH
</a>
</p>
<hr style="border-color: #4e4e4e; margin: 0.5em 1.618em;">
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Overview.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Overview.html#brief-examples">Brief examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Install.html">Install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Install.html#with-pip">With pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="Install.html#with-conda">With conda</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quick_start.html">Quick-Start Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quick_start.html#first-steps">First Steps</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start.html#creating-a-basic-tpms-shape">Creating a Basic TPMS Shape</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start.html#tpms-part-types">TPMS Part Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start.html#creating-basic-shapes">Creating Basic Shapes</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start.html#generating-cad-geometry">Generating CAD Geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start.html#exporting-results">Exporting Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start.html#next-steps">Next Steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#basic-shapes">Basic Shapes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#box">Box</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#sphere">Sphere</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#cylinder">Cylinder</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#ellipsoid">Ellipsoid</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#capsule">Capsule</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#extruded-polygon">Extruded Polygon</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#tpms-surfaces">TPMS Surfaces</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#available-surface-functions">Available Surface Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#tpms-examples">TPMS Examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#using-density-instead-of-offset">Using Density Instead of Offset</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#spherical-tpms">Spherical TPMS</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#cylindrical-tpms">Cylindrical TPMS</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#d-operations">3D Operations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#repeat">Repeat</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#raster">Raster</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#meshing">Meshing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#regular-mesh-with-gmsh">Regular Mesh with Gmsh</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#periodic-mesh">Periodic Mesh</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.html#remeshing-with-mmg">Remeshing with Mmg</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#further-resources">Further Resources</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="Documentation.html">Microgen API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="modules.html">Microgen modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-microgen.phase">Phase module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.phase.Phase"><code class="docutils literal notranslate"><span class="pre">Phase</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.phase.Piece"><code class="docutils literal notranslate"><span class="pre">Piece</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-microgen.operations">Operations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.cut_phase_by_shape_list"><code class="docutils literal notranslate"><span class="pre">cut_phase_by_shape_list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.cut_phases"><code class="docutils literal notranslate"><span class="pre">cut_phases()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.cut_phases_by_shape"><code class="docutils literal notranslate"><span class="pre">cut_phases_by_shape()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.cut_shapes"><code class="docutils literal notranslate"><span class="pre">cut_shapes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.fuse_shapes"><code class="docutils literal notranslate"><span class="pre">fuse_shapes()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.raster_phase"><code class="docutils literal notranslate"><span class="pre">raster_phase()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.repeat_polydata"><code class="docutils literal notranslate"><span class="pre">repeat_polydata()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.repeat_shape"><code class="docutils literal notranslate"><span class="pre">repeat_shape()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.rescale"><code class="docutils literal notranslate"><span class="pre">rescale()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.rotate"><code class="docutils literal notranslate"><span class="pre">rotate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.operations.rotate_euler"><code class="docutils literal notranslate"><span class="pre">rotate_euler()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-microgen.rve">Rve</a><ul>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.rve.Rve"><code class="docutils literal notranslate"><span class="pre">Rve</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-microgen.periodic">Periodic</a><ul>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.periodic.periodic_split_and_translate"><code class="docutils literal notranslate"><span class="pre">periodic_split_and_translate()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-microgen.mesh">Mesh</a><ul>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.mesh.OutputMeshNotPeriodicError"><code class="docutils literal notranslate"><span class="pre">OutputMeshNotPeriodicError</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.mesh.is_periodic"><code class="docutils literal notranslate"><span class="pre">is_periodic()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.mesh.mesh"><code class="docutils literal notranslate"><span class="pre">mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.mesh.mesh_periodic"><code class="docutils literal notranslate"><span class="pre">mesh_periodic()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-microgen.remesh">Remesh</a><ul>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.remesh.InputMeshNotPeriodicError"><code class="docutils literal notranslate"><span class="pre">InputMeshNotPeriodicError</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.remesh.OutputMeshNotPeriodicError"><code class="docutils literal notranslate"><span class="pre">OutputMeshNotPeriodicError</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.remesh.remesh_keeping_boundaries_for_fem"><code class="docutils literal notranslate"><span class="pre">remesh_keeping_boundaries_for_fem()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="modules.html#module-microgen.external">External</a><ul>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.external.Mmg"><code class="docutils literal notranslate"><span class="pre">Mmg</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.external.MmgError"><code class="docutils literal notranslate"><span class="pre">MmgError</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="modules.html#microgen.external.Neper"><code class="docutils literal notranslate"><span class="pre">Neper</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">microgen.shape package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#shape-microgen-shape">Shape (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Box"><code class="docutils literal notranslate"><span class="pre">Box</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Box.generate_cad"><code class="docutils literal notranslate"><span class="pre">Box.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Box.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Box.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Capsule"><code class="docutils literal notranslate"><span class="pre">Capsule</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Capsule.generate_cad"><code class="docutils literal notranslate"><span class="pre">Capsule.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Capsule.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Capsule.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Cylinder"><code class="docutils literal notranslate"><span class="pre">Cylinder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Cylinder.generate_cad"><code class="docutils literal notranslate"><span class="pre">Cylinder.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Cylinder.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Cylinder.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.CylindricalTpms"><code class="docutils literal notranslate"><span class="pre">CylindricalTpms</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Ellipsoid"><code class="docutils literal notranslate"><span class="pre">Ellipsoid</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Ellipsoid.generate_cad"><code class="docutils literal notranslate"><span class="pre">Ellipsoid.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Ellipsoid.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Ellipsoid.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.ExtrudedPolygon"><code class="docutils literal notranslate"><span class="pre">ExtrudedPolygon</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.ExtrudedPolygon.generate_cad"><code class="docutils literal notranslate"><span class="pre">ExtrudedPolygon.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.ExtrudedPolygon.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">ExtrudedPolygon.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.GradedInfill"><code class="docutils literal notranslate"><span class="pre">GradedInfill</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Infill"><code class="docutils literal notranslate"><span class="pre">Infill</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Infill.lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Infill.lower_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Infill.sheet"><code class="docutils literal notranslate"><span class="pre">Infill.sheet</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Infill.upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Infill.upper_skeletal</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.NormedDistance"><code class="docutils literal notranslate"><span class="pre">NormedDistance</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.NormedDistance.compute_offset"><code class="docutils literal notranslate"><span class="pre">NormedDistance.compute_offset()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Polyhedron"><code class="docutils literal notranslate"><span class="pre">Polyhedron</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Polyhedron.generate_cad"><code class="docutils literal notranslate"><span class="pre">Polyhedron.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Polyhedron.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Polyhedron.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Shape"><code class="docutils literal notranslate"><span class="pre">Shape</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.bounds"><code class="docutils literal notranslate"><span class="pre">Shape.bounds</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.center"><code class="docutils literal notranslate"><span class="pre">Shape.center</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.evaluate"><code class="docutils literal notranslate"><span class="pre">Shape.evaluate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.func"><code class="docutils literal notranslate"><span class="pre">Shape.func</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.generate_cad"><code class="docutils literal notranslate"><span class="pre">Shape.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Shape.generate_surface_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.generate_volume_mesh"><code class="docutils literal notranslate"><span class="pre">Shape.generate_volume_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.orientation"><code class="docutils literal notranslate"><span class="pre">Shape.orientation</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.period"><code class="docutils literal notranslate"><span class="pre">Shape.period</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.require_func"><code class="docutils literal notranslate"><span class="pre">Shape.require_func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.rotate"><code class="docutils literal notranslate"><span class="pre">Shape.rotate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.scale"><code class="docutils literal notranslate"><span class="pre">Shape.scale()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.smooth_difference"><code class="docutils literal notranslate"><span class="pre">Shape.smooth_difference()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.smooth_intersection"><code class="docutils literal notranslate"><span class="pre">Shape.smooth_intersection()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.smooth_union"><code class="docutils literal notranslate"><span class="pre">Shape.smooth_union()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Shape.translate"><code class="docutils literal notranslate"><span class="pre">Shape.translate()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Sphere"><code class="docutils literal notranslate"><span class="pre">Sphere</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Sphere.generate_cad"><code class="docutils literal notranslate"><span class="pre">Sphere.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Sphere.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Sphere.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.SphericalTpms"><code class="docutils literal notranslate"><span class="pre">SphericalTpms</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Spinodoid"><code class="docutils literal notranslate"><span class="pre">Spinodoid</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Spinodoid.generate_cad"><code class="docutils literal notranslate"><span class="pre">Spinodoid.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Spinodoid.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Spinodoid.generate_surface_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Spinodoid.generate_volume_mesh"><code class="docutils literal notranslate"><span class="pre">Spinodoid.generate_volume_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Spinodoid.grid"><code class="docutils literal notranslate"><span class="pre">Spinodoid.grid</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Spinodoid.grid_solid"><code class="docutils literal notranslate"><span class="pre">Spinodoid.grid_solid</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Spinodoid.surface"><code class="docutils literal notranslate"><span class="pre">Spinodoid.surface</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Sweep"><code class="docutils literal notranslate"><span class="pre">Sweep</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.Tpms"><code class="docutils literal notranslate"><span class="pre">Tpms</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.as_lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.as_lower_skeletal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.as_sheet"><code class="docutils literal notranslate"><span class="pre">Tpms.as_sheet()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.as_surface"><code class="docutils literal notranslate"><span class="pre">Tpms.as_surface()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.as_upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.as_upper_skeletal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.generate_cad"><code class="docutils literal notranslate"><span class="pre">Tpms.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Tpms.generate_surface_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.generate_volume_mesh"><code class="docutils literal notranslate"><span class="pre">Tpms.generate_volume_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.grid_lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.grid_lower_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.grid_sheet"><code class="docutils literal notranslate"><span class="pre">Tpms.grid_sheet</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.grid_upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.grid_upper_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.lower_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.offset"><code class="docutils literal notranslate"><span class="pre">Tpms.offset</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.offset_from_density"><code class="docutils literal notranslate"><span class="pre">Tpms.offset_from_density()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.raw_field"><code class="docutils literal notranslate"><span class="pre">Tpms.raw_field</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.sheet"><code class="docutils literal notranslate"><span class="pre">Tpms.sheet</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.skeletals"><code class="docutils literal notranslate"><span class="pre">Tpms.skeletals</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.surface"><code class="docutils literal notranslate"><span class="pre">Tpms.surface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.Tpms.upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.upper_skeletal</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.batch_smooth_union"><code class="docutils literal notranslate"><span class="pre">batch_smooth_union()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.from_field"><code class="docutils literal notranslate"><span class="pre">from_field()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.new_geometry"><code class="docutils literal notranslate"><span class="pre">new_geometry()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#basic-geometry-microgen-shape-shape">Basic Geometry (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.shape</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.shape.Shape"><code class="docutils literal notranslate"><span class="pre">Shape</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.bounds"><code class="docutils literal notranslate"><span class="pre">Shape.bounds</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.center"><code class="docutils literal notranslate"><span class="pre">Shape.center</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.evaluate"><code class="docutils literal notranslate"><span class="pre">Shape.evaluate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.func"><code class="docutils literal notranslate"><span class="pre">Shape.func</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.generate_cad"><code class="docutils literal notranslate"><span class="pre">Shape.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Shape.generate_surface_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.generate_volume_mesh"><code class="docutils literal notranslate"><span class="pre">Shape.generate_volume_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.orientation"><code class="docutils literal notranslate"><span class="pre">Shape.orientation</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.period"><code class="docutils literal notranslate"><span class="pre">Shape.period</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.require_func"><code class="docutils literal notranslate"><span class="pre">Shape.require_func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.rotate"><code class="docutils literal notranslate"><span class="pre">Shape.rotate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.scale"><code class="docutils literal notranslate"><span class="pre">Shape.scale()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.smooth_difference"><code class="docutils literal notranslate"><span class="pre">Shape.smooth_difference()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.smooth_intersection"><code class="docutils literal notranslate"><span class="pre">Shape.smooth_intersection()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.smooth_union"><code class="docutils literal notranslate"><span class="pre">Shape.smooth_union()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.shape.Shape.translate"><code class="docutils literal notranslate"><span class="pre">Shape.translate()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.shape.ShellCreationError"><code class="docutils literal notranslate"><span class="pre">ShellCreationError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#box-microgen-shape-box">Box (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.box</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.box.Box"><code class="docutils literal notranslate"><span class="pre">Box</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.box.Box.generate_cad"><code class="docutils literal notranslate"><span class="pre">Box.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.box.Box.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Box.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#capsule-microgen-shape-capsule">Capsule (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.capsule</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.capsule.Capsule"><code class="docutils literal notranslate"><span class="pre">Capsule</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.capsule.Capsule.generate_cad"><code class="docutils literal notranslate"><span class="pre">Capsule.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.capsule.Capsule.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Capsule.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#cylinder-microgen-shape-cylinder">Cylinder (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.cylinder</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.cylinder.Cylinder"><code class="docutils literal notranslate"><span class="pre">Cylinder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.cylinder.Cylinder.generate_cad"><code class="docutils literal notranslate"><span class="pre">Cylinder.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.cylinder.Cylinder.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Cylinder.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ellipsoid-microgen-shape-ellipsoid">Ellipsoid (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.ellipsoid</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.ellipsoid.Ellipsoid"><code class="docutils literal notranslate"><span class="pre">Ellipsoid</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.ellipsoid.Ellipsoid.generate_cad"><code class="docutils literal notranslate"><span class="pre">Ellipsoid.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.ellipsoid.Ellipsoid.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Ellipsoid.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#extruded-polygon-microgen-shape-extruded-polygon">Extruded Polygon (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.extruded_polygon</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.extruded_polygon.ExtrudedPolygon"><code class="docutils literal notranslate"><span class="pre">ExtrudedPolygon</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.extruded_polygon.ExtrudedPolygon.generate_cad"><code class="docutils literal notranslate"><span class="pre">ExtrudedPolygon.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.extruded_polygon.ExtrudedPolygon.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">ExtrudedPolygon.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#polyhedron-microgen-shape-polyhedron">Polyhedron (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.polyhedron</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.polyhedron.Polyhedron"><code class="docutils literal notranslate"><span class="pre">Polyhedron</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.polyhedron.Polyhedron.generate_cad"><code class="docutils literal notranslate"><span class="pre">Polyhedron.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.polyhedron.Polyhedron.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Polyhedron.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.polyhedron.read_obj"><code class="docutils literal notranslate"><span class="pre">read_obj()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#sphere-microgen-shape-sphere">Sphere (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.sphere</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.sphere.Sphere"><code class="docutils literal notranslate"><span class="pre">Sphere</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.sphere.Sphere.generate_cad"><code class="docutils literal notranslate"><span class="pre">Sphere.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.sphere.Sphere.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Sphere.generate_surface_mesh()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#tpms-microgen-shape-tpms">TPMS (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.tpms</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.tpms.CylindricalTpms"><code class="docutils literal notranslate"><span class="pre">CylindricalTpms</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.tpms.GradedInfill"><code class="docutils literal notranslate"><span class="pre">GradedInfill</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.tpms.Infill"><code class="docutils literal notranslate"><span class="pre">Infill</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Infill.lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Infill.lower_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Infill.sheet"><code class="docutils literal notranslate"><span class="pre">Infill.sheet</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Infill.upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Infill.upper_skeletal</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.tpms.ShellCreationError"><code class="docutils literal notranslate"><span class="pre">ShellCreationError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.tpms.SphericalTpms"><code class="docutils literal notranslate"><span class="pre">SphericalTpms</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.tpms.Sweep"><code class="docutils literal notranslate"><span class="pre">Sweep</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.tpms.Tpms"><code class="docutils literal notranslate"><span class="pre">Tpms</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.as_lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.as_lower_skeletal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.as_sheet"><code class="docutils literal notranslate"><span class="pre">Tpms.as_sheet()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.as_surface"><code class="docutils literal notranslate"><span class="pre">Tpms.as_surface()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.as_upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.as_upper_skeletal()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.generate_cad"><code class="docutils literal notranslate"><span class="pre">Tpms.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">Tpms.generate_surface_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.generate_volume_mesh"><code class="docutils literal notranslate"><span class="pre">Tpms.generate_volume_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.grid_lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.grid_lower_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.grid_sheet"><code class="docutils literal notranslate"><span class="pre">Tpms.grid_sheet</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.grid_upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.grid_upper_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.lower_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.lower_skeletal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.offset"><code class="docutils literal notranslate"><span class="pre">Tpms.offset</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.offset_from_density"><code class="docutils literal notranslate"><span class="pre">Tpms.offset_from_density()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.raw_field"><code class="docutils literal notranslate"><span class="pre">Tpms.raw_field</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.sheet"><code class="docutils literal notranslate"><span class="pre">Tpms.sheet</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.skeletals"><code class="docutils literal notranslate"><span class="pre">Tpms.skeletals</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.surface"><code class="docutils literal notranslate"><span class="pre">Tpms.surface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#microgen.shape.tpms.Tpms.upper_skeletal"><code class="docutils literal notranslate"><span class="pre">Tpms.upper_skeletal</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#implicit-operations-microgen-shape-implicit-ops">Implicit Operations (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.implicit_ops</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.batch_smooth_union"><code class="docutils literal notranslate"><span class="pre">batch_smooth_union()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.blend"><code class="docutils literal notranslate"><span class="pre">blend()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.box"><code class="docutils literal notranslate"><span class="pre">box()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.complement"><code class="docutils literal notranslate"><span class="pre">complement()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.difference"><code class="docutils literal notranslate"><span class="pre">difference()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.from_field"><code class="docutils literal notranslate"><span class="pre">from_field()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.intersection"><code class="docutils literal notranslate"><span class="pre">intersection()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.normalize_to_sdf"><code class="docutils literal notranslate"><span class="pre">normalize_to_sdf()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.repeat"><code class="docutils literal notranslate"><span class="pre">repeat()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.shell"><code class="docutils literal notranslate"><span class="pre">shell()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.smooth_difference"><code class="docutils literal notranslate"><span class="pre">smooth_difference()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.smooth_intersection"><code class="docutils literal notranslate"><span class="pre">smooth_intersection()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.smooth_union"><code class="docutils literal notranslate"><span class="pre">smooth_union()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.implicit_ops.union"><code class="docutils literal notranslate"><span class="pre">union()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.fischer_koch_s"><code class="docutils literal notranslate"><span class="pre">fischer_koch_s()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.gyroid"><code class="docutils literal notranslate"><span class="pre">gyroid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.honeycomb"><code class="docutils literal notranslate"><span class="pre">honeycomb()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.honeycomb_gyroid"><code class="docutils literal notranslate"><span class="pre">honeycomb_gyroid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.honeycomb_lidinoid"><code class="docutils literal notranslate"><span class="pre">honeycomb_lidinoid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.honeycomb_schoen_iwp"><code class="docutils literal notranslate"><span class="pre">honeycomb_schoen_iwp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.honeycomb_schwarz_d"><code class="docutils literal notranslate"><span class="pre">honeycomb_schwarz_d()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.honeycomb_schwarz_p"><code class="docutils literal notranslate"><span class="pre">honeycomb_schwarz_p()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.lidinoid"><code class="docutils literal notranslate"><span class="pre">lidinoid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.neovius"><code class="docutils literal notranslate"><span class="pre">neovius()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.pmy"><code class="docutils literal notranslate"><span class="pre">pmy()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.schoen_frd"><code class="docutils literal notranslate"><span class="pre">schoen_frd()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.schoen_iwp"><code class="docutils literal notranslate"><span class="pre">schoen_iwp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.schwarz_d"><code class="docutils literal notranslate"><span class="pre">schwarz_d()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.schwarz_p"><code class="docutils literal notranslate"><span class="pre">schwarz_p()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#microgen.shape.surface_functions.split_p"><code class="docutils literal notranslate"><span class="pre">split_p()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microgen.shape.strut_lattice.html">microgen.shape.strut_lattice subpackage</a><ul>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#abstract-lattice-microgen-shape-strut-lattice-abstract-lattice">Abstract Lattice (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.abstract_lattice</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice"><code class="docutils literal notranslate"><span class="pre">AbstractLattice</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.base_vertices"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.base_vertices</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.cad_shape"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.cad_shape</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.generate_cad"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.generate_cad()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.generate_implicit"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.generate_implicit()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.generate_surface_mesh"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.generate_surface_mesh()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.mesh_for_fem"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.mesh_for_fem()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.strut_heights"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.strut_heights</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.strut_number"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.strut_number</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.strut_vertex_pairs"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.strut_vertex_pairs</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.volume"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.volume</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.abstract_lattice.AbstractLattice.vtk_shape"><code class="docutils literal notranslate"><span class="pre">AbstractLattice.vtk_shape</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#body-centered-cubic-microgen-shape-strut-lattice-body-centered-cubic">Body Centered Cubic (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.body_centered_cubic</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.body_centered_cubic.BodyCenteredCubic"><code class="docutils literal notranslate"><span class="pre">BodyCenteredCubic</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#cubic-microgen-shape-strut-lattice-cubic">Cubic (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.cubic</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.cubic.Cubic"><code class="docutils literal notranslate"><span class="pre">Cubic</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#cuboctahedron-microgen-shape-strut-lattice-cuboctahedron">Cuboctahedron (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.cuboctahedron</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.cuboctahedron.Cuboctahedron"><code class="docutils literal notranslate"><span class="pre">Cuboctahedron</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#custom-lattice-microgen-shape-strut-lattice-custom-lattice">Custom Lattice (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.custom_lattice</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.custom_lattice.CustomLattice"><code class="docutils literal notranslate"><span class="pre">CustomLattice</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#diamond-microgen-shape-strut-lattice-diamond">Diamond (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.diamond</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.diamond.Diamond"><code class="docutils literal notranslate"><span class="pre">Diamond</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#face-centered-cubic-microgen-shape-strut-lattice-face-centered-cubic">Face Centered Cubic (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.face_centered_cubic</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.face_centered_cubic.FaceCenteredCubic"><code class="docutils literal notranslate"><span class="pre">FaceCenteredCubic</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#octahedron-microgen-shape-strut-lattice-octahedron">Octahedron (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.octahedron</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.octahedron.Octahedron"><code class="docutils literal notranslate"><span class="pre">Octahedron</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#octet-truss-microgen-shape-strut-lattice-octet-truss">Octet-truss (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.octet_truss</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.octet_truss.OctetTruss"><code class="docutils literal notranslate"><span class="pre">OctetTruss</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#rhombic-cuboctahedron-microgen-shape-strut-lattice-rhombic-cuboctahedron">Rhombic Cuboctahedron (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.rhombic_cuboctahedron</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.rhombic_cuboctahedron.RhombicCuboctahedron"><code class="docutils literal notranslate"><span class="pre">RhombicCuboctahedron</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#rhombic-dodecahedron-microgen-shape-strut-lattice-rhombic-dodecahedron">Rhombic Dodecahedron (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.rhombic_dodecahedron</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.rhombic_dodecahedron.RhombicDodecahedron"><code class="docutils literal notranslate"><span class="pre">RhombicDodecahedron</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#truncated-cube-microgen-shape-strut-lattice-truncated-cube">Truncated Cube (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.truncated_cube</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.truncated_cube.TruncatedCube"><code class="docutils literal notranslate"><span class="pre">TruncatedCube</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#truncated-cuboctahedron-microgen-shape-strut-lattice-truncated-cuboctahedron">Truncated Cuboctahedron (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.truncated_cuboctahedron</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.truncated_cuboctahedron.TruncatedCuboctahedron"><code class="docutils literal notranslate"><span class="pre">TruncatedCuboctahedron</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#truncated-octahedron-microgen-shape-strut-lattice-truncated-octahedron">Truncated Octahedron (<code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape.strut_lattice.truncated_octahedron</span></code>)</a></li>
<li class="toctree-l3"><a class="reference internal" href="microgen.shape.strut_lattice.html#microgen.shape.strut_lattice.truncated_octahedron.TruncatedOctahedron"><code class="docutils literal notranslate"><span class="pre">TruncatedOctahedron</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/basic_shapes.html">Geometries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/basic_shapes.html#basic-shapes">Basic shapes</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/basic_shapes.html#platon-polyhedra">Platon polyhedra</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/lattices.html">Lattices</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/lattices.html#octet-truss">Octet-truss</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lattices.html#honeycomb">Honeycomb</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lattices.html#preset-strut-based-lattices">Preset strut-based lattices</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lattices.html#custom-strut-based-lattices">Custom strut-based lattices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/tpms.html">Triply Periodic Minimal Surfaces (TPMS)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/tpms.html#gyroid">Gyroid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/tpms.html#tpms-available">TPMS available</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/tpms.html#spherical-gyroid">Spherical gyroid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/tpms.html#shell">Shell</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/3d_operations.html">3D operations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/3d_operations.html#repeating-unit-geometry">Repeating unit geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/3d_operations.html#raster-ellipsoid">Raster Ellipsoid</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/3d_operations.html#voronoi">Voronoi</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/3d_operations.html#voronoi-gyroid">Voronoi gyroid</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/mesh.html">Mesh</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/mesh.html#id1">Mesh</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/mesh.html#periodic-mesh">Periodic Mesh</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/mesh.html#mmg">mmg</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/mesh.html#mmg-voronoi">mmg Voronoi</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/mesh.html#periodic-remeshing">Periodic remeshing</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #24445C" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Microgen</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="Documentation.html">Microgen API</a></li>
<li class="breadcrumb-item active">microgen.shape package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/microgen.shape.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-microgen.shape">
<span id="microgen-shape-package"></span><h1>microgen.shape package<a class="headerlink" href="#module-microgen.shape" title="Link to this heading"></a></h1>
<p>Shape.</p>
<section id="shape-microgen-shape">
<h2>Shape (<a class="reference internal" href="#module-microgen.shape" title="microgen.shape"><code class="xref py py-mod docutils literal notranslate"><span class="pre">microgen.shape</span></code></a>)<a class="headerlink" href="#shape-microgen-shape" title="Link to this heading"></a></h2>
<div class="jupyter_cell docutils container">
<div class="cell_output docutils container">
</div>
</div>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.Box">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">Box</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dim</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(1,</span> <span class="pre">1,</span> <span class="pre">1)</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.Box" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a></p>
<p>Class to generate a box.</p>
<p>The implicit field is the canonical AABB SDF
(<code class="docutils literal notranslate"><span class="pre">max(|x|-hx,</span> <span class="pre">|y|-hy,</span> <span class="pre">|z|-hz)</span></code> decomposed into outside/inside parts),
evaluated in the box’s local frame so <code class="docutils literal notranslate"><span class="pre">center</span></code> and <code class="docutils literal notranslate"><span class="pre">orientation</span></code>
transform the field correctly. Set on every instance so boxes compose
via <code class="docutils literal notranslate"><span class="pre">|</span></code> / <code class="docutils literal notranslate"><span class="pre">&</span></code> / <code class="docutils literal notranslate"><span class="pre">-</span></code> and stay usable without the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra
(only <a class="reference internal" href="#microgen.shape.Box.generate_cad" title="microgen.shape.Box.generate_cad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_cad()</span></code></a> requires CAD).</p>
<div class="jupyter_cell docutils container">
<div class="cell_output docutils container">
<img alt="_images/microgen.shape_1_0.png" src="_images/microgen.shape_1_0.png" />
</div>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Box.generate_cad">
<span class="sig-name descname"><span class="pre">generate_cad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">CadShape</span></span></span><a class="headerlink" href="#microgen.shape.Box.generate_cad" title="Link to this definition"></a></dt>
<dd><p>Generate a box CAD shape (OCCT). Requires the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Box.generate_surface_mesh">
<span class="sig-name descname"><span class="pre">generate_surface_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BoundsType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.PolyData</span></span></span><a class="headerlink" href="#microgen.shape.Box.generate_surface_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate a box VTK shape using the given parameters.</p>
<p>When <code class="docutils literal notranslate"><span class="pre">bounds</span></code> or <code class="docutils literal notranslate"><span class="pre">resolution</span></code> is explicitly provided, fall back to
the implicit (marching-cubes-on-SDF) base implementation so polymorphic
callers that ask for a specific sampling get what they asked for.
Otherwise the native <code class="xref py py-class docutils literal notranslate"><span class="pre">pyvista.Box</span></code> (fixed 6-face quad mesh
controlled by <code class="docutils literal notranslate"><span class="pre">level</span></code>) is used.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.Capsule">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">Capsule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">radius</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.Capsule" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a></p>
<p>Class to generate a capsule (cylinder with hemispherical ends).</p>
<p>Canonical frame: capsule axis along <code class="docutils literal notranslate"><span class="pre">+x</span></code>, segment from
<code class="docutils literal notranslate"><span class="pre">(-height/2,</span> <span class="pre">0,</span> <span class="pre">0)</span></code> to <code class="docutils literal notranslate"><span class="pre">(+height/2,</span> <span class="pre">0,</span> <span class="pre">0)</span></code>, radius <code class="docutils literal notranslate"><span class="pre">radius</span></code>.
The implicit field is the point-to-segment distance minus radius
(Inigo Quilez capsule SDF), evaluated in the local frame so
<code class="docutils literal notranslate"><span class="pre">center</span></code> and <code class="docutils literal notranslate"><span class="pre">orientation</span></code> transform the field correctly. Set on
every instance so capsules compose via <code class="docutils literal notranslate"><span class="pre">|</span></code> / <code class="docutils literal notranslate"><span class="pre">&</span></code> / <code class="docutils literal notranslate"><span class="pre">-</span></code> and
stay usable without the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra (only <a class="reference internal" href="#microgen.shape.Capsule.generate_cad" title="microgen.shape.Capsule.generate_cad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_cad()</span></code></a>
requires CAD).</p>
<div class="jupyter_cell docutils container">
<div class="cell_output docutils container">
<img alt="_images/microgen.shape_2_0.png" src="_images/microgen.shape_2_0.png" />
</div>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Capsule.generate_cad">
<span class="sig-name descname"><span class="pre">generate_cad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">CadShape</span></span></span><a class="headerlink" href="#microgen.shape.Capsule.generate_cad" title="Link to this definition"></a></dt>
<dd><p>Generate a capsule CAD shape (OCCT). Requires the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Capsule.generate_surface_mesh">
<span class="sig-name descname"><span class="pre">generate_surface_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">theta_resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phi_resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.PolyData</span></span></span><a class="headerlink" href="#microgen.shape.Capsule.generate_surface_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate a capsule VTK shape using the given parameters.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.Cylinder">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">Cylinder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">radius</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.Cylinder" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a></p>
<p>Class to generate a cylinder.</p>
<p>Canonical frame: cylinder axis along <code class="docutils literal notranslate"><span class="pre">+x</span></code> from
<code class="docutils literal notranslate"><span class="pre">(-height/2,</span> <span class="pre">0,</span> <span class="pre">0)</span></code> to <code class="docutils literal notranslate"><span class="pre">(+height/2,</span> <span class="pre">0,</span> <span class="pre">0)</span></code>, radius <code class="docutils literal notranslate"><span class="pre">radius</span></code>.
The implicit field is a capped-cylinder SDF (radial + axial
distance composition), evaluated in the local frame so <code class="docutils literal notranslate"><span class="pre">center</span></code>
and <code class="docutils literal notranslate"><span class="pre">orientation</span></code> transform the field correctly. Set on every
instance so cylinders compose via <code class="docutils literal notranslate"><span class="pre">|</span></code> / <code class="docutils literal notranslate"><span class="pre">&</span></code> / <code class="docutils literal notranslate"><span class="pre">-</span></code> and stay
usable without the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra (only <a class="reference internal" href="#microgen.shape.Cylinder.generate_cad" title="microgen.shape.Cylinder.generate_cad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_cad()</span></code></a> requires
CAD).</p>
<div class="jupyter_cell docutils container">
<div class="cell_output docutils container">
<img alt="_images/microgen.shape_3_0.png" src="_images/microgen.shape_3_0.png" />
</div>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Cylinder.generate_cad">
<span class="sig-name descname"><span class="pre">generate_cad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">CadShape</span></span></span><a class="headerlink" href="#microgen.shape.Cylinder.generate_cad" title="Link to this definition"></a></dt>
<dd><p>Generate a cylinder CAD shape (OCCT). Requires the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Cylinder.generate_surface_mesh">
<span class="sig-name descname"><span class="pre">generate_surface_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.PolyData</span></span></span><a class="headerlink" href="#microgen.shape.Cylinder.generate_surface_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate a cylinder VTK shape using the given parameters.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.CylindricalTpms">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">CylindricalTpms</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">radius</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">surface_function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">OffsetGrading</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Field</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phase_shift</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0.0,</span> <span class="pre">0.0,</span> <span class="pre">0.0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repeat_cell</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">center</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orientation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.CylindricalTpms" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.tpms.Tpms" title="microgen.shape.tpms.Tpms"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tpms</span></code></a></p>
<p>Class used to generate cylindrical TPMS geometries (sheet or skeletals parts).</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.Ellipsoid">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">Ellipsoid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">radii</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(1,</span> <span class="pre">0.5,</span> <span class="pre">0.25)</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.Ellipsoid" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a></p>
<p>Class to generate an ellipsoid.</p>
<p>The implicit field is the canonical ellipsoid scalar
<code class="docutils literal notranslate"><span class="pre">sqrt((x/rx)^2</span> <span class="pre">+</span> <span class="pre">(y/ry)^2</span> <span class="pre">+</span> <span class="pre">(z/rz)^2)</span> <span class="pre">-</span> <span class="pre">1</span></code> (approximate SDF with
the correct zero-level set), evaluated in the local frame so
<code class="docutils literal notranslate"><span class="pre">center</span></code> and <code class="docutils literal notranslate"><span class="pre">orientation</span></code> transform the field correctly. Set
on every instance so ellipsoids compose via <code class="docutils literal notranslate"><span class="pre">|</span></code> / <code class="docutils literal notranslate"><span class="pre">&</span></code> / <code class="docutils literal notranslate"><span class="pre">-</span></code>
and stay usable without the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra (only <a class="reference internal" href="#microgen.shape.Ellipsoid.generate_cad" title="microgen.shape.Ellipsoid.generate_cad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_cad()</span></code></a>
requires CAD).</p>
<div class="jupyter_cell docutils container">
<div class="cell_output docutils container">
<img alt="_images/microgen.shape_4_0.png" src="_images/microgen.shape_4_0.png" />
</div>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Ellipsoid.generate_cad">
<span class="sig-name descname"><span class="pre">generate_cad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">CadShape</span></span></span><a class="headerlink" href="#microgen.shape.Ellipsoid.generate_cad" title="Link to this definition"></a></dt>
<dd><p>Generate an ellipsoid CAD shape (OCCT). Requires the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Ellipsoid.generate_surface_mesh">
<span class="sig-name descname"><span class="pre">generate_surface_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.PolyData</span></span></span><a class="headerlink" href="#microgen.shape.Ellipsoid.generate_surface_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate an ellipsoid VTK polydta using the given parameters.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.ExtrudedPolygon">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">ExtrudedPolygon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">list_corners</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.ExtrudedPolygon" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a></p>
<p>ExtrudedPolygon.</p>
<p>Class to generate an extruded polygon with a given list of points and a thickness</p>
<div class="jupyter_cell docutils container">
<div class="cell_output docutils container">
<img alt="_images/microgen.shape_5_0.png" src="_images/microgen.shape_5_0.png" />
</div>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.ExtrudedPolygon.generate_cad">
<span class="sig-name descname"><span class="pre">generate_cad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">CadShape</span></span></span><a class="headerlink" href="#microgen.shape.ExtrudedPolygon.generate_cad" title="Link to this definition"></a></dt>
<dd><p>Generate an extruded polygon CAD shape (OCCT).</p>
<p>Requires the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.ExtrudedPolygon.generate_surface_mesh">
<span class="sig-name descname"><span class="pre">generate_surface_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.PolyData</span></span></span><a class="headerlink" href="#microgen.shape.ExtrudedPolygon.generate_surface_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate an extruded polygon VTK shape using the given parameters.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.GradedInfill">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">GradedInfill</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PolyData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">surface_function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset_skin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.6</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset_core</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">smoothness</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repeat_cell</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">int8</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phase_shift</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0.0,</span> <span class="pre">0.0,</span> <span class="pre">0.0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">20</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.GradedInfill" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.tpms.Infill" title="microgen.shape.tpms.Infill"><code class="xref py py-class docutils literal notranslate"><span class="pre">Infill</span></code></a></p>
<p>Cartesian TPMS infill with offset graded by distance to the envelope.</p>
<p>Same as <a class="reference internal" href="#microgen.shape.Infill" title="microgen.shape.Infill"><code class="xref py py-class docutils literal notranslate"><span class="pre">Infill</span></code></a> (TPMS in the world cartesian frame, clipped by
the input object), except the <em>thickness</em> of the TPMS sheet varies with
the signed distance to the envelope.</p>
<p>Default behaviour models a <strong>graded shell</strong>: dense material concentrated
at the skin (<code class="docutils literal notranslate"><span class="pre">offset_skin</span> <span class="pre">=</span> <span class="pre">0.6</span></code>, “density 1”), hollowing out toward
the core (<code class="docutils literal notranslate"><span class="pre">offset_core</span> <span class="pre">=</span> <span class="pre">0.0</span></code>, “density 0”). Reverse the parameters
for a dense-core / porous-skin scaffold.</p>
<p>The cell pattern is still cartesian (axes-aligned gyroid) — <em>only</em> the
sheet thickness varies in space — so the pattern tiles cleanly even on
bunny-style envelopes with high-curvature features.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.Infill">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">Infill</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PolyData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">surface_function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">OffsetGrading</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cell_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repeat_cell</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">int8</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">phase_shift</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0.0,</span> <span class="pre">0.0,</span> <span class="pre">0.0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">density</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.Infill" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.tpms.Tpms" title="microgen.shape.tpms.Tpms"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tpms</span></code></a></p>
<p>Generate a TPMS infill inside a given object.</p>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Infill.lower_skeletal">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">lower_skeletal</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">PolyData</span></span><a class="headerlink" href="#microgen.shape.Infill.lower_skeletal" title="Link to this definition"></a></dt>
<dd><p>Lower-skeletal part as a PolyData mesh.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Infill.sheet">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">sheet</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">PolyData</span></span><a class="headerlink" href="#microgen.shape.Infill.sheet" title="Link to this definition"></a></dt>
<dd><p>Sheet part as a PolyData mesh (uses <code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_surface_mesh()</span></code>).</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Infill.upper_skeletal">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">upper_skeletal</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">PolyData</span></span><a class="headerlink" href="#microgen.shape.Infill.upper_skeletal" title="Link to this definition"></a></dt>
<dd><p>Upper-skeletal part as a PolyData mesh.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.NormedDistance">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">NormedDistance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PolyData</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">furthest_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary_weight</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.NormedDistance" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">OffsetGrading</span></code></p>
<p>Compute the offset based on the implicit distance to an object.</p>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.NormedDistance.compute_offset">
<span class="sig-name descname"><span class="pre">compute_offset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">grid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pv.UnstructuredGrid</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">pv.StructuredGrid</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">npt.NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">np.float64</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#microgen.shape.NormedDistance.compute_offset" title="Link to this definition"></a></dt>
<dd><p>Compute the offset of the grid.</p>
<p>This method should compute the offset on each point of the grid and return it as a 1D array.
The <cite>lower_surface</cite> and <cite>upper_surface</cite> fields of the grid will then be updated using this computed offset.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>grid</strong> (<em>pv.UnstructuredGrid</em><em> | </em><em>pv.StructuredGrid</em>) – The grid to compute the offset on.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The offset of the grid as a 1D array that matches the number of points in the grid.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>npt.NDArray[np.float64]</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.Polyhedron">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">Polyhedron</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dic</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Vertex</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Face</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.Polyhedron" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a></p>
<p>Class to generate a Polyhedron with a given set of faces and vertices.</p>
<p>The implicit field is the half-space intersection SDF for a <strong>convex</strong>
polyhedron: <code class="docutils literal notranslate"><span class="pre">f(p)</span> <span class="pre">=</span> <span class="pre">max_k</span> <span class="pre">(n_k</span> <span class="pre">·</span> <span class="pre">(p</span> <span class="pre">-</span> <span class="pre">c_k))</span></code>, where <code class="docutils literal notranslate"><span class="pre">n_k</span></code> is the
outward unit normal of face <code class="docutils literal notranslate"><span class="pre">k</span></code> and <code class="docutils literal notranslate"><span class="pre">c_k</span></code> its centroid. Points
inside all half-spaces satisfy <code class="docutils literal notranslate"><span class="pre">f(p)</span> <span class="pre"><</span> <span class="pre">0</span></code>. Voronoi cells produced
by Neper are convex by construction, which is the primary use case.</p>
<p>For non-convex polyhedra the implicit field is meaningless; use
<a class="reference internal" href="#microgen.shape.Polyhedron.generate_cad" title="microgen.shape.Polyhedron.generate_cad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_cad()</span></code></a> / <a class="reference internal" href="#microgen.shape.Polyhedron.generate_surface_mesh" title="microgen.shape.Polyhedron.generate_surface_mesh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_surface_mesh()</span></code></a> instead (those
work from the explicit face list).</p>
<div class="jupyter_cell docutils container">
<div class="cell_output docutils container">
<img alt="_images/microgen.shape_6_0.png" src="_images/microgen.shape_6_0.png" />
</div>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Polyhedron.generate_cad">
<span class="sig-name descname"><span class="pre">generate_cad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">CadShape</span></span></span><a class="headerlink" href="#microgen.shape.Polyhedron.generate_cad" title="Link to this definition"></a></dt>
<dd><p>Generate a polyhedron CAD shape (OCCT). Requires the <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> extra.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Polyhedron.generate_surface_mesh">
<span class="sig-name descname"><span class="pre">generate_surface_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.PolyData</span></span></span><a class="headerlink" href="#microgen.shape.Polyhedron.generate_surface_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate a polyhedron VTK shape using the given parameters.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="microgen.shape.Shape">
<span class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></span><span class="sig-prename descclassname"><span class="pre">microgen.shape.</span></span><span class="sig-name descname"><span class="pre">Shape</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">center</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orientation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Vector3DType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Rotation</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Field</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BoundsType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">period</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PeriodType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#microgen.shape.Shape" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Unified shape with optional implicit (F-rep) and CAD representations.</p>
<p>Every shape has a <code class="docutils literal notranslate"><span class="pre">center</span></code> and <code class="docutils literal notranslate"><span class="pre">orientation</span></code>. It may also carry an
implicit scalar field (<code class="docutils literal notranslate"><span class="pre">_func</span></code>) where <code class="docutils literal notranslate"><span class="pre">f(x,</span> <span class="pre">y,</span> <span class="pre">z)</span> <span class="pre"><</span> <span class="pre">0</span></code> means <em>inside</em>.
When the implicit field is present, the default <a class="reference internal" href="#microgen.shape.Shape.generate_surface_mesh" title="microgen.shape.Shape.generate_surface_mesh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_surface_mesh()</span></code></a> and
<a class="reference internal" href="#microgen.shape.Shape.generate_cad" title="microgen.shape.Shape.generate_cad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_cad()</span></code></a> produce geometry via marching cubes. Subclasses
(e.g. <code class="docutils literal notranslate"><span class="pre">Sphere</span></code>, <code class="docutils literal notranslate"><span class="pre">Tpms</span></code>) override these methods with their own
implementations.</p>
<p>Boolean operators (<code class="docutils literal notranslate"><span class="pre">|</span></code>, <code class="docutils literal notranslate"><span class="pre">&</span></code>, <code class="docutils literal notranslate"><span class="pre">-</span></code>, <code class="docutils literal notranslate"><span class="pre">~</span></code>) and smooth boolean
methods operate on the implicit field and return a new <a class="reference internal" href="#microgen.shape.Shape" title="microgen.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>center</strong> – center of the shape</p></li>
<li><p><strong>orientation</strong> – orientation of the shape</p></li>
<li><p><strong>func</strong> – implicit scalar field <code class="docutils literal notranslate"><span class="pre">(x,</span> <span class="pre">y,</span> <span class="pre">z)</span> <span class="pre">-></span> <span class="pre">array</span></code>, or <code class="docutils literal notranslate"><span class="pre">None</span></code></p></li>
<li><p><strong>bounds</strong> – <code class="docutils literal notranslate"><span class="pre">(xmin,</span> <span class="pre">xmax,</span> <span class="pre">ymin,</span> <span class="pre">ymax,</span> <span class="pre">zmin,</span> <span class="pre">zmax)</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p></li>
<li><p><strong>period</strong> – <code class="docutils literal notranslate"><span class="pre">(Lx,</span> <span class="pre">Ly,</span> <span class="pre">Lz)</span></code> if the field is intrinsically periodic
(<code class="docutils literal notranslate"><span class="pre">func(p</span> <span class="pre">+</span> <span class="pre">L)</span> <span class="pre">==</span> <span class="pre">func(p)</span></code> along each axis), or <code class="docutils literal notranslate"><span class="pre">None</span></code>.
Set by <code class="docutils literal notranslate"><span class="pre">Tpms</span></code> and <code class="docutils literal notranslate"><span class="pre">Spinodoid</span></code> from <code class="docutils literal notranslate"><span class="pre">cell_size</span> <span class="pre">*</span> <span class="pre">repeat_cell</span></code>.</p></li>
</ul>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Shape.bounds">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">bounds</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#microgen.shape.Shape.bounds" title="Link to this definition"></a></dt>
<dd><p>The bounding box <code class="docutils literal notranslate"><span class="pre">(xmin,</span> <span class="pre">xmax,</span> <span class="pre">ymin,</span> <span class="pre">ymax,</span> <span class="pre">zmin,</span> <span class="pre">zmax)</span></code>, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Shape.center">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">center</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Vector3DType</span></span><a class="headerlink" href="#microgen.shape.Shape.center" title="Link to this definition"></a></dt>
<dd><p>Geometric center (set at construction, immutable).</p>
<p>Subclasses with a native renderer (<code class="docutils literal notranslate"><span class="pre">Sphere</span></code>, <code class="docutils literal notranslate"><span class="pre">Tpms</span></code>, …) read
this in their <code class="docutils literal notranslate"><span class="pre">generate_*</span></code> overrides. For an implicit-only
<a class="reference internal" href="#microgen.shape.Shape" title="microgen.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a> (built via <a class="reference internal" href="#microgen.shape.implicit_ops.from_field" title="microgen.shape.implicit_ops.from_field"><code class="xref py py-func docutils literal notranslate"><span class="pre">microgen.shape.implicit_ops.from_field()</span></code></a>
or by a boolean composition), use <a class="reference internal" href="#microgen.shape.Shape.translate" title="microgen.shape.Shape.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a> to shift the
field — assigning to <code class="docutils literal notranslate"><span class="pre">.center</span></code> after construction has no effect
on a bare <code class="docutils literal notranslate"><span class="pre">Shape</span></code>, so the attribute is read-only at the base.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.evaluate">
<span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#microgen.shape.Shape.evaluate" title="Link to this definition"></a></dt>
<dd><p>Evaluate the implicit scalar field at the given coordinates.</p>
<p>Coordinates are in the <strong>field’s local frame</strong> — <code class="docutils literal notranslate"><span class="pre">center</span></code> and
<code class="docutils literal notranslate"><span class="pre">orientation</span></code> are NOT applied here (they only affect mesh output
in <a class="reference internal" href="#microgen.shape.Shape.generate_surface_mesh" title="microgen.shape.Shape.generate_surface_mesh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_surface_mesh()</span></code></a>). Use <a class="reference internal" href="#microgen.shape.Shape.translate" title="microgen.shape.Shape.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a> / <a class="reference internal" href="#microgen.shape.Shape.rotate" title="microgen.shape.Shape.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>
to bake transforms into the field itself.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> – x coordinates</p></li>
<li><p><strong>y</strong> – y coordinates</p></li>
<li><p><strong>z</strong> – z coordinates</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>scalar field values (negative = inside)</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Shape.func">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">func</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#microgen.shape.Shape.func" title="Link to this definition"></a></dt>
<dd><p>The implicit scalar field, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.generate_cad">
<span class="sig-name descname"><span class="pre">generate_cad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BoundsType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">CadShape</span></span></span><a class="headerlink" href="#microgen.shape.Shape.generate_cad" title="Link to this definition"></a></dt>
<dd><p>Generate a CAD shape.</p>
<p>The default implementation delegates to
<code class="xref py py-func docutils literal notranslate"><span class="pre">microgen.cad.shape_to_cad()</span></code>, which builds a tessellated OCCT BREP
from the implicit-field marching-cubes mesh. Concrete subclasses
with native primitive paths (<code class="docutils literal notranslate"><span class="pre">Box</span></code>, <code class="docutils literal notranslate"><span class="pre">Sphere</span></code>, <code class="docutils literal notranslate"><span class="pre">Cylinder</span></code>,
<code class="docutils literal notranslate"><span class="pre">Capsule</span></code>, <code class="docutils literal notranslate"><span class="pre">Ellipsoid</span></code>, <code class="docutils literal notranslate"><span class="pre">Tpms</span></code>, <code class="docutils literal notranslate"><span class="pre">Spinodoid</span></code> …) override
this method with native OCCT construction.</p>
<p>Requires the optional <code class="docutils literal notranslate"><span class="pre">[cad]</span></code> install extra (<code class="docutils literal notranslate"><span class="pre">cadquery-ocp-novtk</span></code>).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bounds</strong> – <code class="docutils literal notranslate"><span class="pre">(xmin,</span> <span class="pre">xmax,</span> <span class="pre">ymin,</span> <span class="pre">ymax,</span> <span class="pre">zmin,</span> <span class="pre">zmax)</span></code></p></li>
<li><p><strong>resolution</strong> – number of grid points per axis</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">microgen.cad.CadShape</span></code> wrapping an OCCT <code class="docutils literal notranslate"><span class="pre">TopoDS_Shell</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.generate_surface_mesh">
<span class="sig-name descname"><span class="pre">generate_surface_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BoundsType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.PolyData</span></span></span><a class="headerlink" href="#microgen.shape.Shape.generate_surface_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate a surface VTK mesh of the shape.</p>
<p>The default implementation runs marching cubes (<code class="docutils literal notranslate"><span class="pre">f</span> <span class="pre"><</span> <span class="pre">0</span></code>) on the
cached implicit grid wrapped in a single-cell halo of “outside”
values, so the iso-surface naturally closes at the bbox: where the
volume reaches the bounds, cap faces are produced AT the bbox.
Subclasses with a native renderer (<code class="docutils literal notranslate"><span class="pre">Sphere</span></code>, <code class="docutils literal notranslate"><span class="pre">Box</span></code>, <code class="docutils literal notranslate"><span class="pre">Tpms</span></code>, …)
override this.</p>
<p>The implicit field is expected to be in world coordinates (subclasses
with non-zero <code class="docutils literal notranslate"><span class="pre">center</span></code> / <code class="docutils literal notranslate"><span class="pre">orientation</span></code> should bake those into
<code class="docutils literal notranslate"><span class="pre">_func</span></code> during construction).</p>
<p>The sampled structured grid is cached per <code class="docutils literal notranslate"><span class="pre">(bounds,</span> <span class="pre">resolution)</span></code>
on the instance, shared with <a class="reference internal" href="#microgen.shape.Shape.generate_volume_mesh" title="microgen.shape.Shape.generate_volume_mesh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_volume_mesh()</span></code></a>. The cache
is unbounded — calling this method with many distinct <code class="docutils literal notranslate"><span class="pre">resolution</span></code>
values on the same instance retains every sampled grid until the
instance is GC’d.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bounds</strong> – <code class="docutils literal notranslate"><span class="pre">(xmin,</span> <span class="pre">xmax,</span> <span class="pre">ymin,</span> <span class="pre">ymax,</span> <span class="pre">zmin,</span> <span class="pre">zmax)</span></code></p></li>
<li><p><strong>resolution</strong> – number of grid points per axis</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>triangulated surface mesh</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.generate_volume_mesh">
<span class="sig-name descname"><span class="pre">generate_volume_mesh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bounds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BoundsType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">50</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KwargsGenerateType</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pv.UnstructuredGrid</span></span></span><a class="headerlink" href="#microgen.shape.Shape.generate_volume_mesh" title="Link to this definition"></a></dt>
<dd><p>Generate a volumetric VTK mesh of the shape’s interior.</p>
<p>Default implementation samples the implicit field on a structured
grid over <code class="docutils literal notranslate"><span class="pre">bounds</span></code> and keeps cells where <code class="docutils literal notranslate"><span class="pre">f</span> <span class="pre"><</span> <span class="pre">0</span></code>. Subclasses
with a native volumetric representation (<code class="docutils literal notranslate"><span class="pre">Tpms</span></code>, <code class="docutils literal notranslate"><span class="pre">Spinodoid</span></code>)
override this with their cached-grid path.</p>
<p>The implicit field is expected to be in world coordinates (same
contract as <a class="reference internal" href="#microgen.shape.Shape.generate_surface_mesh" title="microgen.shape.Shape.generate_surface_mesh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_surface_mesh()</span></code></a>).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bounds</strong> – <code class="docutils literal notranslate"><span class="pre">(xmin,</span> <span class="pre">xmax,</span> <span class="pre">ymin,</span> <span class="pre">ymax,</span> <span class="pre">zmin,</span> <span class="pre">zmax)</span></code></p></li>
<li><p><strong>resolution</strong> – number of grid points per axis</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>clipped <code class="docutils literal notranslate"><span class="pre">pv.UnstructuredGrid</span></code> covering the shape’s interior</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Shape.orientation">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">orientation</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Rotation</span></span><a class="headerlink" href="#microgen.shape.Shape.orientation" title="Link to this definition"></a></dt>
<dd><p>Rotation applied by subclasses’ renderers (set at construction, immutable).</p>
<p>Implicit-only shapes should compose with <a class="reference internal" href="#microgen.shape.Shape.rotate" title="microgen.shape.Shape.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a> instead
of mutating this attribute.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="microgen.shape.Shape.period">
<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">period</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><a class="headerlink" href="#microgen.shape.Shape.period" title="Link to this definition"></a></dt>
<dd><p>The intrinsic period <code class="docutils literal notranslate"><span class="pre">(Lx,</span> <span class="pre">Ly,</span> <span class="pre">Lz)</span></code> if the field is periodic, else <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
<p>When non-<code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">self.evaluate(x</span> <span class="pre">+</span> <span class="pre">Lx,</span> <span class="pre">y,</span> <span class="pre">z)</span> <span class="pre">==</span> <span class="pre">self.evaluate(x,</span> <span class="pre">y,</span> <span class="pre">z)</span></code>
(and analogously for y, z) — i.e. periodicity is a data-structure
invariant of the field, not a runtime flag. <code class="docutils literal notranslate"><span class="pre">Tpms</span></code> and
<code class="docutils literal notranslate"><span class="pre">Spinodoid</span></code> set this from <code class="docutils literal notranslate"><span class="pre">cell_size</span> <span class="pre">*</span> <span class="pre">repeat_cell</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.require_func">
<span class="sig-name descname"><span class="pre">require_func</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">[</span></span><span class="pre">float64</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#microgen.shape.Shape.require_func" title="Link to this definition"></a></dt>
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">_func</span></code> or raise if not set.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.rotate">
<span class="sig-name descname"><span class="pre">rotate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">angles</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">convention</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'ZXZ'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></span><a class="headerlink" href="#microgen.shape.Shape.rotate" title="Link to this definition"></a></dt>
<dd><p>Return a new shape rotated by Euler <em>angles</em> (degrees).</p>
<p>The rotation is applied <strong>about the world origin</strong>. The returned
shape’s <code class="docutils literal notranslate"><span class="pre">center</span></code> is the rotated original center, <code class="docutils literal notranslate"><span class="pre">orientation</span></code>
composes left with the rotation, and <code class="docutils literal notranslate"><span class="pre">bounds</span></code> is the AABB of
the rotated original AABB.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.scale">
<span class="sig-name descname"><span class="pre">scale</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">factor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></span><a class="headerlink" href="#microgen.shape.Shape.scale" title="Link to this definition"></a></dt>
<dd><p>Return a new shape uniformly scaled by <em>factor</em> about the world origin.</p>
<p><code class="docutils literal notranslate"><span class="pre">center</span></code> is scaled by the same factor; <code class="docutils literal notranslate"><span class="pre">orientation</span></code> is
preserved; <code class="docutils literal notranslate"><span class="pre">bounds</span></code> is scaled (with axis-pair swap for
negative factors).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.smooth_difference">
<span class="sig-name descname"><span class="pre">smooth_difference</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></span><a class="headerlink" href="#microgen.shape.Shape.smooth_difference" title="Link to this definition"></a></dt>
<dd><p>Smooth difference with blending radius <em>k</em>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.smooth_intersection">
<span class="sig-name descname"><span class="pre">smooth_intersection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></span><a class="headerlink" href="#microgen.shape.Shape.smooth_intersection" title="Link to this definition"></a></dt>
<dd><p>Smooth intersection with blending radius <em>k</em>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.smooth_union">
<span class="sig-name descname"><span class="pre">smooth_union</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></span><a class="headerlink" href="#microgen.shape.Shape.smooth_union" title="Link to this definition"></a></dt>
<dd><p>Smooth union with blending radius <em>k</em>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="microgen.shape.Shape.translate">
<span class="sig-name descname"><span class="pre">translate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#microgen.shape.shape.Shape" title="microgen.shape.shape.Shape"><span class="pre">Shape</span></a></span></span><a class="headerlink" href="#microgen.shape.Shape.translate" title="Link to this definition"></a></dt>
<dd><p>Return a new shape translated by <em>offset</em>.</p>
<p>The returned <a class="reference internal" href="#microgen.shape.Shape" title="microgen.shape.Shape"><code class="xref py py-class docutils literal notranslate"><span class="pre">Shape</span></code></a> has its <code class="docutils literal notranslate"><span class="pre">center</span></code> shifted by <em>offset</em>
and its <code class="docutils literal notranslate"><span class="pre">bounds</span></code> updated; <code class="docutils literal notranslate"><span class="pre">orientation</span></code> is preserved. The
implicit field is composed so <code class="docutils literal notranslate"><span class="pre">evaluate(p)</span> <span class="pre">==</span> <span class="pre">old.evaluate(p</span> <span class="pre">-</span> <span class="pre">offset)</span></code>.</p>