ocp-viewer-smlibpy 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ocp_viewer_smlibpy-0.1.0/LICENSE +201 -0
- ocp_viewer_smlibpy-0.1.0/PKG-INFO +91 -0
- ocp_viewer_smlibpy-0.1.0/README.md +64 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/__init__.py +37 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/_version.py +35 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/_wire.py +27 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/backend.py +327 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/occt.py +148 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/show.py +94 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/tessellation.py +352 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy/types.py +38 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy.egg-info/PKG-INFO +91 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy.egg-info/SOURCES.txt +21 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy.egg-info/dependency_links.txt +1 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy.egg-info/entry_points.txt +5 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy.egg-info/requires.txt +12 -0
- ocp_viewer_smlibpy-0.1.0/ocp_viewer_smlibpy.egg-info/top_level.txt +1 -0
- ocp_viewer_smlibpy-0.1.0/pyproject.toml +89 -0
- ocp_viewer_smlibpy-0.1.0/setup.cfg +4 -0
- ocp_viewer_smlibpy-0.1.0/tests/test_backend.py +691 -0
- ocp_viewer_smlibpy-0.1.0/tests/test_show.py +281 -0
- ocp_viewer_smlibpy-0.1.0/tests/test_tessellation.py +247 -0
- ocp_viewer_smlibpy-0.1.0/tests/test_to_occt.py +36 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2024] Bernhard Walter
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ocp-viewer-smlibpy
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Show smlibpy (SMLib) objects in the OCP CAD Viewer: the smlib kernel plugin for ocp-tessellate
|
|
5
|
+
Author-email: Bernhard Walter <b_walter@arcor.de>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/bernhard-42/ocp-viewer-smlibpy
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/bernhard-42/ocp-viewer-smlibpy/issues
|
|
9
|
+
Keywords: 3d,cad,smlib,smlibpy,viewer,tessellation,ocp,nanocct
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Requires-Python: >=3.10
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
License-File: LICENSE
|
|
15
|
+
Requires-Dist: ocp-tessellate<3.8.0,>=3.7.0
|
|
16
|
+
Requires-Dist: ocp-viewer-core<1.3.0,>=1.2.0
|
|
17
|
+
Requires-Dist: smlibpy>=0.6.2
|
|
18
|
+
Requires-Dist: numpy>=2.0
|
|
19
|
+
Provides-Extra: dev
|
|
20
|
+
Requires-Dist: bump-my-version; extra == "dev"
|
|
21
|
+
Requires-Dist: build; extra == "dev"
|
|
22
|
+
Requires-Dist: twine; extra == "dev"
|
|
23
|
+
Requires-Dist: pytest; extra == "dev"
|
|
24
|
+
Requires-Dist: ruff; extra == "dev"
|
|
25
|
+
Requires-Dist: ty; extra == "dev"
|
|
26
|
+
Dynamic: license-file
|
|
27
|
+
|
|
28
|
+
# ocp-viewer-smlibpy
|
|
29
|
+
|
|
30
|
+
Show [smlibpy](https://pypi.org/project/smlibpy/) objects (the SMLib kernel) in the OCP CAD Viewer family: [ocp_vscode](https://github.com/bernhard-42/vscode-ocp-cad-viewer), jupyter_cadquery, build123d_studio and ocp_viewer. The objects are tessellated by smlib's own kernel and go through [ocp-tessellate](https://github.com/bernhard-42/ocp-tessellate)'s plugin interface, so names, colors, the viewer's settings and `set_defaults` work as for build123d or CadQuery objects.
|
|
31
|
+
|
|
32
|
+
This package is the reference implementation of a kernel plugin for ocp-tessellate: one class per protocol of [CAD kernel plugins](https://bernhard-42.github.io/ocp_viewer_docs/plugins/overview/), `SmlibTessellation` in `tessellation.py`, `SmlibShow` in `show.py` and `SmlibBackend` in `backend.py`.
|
|
33
|
+
|
|
34
|
+
## Installation
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pip install ocp-viewer-smlibpy
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Requires Python 3.10+, smlibpy 0.6.2+, ocp-tessellate with the plugin interface (`ocp_tessellate.plugin`), ocp-viewer-core, and one OCCT binding (OCP or nanocct), which ocp-tessellate needs.
|
|
41
|
+
|
|
42
|
+
## Usage
|
|
43
|
+
|
|
44
|
+
```python
|
|
45
|
+
from smlibpy import *
|
|
46
|
+
from ocp_vscode import show, show_all, Camera
|
|
47
|
+
|
|
48
|
+
plate = Box(80, 60, 10)
|
|
49
|
+
plate = plate.fillet(plate.edges().parallel_to(Z), 8)
|
|
50
|
+
plate -= GridLocations(25, 16, 2, 3) * Cylinder(4, 10)
|
|
51
|
+
|
|
52
|
+
show(plate, plate.edges(), Pos(0, 0, 20), names=["plate", "edges", "loc"], reset_camera=Camera.RESET)
|
|
53
|
+
show_all() # every smlibpy object in the current scope, under its variable name
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The script imports only smlibpy and the viewer package: ocp_tessellate imports the plugin's drawing half, `ocp_viewer_smlibpy.show`, through the entry point `smlib` of the group `ocp_viewer.kernels.show` at the first show. The viewer's `show` and `show_all` take parts, sheets, sketches, faces, edges, wires, vertices, vectors, locations, planes and axes, and lists or dicts of them, also at a debug stop (visual debugging), with the `names`, `colors` and `alphas` lists and every keyword of `show` (`reset_camera`, `collapse`, `helper_scale`, `transparent`, ...). Bodies are cached in ocp-tessellate's tessellation cache by their geometry.
|
|
57
|
+
|
|
58
|
+
### Measuring
|
|
59
|
+
|
|
60
|
+
The viewer's distance and properties tools ask a measurement backend (`ocp_viewer_core.backend.ViewerBackend`) that holds the geometry behind the mesh. `SmlibBackend` in `ocp_viewer_smlibpy/backend.py` is the smlib half of that, its implementation of `BackendProtocol`: `deserialize(data)` (the bytes of `SmlibShow.serialize`: bodies and curves as binary `.smp`, vertices as their coordinates, what they travel as, since every viewer runs the backend in another process than the user's), `moved(shape, placement)`, `parts(shape)` (its faces, edges and vertices in the order the viewer numbers them), `kind(shape)`, `center(shape)`, `properties(shape)` (what smlib knows about it, as plain numbers), `closest_points(shape1, shape2)` and `closest_directions(shape1, shape2)`. ocp_viewer_core runs that sequence and makes the panel's rows, as it does for OCCT. Importing `ocp_viewer_smlibpy.backend` registers it under the kernel tag `smlib`, through `ocp_viewer_core.backend.register_plugin`, and the entry point `smlib` of the group `ocp_viewer.kernels.backend` imports that module in the backend's process, in every viewer. The plugin must be installed where the backend runs: for VS Code in the interpreter the extension starts the backend with, for Jupyter CadQuery in the Jupyter server's environment. [The backend protocol](https://bernhard-42.github.io/ocp_viewer_docs/plugins/backend/) describes it. Every leaf of a shown smlibpy object has an entry in the backend's model, tagged `smlib` by ocp-tessellate.
|
|
61
|
+
|
|
62
|
+
## Mixed scenes
|
|
63
|
+
|
|
64
|
+
`show` and `show_all` take smlibpy objects beside build123d, CadQuery or OCCT objects:
|
|
65
|
+
|
|
66
|
+
```python
|
|
67
|
+
show(plate, build123d_box, names=["plate", "box"])
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Each kernel's shapes are measured against each other, but a distance between an smlib shape and an OCCT shape is not: the kernels have no common geometry to measure on except OCCT itself. To measure across kernels, convert the smlib objects to OCCT shapes with `to_occt` and show them as OCCT objects:
|
|
71
|
+
|
|
72
|
+
```python
|
|
73
|
+
from ocp_viewer_smlibpy import to_occt
|
|
74
|
+
show(build123d_box, to_occt(plate), names=["box", "plate"]) # every distance between the two is measured
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
`to_occt` converts through smlib's `.brep` writer (bodies), its NURBS data (edges, wires) or its coordinates (vertices, locations, planes, axes), into the binding of `ocp_tessellate._kernel.kernel()` or the one named by `binding="OCP"` / `"nanocct"`. The converted object is OCCT's from then on: OCCT tessellates, numbers and measures it. The conversion fails for geometry smlib cannot write as `.brep`, offset surfaces of free-form faces, with a `ValueError` naming the viewer's `show` as the way to at least see the object.
|
|
78
|
+
|
|
79
|
+
## Development
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
make lint # ruff
|
|
83
|
+
make typecheck # ty
|
|
84
|
+
make tests # pytest
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
The tests need smlibpy and an OCCT binding installed; the comparison tests against the OCCT path build the same boxes with the binding.
|
|
88
|
+
|
|
89
|
+
## License
|
|
90
|
+
|
|
91
|
+
Apache 2.0
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# ocp-viewer-smlibpy
|
|
2
|
+
|
|
3
|
+
Show [smlibpy](https://pypi.org/project/smlibpy/) objects (the SMLib kernel) in the OCP CAD Viewer family: [ocp_vscode](https://github.com/bernhard-42/vscode-ocp-cad-viewer), jupyter_cadquery, build123d_studio and ocp_viewer. The objects are tessellated by smlib's own kernel and go through [ocp-tessellate](https://github.com/bernhard-42/ocp-tessellate)'s plugin interface, so names, colors, the viewer's settings and `set_defaults` work as for build123d or CadQuery objects.
|
|
4
|
+
|
|
5
|
+
This package is the reference implementation of a kernel plugin for ocp-tessellate: one class per protocol of [CAD kernel plugins](https://bernhard-42.github.io/ocp_viewer_docs/plugins/overview/), `SmlibTessellation` in `tessellation.py`, `SmlibShow` in `show.py` and `SmlibBackend` in `backend.py`.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pip install ocp-viewer-smlibpy
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Requires Python 3.10+, smlibpy 0.6.2+, ocp-tessellate with the plugin interface (`ocp_tessellate.plugin`), ocp-viewer-core, and one OCCT binding (OCP or nanocct), which ocp-tessellate needs.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```python
|
|
18
|
+
from smlibpy import *
|
|
19
|
+
from ocp_vscode import show, show_all, Camera
|
|
20
|
+
|
|
21
|
+
plate = Box(80, 60, 10)
|
|
22
|
+
plate = plate.fillet(plate.edges().parallel_to(Z), 8)
|
|
23
|
+
plate -= GridLocations(25, 16, 2, 3) * Cylinder(4, 10)
|
|
24
|
+
|
|
25
|
+
show(plate, plate.edges(), Pos(0, 0, 20), names=["plate", "edges", "loc"], reset_camera=Camera.RESET)
|
|
26
|
+
show_all() # every smlibpy object in the current scope, under its variable name
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The script imports only smlibpy and the viewer package: ocp_tessellate imports the plugin's drawing half, `ocp_viewer_smlibpy.show`, through the entry point `smlib` of the group `ocp_viewer.kernels.show` at the first show. The viewer's `show` and `show_all` take parts, sheets, sketches, faces, edges, wires, vertices, vectors, locations, planes and axes, and lists or dicts of them, also at a debug stop (visual debugging), with the `names`, `colors` and `alphas` lists and every keyword of `show` (`reset_camera`, `collapse`, `helper_scale`, `transparent`, ...). Bodies are cached in ocp-tessellate's tessellation cache by their geometry.
|
|
30
|
+
|
|
31
|
+
### Measuring
|
|
32
|
+
|
|
33
|
+
The viewer's distance and properties tools ask a measurement backend (`ocp_viewer_core.backend.ViewerBackend`) that holds the geometry behind the mesh. `SmlibBackend` in `ocp_viewer_smlibpy/backend.py` is the smlib half of that, its implementation of `BackendProtocol`: `deserialize(data)` (the bytes of `SmlibShow.serialize`: bodies and curves as binary `.smp`, vertices as their coordinates, what they travel as, since every viewer runs the backend in another process than the user's), `moved(shape, placement)`, `parts(shape)` (its faces, edges and vertices in the order the viewer numbers them), `kind(shape)`, `center(shape)`, `properties(shape)` (what smlib knows about it, as plain numbers), `closest_points(shape1, shape2)` and `closest_directions(shape1, shape2)`. ocp_viewer_core runs that sequence and makes the panel's rows, as it does for OCCT. Importing `ocp_viewer_smlibpy.backend` registers it under the kernel tag `smlib`, through `ocp_viewer_core.backend.register_plugin`, and the entry point `smlib` of the group `ocp_viewer.kernels.backend` imports that module in the backend's process, in every viewer. The plugin must be installed where the backend runs: for VS Code in the interpreter the extension starts the backend with, for Jupyter CadQuery in the Jupyter server's environment. [The backend protocol](https://bernhard-42.github.io/ocp_viewer_docs/plugins/backend/) describes it. Every leaf of a shown smlibpy object has an entry in the backend's model, tagged `smlib` by ocp-tessellate.
|
|
34
|
+
|
|
35
|
+
## Mixed scenes
|
|
36
|
+
|
|
37
|
+
`show` and `show_all` take smlibpy objects beside build123d, CadQuery or OCCT objects:
|
|
38
|
+
|
|
39
|
+
```python
|
|
40
|
+
show(plate, build123d_box, names=["plate", "box"])
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Each kernel's shapes are measured against each other, but a distance between an smlib shape and an OCCT shape is not: the kernels have no common geometry to measure on except OCCT itself. To measure across kernels, convert the smlib objects to OCCT shapes with `to_occt` and show them as OCCT objects:
|
|
44
|
+
|
|
45
|
+
```python
|
|
46
|
+
from ocp_viewer_smlibpy import to_occt
|
|
47
|
+
show(build123d_box, to_occt(plate), names=["box", "plate"]) # every distance between the two is measured
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
`to_occt` converts through smlib's `.brep` writer (bodies), its NURBS data (edges, wires) or its coordinates (vertices, locations, planes, axes), into the binding of `ocp_tessellate._kernel.kernel()` or the one named by `binding="OCP"` / `"nanocct"`. The converted object is OCCT's from then on: OCCT tessellates, numbers and measures it. The conversion fails for geometry smlib cannot write as `.brep`, offset surfaces of free-form faces, with a `ValueError` naming the viewer's `show` as the way to at least see the object.
|
|
51
|
+
|
|
52
|
+
## Development
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
make lint # ruff
|
|
56
|
+
make typecheck # ty
|
|
57
|
+
make tests # pytest
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The tests need smlibpy and an OCCT binding installed; the comparison tests against the OCCT path build the same boxes with the binding.
|
|
61
|
+
|
|
62
|
+
## License
|
|
63
|
+
|
|
64
|
+
Apache 2.0
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
#
|
|
2
|
+
# Copyright 2026 Bernhard Walter
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
# See the License for the specific language governing permissions and
|
|
14
|
+
# limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
|
|
17
|
+
"""smlibpy objects in the OCP CAD Viewer family: the kernel plugin for SMLib.
|
|
18
|
+
|
|
19
|
+
The host's `show` and `show_all` take parts, sheets, sketches, faces, edges, wires,
|
|
20
|
+
vertices, locations, planes and axes of smlibpy, tessellated by smlib's own kernel and
|
|
21
|
+
measured from its own geometry. The plugin is three classes, one per protocol:
|
|
22
|
+
|
|
23
|
+
- `tessellation.SmlibTessellation`: ocp_tessellate's TessellationProtocol
|
|
24
|
+
- `show.SmlibShow`: ocp_tessellate's ShowProtocol
|
|
25
|
+
- `backend.SmlibBackend`: ocp_viewer_core's BackendProtocol
|
|
26
|
+
|
|
27
|
+
Importing `show` registers the first two, importing `backend` the third. The entry points
|
|
28
|
+
`smlib` of the groups `ocp_viewer.kernels.show` and `ocp_viewer.kernels.backend`
|
|
29
|
+
(pyproject.toml) import them, the first in the user's process at the first show, so a script
|
|
30
|
+
needs only `from smlibpy import ...`, the second in the backend's process, which every host
|
|
31
|
+
runs apart from the user's. `to_occt` converts smlibpy objects to OCCT shapes.
|
|
32
|
+
"""
|
|
33
|
+
|
|
34
|
+
from ._version import __version__ as __version__, __version_info__ as __version_info__
|
|
35
|
+
from .occt import to_occt
|
|
36
|
+
|
|
37
|
+
__all__ = ["__version__", "__version_info__", "to_occt"]
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
#
|
|
2
|
+
# Copyright 2026 Bernhard Walter
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
# See the License for the specific language governing permissions and
|
|
14
|
+
# limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
|
|
17
|
+
import re
|
|
18
|
+
from collections import namedtuple
|
|
19
|
+
|
|
20
|
+
VersionInfo = namedtuple("VersionInfo", ["major", "minor", "patch", "release", "build"])
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
def get_version(version):
|
|
24
|
+
r = re.compile(
|
|
25
|
+
r"(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)\-{0,1}(?P<release>\D*)(?P<build>\d*)"
|
|
26
|
+
)
|
|
27
|
+
m = r.match(version)
|
|
28
|
+
if m is None:
|
|
29
|
+
raise ValueError(f"Invalid version: {version}")
|
|
30
|
+
major, minor, patch, release, build = m.groups()
|
|
31
|
+
return VersionInfo(major, minor, patch, release, build)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
__version__ = "0.1.0" # DO NOT EDIT THIS DIRECTLY! It is managed by bumpversion
|
|
35
|
+
__version_info__ = get_version(__version__)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
#
|
|
2
|
+
# Copyright 2026 Bernhard Walter
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
# See the License for the specific language governing permissions and
|
|
14
|
+
# limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
|
|
17
|
+
"""What the two halves of the plugin agree on: `show` writes the bytes of a shape in the user's
|
|
18
|
+
process, `backend` reads them in the backend's, and importing either registers only that half."""
|
|
19
|
+
|
|
20
|
+
# the kernel tag of smlibpy's shapes, in the measurement backend's model and the registries
|
|
21
|
+
KERNEL = "smlib"
|
|
22
|
+
|
|
23
|
+
# the first byte is the format's version: the two processes can have other versions of this
|
|
24
|
+
# plugin. The second says how to read the rest: an .smp file holds bodies and curves, not points
|
|
25
|
+
FORMAT = 1
|
|
26
|
+
HEADER = bytes([FORMAT])
|
|
27
|
+
SMP, POINTS = b"S", b"V"
|