first commit
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
# Python-generated files
|
||||
__pycache__/
|
||||
*.py[oc]
|
||||
build/
|
||||
dist/
|
||||
wheels/
|
||||
*.egg-info
|
||||
|
||||
# Virtual environments
|
||||
.venv
|
||||
|
||||
.env
|
||||
|
||||
output/
|
||||
|
||||
# Sandbox artifacts
|
||||
sandbox/
|
||||
|
||||
# Generated skills archives
|
||||
skills/*.tar.gz
|
||||
|
||||
.DS_Store
|
||||
|
||||
# CAD/export artifacts
|
||||
*.step
|
||||
*.stl
|
||||
examples.py
|
||||
@@ -0,0 +1 @@
|
||||
3.10
|
||||
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
@@ -0,0 +1,30 @@
|
||||
# 包含必要文件
|
||||
include README.md
|
||||
include LICENSE
|
||||
include pyproject.toml
|
||||
|
||||
# 包含文档
|
||||
recursive-include docs *.md
|
||||
|
||||
# 包含源码
|
||||
recursive-include src *.py
|
||||
include src/simplecadapi/py.typed
|
||||
|
||||
recursive-include src/auto_tools *.py
|
||||
|
||||
# 排除不需要的文件
|
||||
exclude .python-version
|
||||
exclude uv.lock
|
||||
exclude scripts/publish.sh
|
||||
|
||||
# 排除测试文件（如果不想包含）
|
||||
# recursive-exclude test *
|
||||
|
||||
# 排除输出文件
|
||||
recursive-exclude output *
|
||||
|
||||
# 排除缓存和临时文件
|
||||
global-exclude __pycache__
|
||||
global-exclude *.py[cod]
|
||||
global-exclude *.so
|
||||
global-exclude .DS_Store
|
||||
@@ -0,0 +1,232 @@
|
||||
<p align="center">
|
||||
<img src="img/repocover.png" alt="SimpleCADAPI repository cover">
|
||||
</p>
|
||||
|
||||
# SimpleCADAPI
|
||||
|
||||
[中文说明](README.zh-CN.md)
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<h2>CADDesigner Research Artifact</h2>
|
||||
<p>This repository is an artifact of</p>
|
||||
<p>
|
||||
<strong><a href="https://562590763.github.io/CADDesigner/">CADDesigner: Conceptual CAD Model Generation with a General-Purpose Agent</a></strong>
|
||||
</p>
|
||||
<p><strong>Accepted by <em>Computer-Aided Design</em>, 2026</strong></p>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
SimpleCADAPI is an OCP-native Python SDK for building CAD models with clear,
|
||||
functional operations and replayable model graphs. It wraps OpenCascade geometry
|
||||
in a compact public API for creating solids, applying features, tagging semantic
|
||||
intent, querying topology, exporting manufacturing files, and translating recorded
|
||||
models into FreeCAD workflows.
|
||||
|
||||
Current beta: `simplecadapi==2.0.1b1`.
|
||||
|
||||
## What It Provides
|
||||
|
||||
- OCP-native shape types: `Vertex`, `Edge`, `Wire`, `Face`, and `Solid`.
|
||||
- Functional modeling operations for primitives, profiles, extrude, revolve,
|
||||
loft, sweep, booleans, transforms, patterns, fillets, chamfers, and shells.
|
||||
- Replayable modeling with `GraphSession`, `export_model_json(...)`,
|
||||
`import_model_json(...)`, and `replay_model_json(...)`.
|
||||
- Expression parameters with `var(...)`, arithmetic expressions, and serialized
|
||||
expression graphs.
|
||||
- QL selectors for geometry grounding, topology queries, and stable feature
|
||||
selections.
|
||||
- Semantic tags through `apply_tag(shape, tag)` and `list_tags(shape)`.
|
||||
- STEP/STL export and FreeCAD translation helpers for script or `.FCStd` output.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pip install simplecadapi
|
||||
```
|
||||
|
||||
With `uv`:
|
||||
|
||||
```bash
|
||||
uv add simplecadapi
|
||||
```
|
||||
|
||||
For local development from this repository:
|
||||
|
||||
```bash
|
||||
uv sync --group dev
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```python
|
||||
from pathlib import Path
|
||||
|
||||
import simplecadapi as scad
|
||||
|
||||
out = Path("out")
|
||||
out.mkdir(exist_ok=True)
|
||||
|
||||
base = scad.make_box_rsolid(60.0, 36.0, 8.0, bottom_face_center=(0.0, 0.0, 0.0))
|
||||
hole = scad.make_cylinder_rsolid(5.0, 14.0, bottom_face_center=(0.0, 0.0, -3.0))
|
||||
slot = scad.make_box_rsolid(18.0, 8.0, 14.0, bottom_face_center=(14.0, 0.0, -3.0))
|
||||
|
||||
part = scad.cut_rsolid(base, hole, slot)
|
||||
boss = scad.make_cylinder_rsolid(8.0, 7.0, bottom_face_center=(-18.0, 0.0, 8.0))
|
||||
part = scad.union_rsolid(part, boss)
|
||||
part = scad.apply_tag(part, "role.demo.bracket")
|
||||
|
||||
print("volume", round(part.get_volume(), 3))
|
||||
print("faces", len(part.get_faces()))
|
||||
print("tags", scad.list_tags(part))
|
||||
|
||||
scad.export_step(part, str(out / "bracket.step"))
|
||||
scad.export_stl(part, str(out / "bracket.stl"))
|
||||
```
|
||||
|
||||
## Replayable Modeling
|
||||
|
||||
Use `GraphSession` when a model should be inspectable, serializable, replayable,
|
||||
or translated into another CAD environment.
|
||||
|
||||
```python
|
||||
import simplecadapi as scad
|
||||
from simplecadapi import ql as Q
|
||||
|
||||
with scad.GraphSession() as session:
|
||||
body = scad.make_box_rsolid(40.0, 24.0, 10.0, bottom_face_center=(0.0, 0.0, 0.0))
|
||||
cutter = scad.make_cylinder_rsolid(4.0, 16.0, bottom_face_center=(0.0, 0.0, -3.0))
|
||||
drilled = scad.cut_rsolid(body, cutter)
|
||||
|
||||
bottom_circle = (
|
||||
Q.edges()
|
||||
.where(Q.curve_type("circle"))
|
||||
.order_by(Q.center_axis("z"))
|
||||
.take(1)
|
||||
.exactly(1)
|
||||
)
|
||||
final = scad.chamfer_rsolid(drilled, bottom_circle, 0.6)
|
||||
|
||||
model_json = scad.export_model_json(session)
|
||||
rebuilt = scad.replay_model_json(model_json)
|
||||
|
||||
print("recorded_nodes", session.graph.node_count)
|
||||
print("replayed_outputs", len(rebuilt))
|
||||
```
|
||||
|
||||
## Modeling Mental Model
|
||||
|
||||
- Start from design intent: reference axes, critical profiles, and the features
|
||||
that produce the final solid.
|
||||
- Build from lower-dimensional geometry to higher-dimensional geometry: profile
|
||||
wires/faces first, then solid features such as extrude, revolve, loft, and
|
||||
sweep.
|
||||
- Keep operations functional. Create new values with public functions such as
|
||||
`make_rectangle_rface(...)`, `extrude_rsolid(...)`, `cut_rsolid(...)`, and
|
||||
`fillet_rsolid(...)`.
|
||||
- Use tags for semantic intent and selection anchors, for example
|
||||
`role.mounting.surface`, `anchor.datum.primary`, or `group.fasteners`.
|
||||
- Store numeric and geometric facts in metadata or graph payloads, not in tags.
|
||||
- Use QL to ground selections by geometry facts rather than relying on topology
|
||||
iteration order.
|
||||
- When an indexed topology pick is intentional, pass the index to the plural
|
||||
child-geometry getter, such as `get_edges(index)`, `get_faces(index)`,
|
||||
`get_wires(index)`, or `get_vertices(index)`, so replayable graph workflows
|
||||
preserve the pick as a geo select node.
|
||||
- Use model JSON as the interchange boundary for replay, tests, and FreeCAD
|
||||
translation.
|
||||
|
||||
## FreeCAD Translation
|
||||
|
||||
Recorded model JSON can be translated into a FreeCAD Python script:
|
||||
|
||||
```python
|
||||
script = scad.translator.freecad_translator.translate_model_json_to_freecad_script(model_json)
|
||||
```
|
||||
|
||||
If FreeCAD or FreeCADCmd is available, the same model JSON can be written as an
|
||||
`.FCStd` file:
|
||||
|
||||
```python
|
||||
scad.translator.freecad_translator.translate_model_json_to_fcstd(model_json, "bracket.FCStd")
|
||||
```
|
||||
|
||||
Part/Assembly models are written as editable FreeCAD assembly structure: parts are
|
||||
`App::Part`, assemblies are `Assembly::AssemblyObject`, and components are links.
|
||||
Explicit compound projections remain available for geometry-only STEP export.
|
||||
|
||||
## Examples
|
||||
|
||||
Run examples from the source checkout:
|
||||
|
||||
```bash
|
||||
uv run python examples/01_basic_modeling.py
|
||||
uv run python examples/02_graph_replay.py
|
||||
uv run python examples/03_expressions.py
|
||||
uv run python examples/05_loft_sweep_revolve.py
|
||||
uv run python examples/06_parametric_gear_model.py
|
||||
uv run python examples/07_serialization_operation_tree.py
|
||||
uv run python examples/08_constrained_sketch.py
|
||||
uv run python examples/09_naca0016_blade_freecad.py
|
||||
uv run python examples/10_part_assembly.py
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- Public API reference: [`docs/api/`](docs/api/)
|
||||
- Core type and modeling notes: [`docs/core/`](docs/core/)
|
||||
- Serialization and replay details:
|
||||
[`docs/core/serialization/README.md`](docs/core/serialization/README.md)
|
||||
- Operation graph JSON spec:
|
||||
[`docs/core/operation_graph_json_spec.md`](docs/core/operation_graph_json_spec.md)
|
||||
|
||||
## Releasing the Agent Skill
|
||||
|
||||
The repository includes a thin Agent Skill under `skills/simplecadapi/`. It
|
||||
contains generated API and modeling references, but does not bundle the SDK
|
||||
source code.
|
||||
|
||||
From a clean checkout, update the project version and documentation, then build
|
||||
and validate the release artifacts:
|
||||
|
||||
```bash
|
||||
uv sync --group dev
|
||||
uv run skill-pack --refresh-docs --archive
|
||||
uv run python -m pytest test/test_skill_pack.py
|
||||
```
|
||||
|
||||
The command refreshes the generated docs, rewrites `skills/simplecadapi/`, and
|
||||
creates `skills/simplecadapi.tar.gz`. Review the generated `SKILL.md` and
|
||||
references before release:
|
||||
|
||||
```bash
|
||||
git diff -- skills/simplecadapi docs
|
||||
tar -tzf skills/simplecadapi.tar.gz
|
||||
```
|
||||
|
||||
Commit the generated `skills/simplecadapi/` directory and refreshed `docs/`
|
||||
with the release. The archive is intentionally ignored by Git; attach
|
||||
`skills/simplecadapi.tar.gz` to the corresponding GitHub release or distribute
|
||||
it through the target Agent Skills registry.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
uv sync --group dev
|
||||
uv run python -m pytest test tests
|
||||
python3 -m compileall src/simplecadapi
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
AGPL-3.0, see [`LICENSE`](LICENSE).
|
||||
|
||||
## Community
|
||||
|
||||
The group chat currently has too many members for direct QR-code joining. Scan the QR code below to add Teacher Du Peng on WeChat, then ask him for an invitation to the CADDesigner technical community:
|
||||
|
||||
<p align="center">
|
||||
<img src="img/dp个人账号.png.jpg" alt="Teacher Du Peng's personal WeChat QR code" width="420">
|
||||
</p>
|
||||
@@ -0,0 +1,158 @@
|
||||
<p align="center">
|
||||
<img src="img/repocover.png" alt="SimpleCADAPI 仓库封面">
|
||||
</p>
|
||||
|
||||
# SimpleCADAPI
|
||||
|
||||
[English](README.md)
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<h2>CADDesigner 论文成果</h2>
|
||||
<p>本仓库是以下论文工作的项目产物：</p>
|
||||
<p>
|
||||
<strong><a href="https://562590763.github.io/CADDesigner/">CADDesigner: Conceptual CAD Model Generation with a General-Purpose Agent</a></strong>
|
||||
</p>
|
||||
<p><strong>Computer-Aided Design 2026 接收</strong></p>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
SimpleCADAPI 是一个基于 OCP 的 Python CAD SDK，提供清晰的函数式建模操作和可重放的模型图。它在 OpenCascade 几何内核之上提供精简的公共 API，可用于创建实体、应用特征、添加语义标签、查询拓扑、导出制造文件，以及将记录的模型转换为 FreeCAD 工作流。
|
||||
|
||||
当前测试版本：`simplecadapi==2.0.1b1`。
|
||||
|
||||
## 核心能力
|
||||
|
||||
- 基于 OCP 的 `Vertex`、`Edge`、`Wire`、`Face` 和 `Solid` 类型。
|
||||
- 支持基本体、轮廓、拉伸、旋转、放样、扫掠、布尔运算、变换、阵列、圆角、倒角和抽壳等函数式建模操作。
|
||||
- 通过 `GraphSession`、`export_model_json(...)`、`import_model_json(...)` 和 `replay_model_json(...)` 记录并重放建模过程。
|
||||
- 通过 `var(...)`、算术表达式和可序列化表达式图定义参数。
|
||||
- 使用 QL 选择器定位几何、查询拓扑并稳定选择特征。
|
||||
- 通过 `apply_tag(shape, tag)` 和 `list_tags(shape)` 管理语义标签。
|
||||
- 支持 STEP/STL 导出，以及 FreeCAD 脚本和 `.FCStd` 转换。
|
||||
|
||||
## 安装
|
||||
|
||||
使用 pip：
|
||||
|
||||
```bash
|
||||
pip install simplecadapi
|
||||
```
|
||||
|
||||
使用 uv：
|
||||
|
||||
```bash
|
||||
uv add simplecadapi
|
||||
```
|
||||
|
||||
从本仓库进行本地开发：
|
||||
|
||||
```bash
|
||||
uv sync --group dev
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
|
||||
```python
|
||||
from pathlib import Path
|
||||
|
||||
import simplecadapi as scad
|
||||
|
||||
out = Path("out")
|
||||
out.mkdir(exist_ok=True)
|
||||
|
||||
base = scad.make_box_rsolid(60.0, 36.0, 8.0, bottom_face_center=(0.0, 0.0, 0.0))
|
||||
hole = scad.make_cylinder_rsolid(5.0, 14.0, bottom_face_center=(0.0, 0.0, -3.0))
|
||||
part = scad.cut_rsolid(base, hole)
|
||||
part = scad.apply_tag(part, "role.demo.bracket")
|
||||
|
||||
print("volume", round(part.get_volume(), 3))
|
||||
print("tags", scad.list_tags(part))
|
||||
|
||||
scad.export_step(part, str(out / "bracket.step"))
|
||||
scad.export_stl(part, str(out / "bracket.stl"))
|
||||
```
|
||||
|
||||
## 可重放建模
|
||||
|
||||
当模型需要检查、序列化、重放或转换到其他 CAD 环境时，请使用 `GraphSession`：
|
||||
|
||||
```python
|
||||
import simplecadapi as scad
|
||||
|
||||
with scad.GraphSession() as session:
|
||||
body = scad.make_box_rsolid(40.0, 24.0, 10.0, bottom_face_center=(0.0, 0.0, 0.0))
|
||||
cutter = scad.make_cylinder_rsolid(4.0, 16.0, bottom_face_center=(0.0, 0.0, -3.0))
|
||||
drilled = scad.cut_rsolid(body, cutter)
|
||||
|
||||
model_json = scad.export_model_json(session)
|
||||
rebuilt = scad.replay_model_json(model_json)
|
||||
|
||||
print("recorded_nodes", session.graph.node_count)
|
||||
print("replayed_outputs", len(rebuilt))
|
||||
```
|
||||
|
||||
## FreeCAD 转换
|
||||
|
||||
可以把记录的模型 JSON 转换为 FreeCAD Python 脚本：
|
||||
|
||||
```python
|
||||
script = scad.translator.freecad_translator.translate_model_json_to_freecad_script(model_json)
|
||||
```
|
||||
|
||||
如果系统中存在 FreeCAD 或 FreeCADCmd，也可以直接生成 `.FCStd` 文件：
|
||||
|
||||
```python
|
||||
scad.translator.freecad_translator.translate_model_json_to_fcstd(model_json, "bracket.FCStd")
|
||||
```
|
||||
|
||||
## 文档
|
||||
|
||||
- 公共 API 参考：[`docs/api/`](docs/api/)
|
||||
- 核心类型与建模说明：[`docs/core/`](docs/core/)
|
||||
- 序列化与重放：[`docs/core/serialization/README.md`](docs/core/serialization/README.md)
|
||||
- 操作图 JSON 规范：[`docs/core/operation_graph_json_spec.md`](docs/core/operation_graph_json_spec.md)
|
||||
- 示例索引：[`examples/README.md`](examples/README.md)
|
||||
|
||||
## 发布 Agent Skill
|
||||
|
||||
仓库中的 `skills/simplecadapi/` 是精简版 Agent Skill。它包含生成的 API 和建模参考文档，但不包含 SDK 源代码。
|
||||
|
||||
在干净的工作区中更新项目版本和文档，然后生成并验证发布产物：
|
||||
|
||||
```bash
|
||||
uv sync --group dev
|
||||
uv run skill-pack --refresh-docs --archive
|
||||
uv run python -m pytest test/test_skill_pack.py
|
||||
```
|
||||
|
||||
该命令会刷新生成文档、重建 `skills/simplecadapi/`，并生成 `skills/simplecadapi.tar.gz`。发布前检查 Skill 内容和归档文件：
|
||||
|
||||
```bash
|
||||
git diff -- skills/simplecadapi docs
|
||||
tar -tzf skills/simplecadapi.tar.gz
|
||||
```
|
||||
|
||||
发布时提交生成的 `skills/simplecadapi/` 目录和更新后的 `docs/`。归档文件已被 Git 忽略；请将 `skills/simplecadapi.tar.gz` 附加到对应的 GitHub Release，或上传到目标 Agent Skills 注册中心。
|
||||
|
||||
## 开发
|
||||
|
||||
```bash
|
||||
uv sync --group dev
|
||||
uv run python -m pytest test tests
|
||||
python3 -m compileall src/simplecadapi
|
||||
```
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 GNU Affero 通用公共许可证第 3 版（AGPL-3.0），详见 [`LICENSE`](LICENSE)。
|
||||
|
||||
## 社区交流
|
||||
|
||||
由于群聊人数过多，无法直接扫码入群。请扫描下方二维码添加杜鹏老师微信，由杜鹏老师邀请加入 CADDesigner 技术交流群：
|
||||
|
||||
<p align="center">
|
||||
<img src="img/dp个人账号.png.jpg" alt="杜鹏老师个人微信二维码" width="420">
|
||||
</p>
|
||||
@@ -0,0 +1,17 @@
|
||||
# Assembly
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Assembly(assembly_id: str, name: Optional[str] = None, components: Tuple[Component, ...] = (), connectors: Tuple[Connector, ...] = (), constraints: Tuple[Constraint, ...] = (), grounded_component_ids: Tuple[str, ...] = ())
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Assembly`
|
||||
|
||||
## Description
|
||||
|
||||
Product structure containing placed Part or subassembly components.
|
||||
@@ -0,0 +1,21 @@
|
||||
# BSplineFitResult
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class BSplineFitResult(degree: int, control_points: Tuple[PointTuple, ...], knots: Tuple[float, ...], sample_parameters: Tuple[float, ...], max_error: float, rms_error: float, tolerance: float, fairing: float, iterations: int, converged: bool)
|
||||
```
|
||||
|
||||
*Source: math.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import BSplineFitResult`
|
||||
|
||||
## Description
|
||||
|
||||
Result from fitting a cubic B-spline to sampled curve points.
|
||||
|
||||
The result stores a complete, normalized B-spline definition suitable for
|
||||
passing into the exact B-spline edge/wire APIs: cubic degree, control
|
||||
points, and a full clamped knot vector.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Component
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Component(component_id: str, item: AssemblyItem, placement: Placement, name: Optional[str] = None)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Component`
|
||||
|
||||
## Description
|
||||
|
||||
Assembly-local instance of a Part or subassembly.
|
||||
@@ -0,0 +1,22 @@
|
||||
# Connector
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Connector(connector_id: str, geometry_ref: Optional[GeometryRef] = None, name: Optional[str] = None, anchor: Optional[ConnectorAnchor] = None)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Connector`
|
||||
|
||||
## Description
|
||||
|
||||
Semantic datum frame anchored by geometry, placement, or forwarding.
|
||||
|
||||
Geometry connectors derive placement from a selected BREP sub-shape.
|
||||
Placement connectors store an explicit local datum frame. Forwarded
|
||||
connectors expose a component connector as an assembly-level public
|
||||
interface.
|
||||
@@ -0,0 +1,19 @@
|
||||
# ConnectorAnchor
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class ConnectorAnchor(anchor_kind: str, geometry_ref: Optional[GeometryRef] = None, placement: Optional[Placement] = None, source_component_id: Optional[str] = None, source_connector_id: Optional[str] = None, offset: Optional[Placement] = None)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import ConnectorAnchor`
|
||||
|
||||
## Description
|
||||
|
||||
Serializable source for a connector datum frame.
|
||||
|
||||
Supported `anchor_kind` values are `geometry`, `placement`, and `forwarded`.
|
||||
@@ -0,0 +1,17 @@
|
||||
# ConnectorRef
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class ConnectorRef(component_id: str, connector_id: str)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import ConnectorRef`
|
||||
|
||||
## Description
|
||||
|
||||
Reference to a connector through a component instance.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Const
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Const(value: float, expr_id: str = field(default_factory=lambda : _make_expr_id('const')))
|
||||
```
|
||||
|
||||
*Source: expr.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Const`
|
||||
|
||||
## Description
|
||||
|
||||
Immutable constant node used in the v2 expression graph.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Constraint
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Constraint(constraint_id: str, constraint_kind: ConstraintKind, connector_a: ConnectorRef, connector_b: ConnectorRef, drive_distance: Optional[float] = None, distance_limit: Optional[ScalarLimit] = None, drive_angle_degrees: Optional[float] = None, angle_limit: Optional[ScalarLimit] = None, pitch_radius_a: Optional[float] = None, pitch_radius_b: Optional[float] = None, pulley_radius_a: Optional[float] = None, pulley_radius_b: Optional[float] = None, pitch_radius: Optional[float] = None, phase_offset: Optional[float] = None, name: Optional[str] = None)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Constraint`
|
||||
|
||||
## Description
|
||||
|
||||
Connector-to-connector assembly constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# ConstraintReport
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class ConstraintReport(solved: bool, grounded_component_ids: Tuple[str, ...], solved_component_ids: Tuple[str, ...], unsolved_component_ids: Tuple[str, ...], residuals: Tuple[ConstraintResidual, ...])
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import ConstraintReport`
|
||||
|
||||
## Description
|
||||
|
||||
Assembly constraint inspection report.
|
||||
@@ -0,0 +1,17 @@
|
||||
# ConstraintResidual
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class ConstraintResidual(constraint_id: str, translation_error: float, angular_error_degrees: float, within_tolerance: bool)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import ConstraintResidual`
|
||||
|
||||
## Description
|
||||
|
||||
Residual for a single assembly constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Expr
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Expr(op: str, args: Tuple[ScalarExpr, ...], expr_id: str = field(default_factory=lambda : _make_expr_id('expr')))
|
||||
```
|
||||
|
||||
*Source: expr.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Expr`
|
||||
|
||||
## Description
|
||||
|
||||
Derived scalar expression node built from one or more operands.
|
||||
@@ -0,0 +1,17 @@
|
||||
# ExpressionGraph
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class ExpressionGraph()
|
||||
```
|
||||
|
||||
*Source: expr.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import ExpressionGraph`
|
||||
|
||||
## Description
|
||||
|
||||
A lightweight registry of expression DAG nodes.
|
||||
@@ -0,0 +1,30 @@
|
||||
# FreeCADScriptTranslator
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class FreeCADScriptTranslator(document_name: str = 'SimpleCADModel')
|
||||
```
|
||||
|
||||
*Source: translator/freecad_translator/script_translator.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- translator backend: `from simplecadapi.translator.freecad_translator import FreeCADScriptTranslator`
|
||||
|
||||
## Description
|
||||
|
||||
Compile a SimpleCAD model payload into a FreeCAD Python script.
|
||||
|
||||
Current design goals:
|
||||
|
||||
- Translate only from the canonical low-level `graph` IR
|
||||
- Preserve node metadata and graph lineage as FreeCAD custom properties
|
||||
- Preserve `expression_graph` as explicit translator metadata
|
||||
- Preserve exported assembly constraints as document metadata objects
|
||||
- Keep assembly metadata from the full model payload alongside the IR-driven
|
||||
geometry translation
|
||||
|
||||
The generated script focuses on `Part`-workbench-style objects and shape
|
||||
construction, which is a better first target for the current canonical graph
|
||||
than a full `Sketcher/PartDesign` mapping.
|
||||
@@ -0,0 +1,22 @@
|
||||
# GeometryRef
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class GeometryRef(kind: str, source_node_id: Optional[str], geo_selector: Dict[str, Any], flip: bool = False)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import GeometryRef`
|
||||
|
||||
## Description
|
||||
|
||||
Serializable reference to a sub-shape selected via QL.
|
||||
|
||||
Wraps the geo_selector fingerprint + source graph node id so the
|
||||
exact sub-element (Face/Edge/Vertex) can be re-resolved at translation
|
||||
time or during constraint solving. When flip is True, the derived
|
||||
placement Z axis is negated.
|
||||
@@ -0,0 +1,31 @@
|
||||
# GraphSession
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class GraphSession(graph_id: Optional[str] = None)
|
||||
```
|
||||
|
||||
*Source: graph.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import GraphSession`
|
||||
|
||||
## Description
|
||||
|
||||
Context manager that records CAD operations into a DAG.
|
||||
|
||||
with GraphSession() as session:
|
||||
n1 = record_operation(
|
||||
"make_line_redge", {"start": (0, 0, 0), "end": (1, 0, 0)}
|
||||
)
|
||||
n2 = record_operation(
|
||||
"make_line_redge", {"start": (1, 0, 0), "end": (1, 1, 0)}
|
||||
)
|
||||
record_operation(
|
||||
"make_wire_from_edges_rwire", {"edge_count": 2}, inputs=[n1, n2]
|
||||
)
|
||||
|
||||
# Access the graph after the session
|
||||
print(session.graph.topological_order())
|
||||
@@ -0,0 +1,17 @@
|
||||
# Material
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Material(material_id: str, name: Optional[str] = None, density: Optional[float] = None, density_unit: Optional[str] = None, color: Optional[Vec3] = None)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Material`
|
||||
|
||||
## Description
|
||||
|
||||
Material definition assigned to a Part through `assign_material_rpart`.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Part
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Part(part_id: str, body: Solid, name: Optional[str] = None, material: Optional[Material] = None, connectors: Tuple[Connector, ...] = ())
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Part`
|
||||
|
||||
## Description
|
||||
|
||||
Single-body product item wrapping exactly one Solid.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Placement
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Placement(origin: Vec3, x_axis: Vec3 = (1.0, 0.0, 0.0), y_axis: Vec3 = (0.0, 1.0, 0.0), z_axis: Vec3 = (0.0, 0.0, 1.0))
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Placement`
|
||||
|
||||
## Description
|
||||
|
||||
Right-handed placement mapping child-local coordinates to parent coordinates.
|
||||
@@ -0,0 +1,217 @@
|
||||
# SimpleCAD API Index
|
||||
|
||||
This index includes generated docs for the public SimpleCAD API surface, including geometry operations, graph/model JSON workflows, expressions, QL, and export helpers.
|
||||
|
||||
## Import Surfaces
|
||||
|
||||
- Entries marked `top-level` are exported from `simplecadapi` and can be imported with `from simplecadapi import <name>`.
|
||||
- Entries marked `submodule` are public through the listed submodule, such as `simplecadapi.ql`.
|
||||
- Entries marked `translator backend` are public only through `simplecadapi.translator.<backend>`.
|
||||
|
||||
## Basic Creation
|
||||
|
||||
- [make_2d_cut_rface](make_2d_cut_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_2d_intersect_rface](make_2d_intersect_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_2d_union_rface](make_2d_union_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_angle_arc_redge](make_angle_arc_redge.md) *(from operations.py)* `top-level`
|
||||
- [make_angle_arc_rwire](make_angle_arc_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_assembly_rassembly](make_assembly_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [make_box_rsolid](make_box_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [make_circle_redge](make_circle_redge.md) *(from operations.py)* `top-level`
|
||||
- [make_circle_rface](make_circle_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_circle_rwire](make_circle_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_compound_from_assembly_rcompound](make_compound_from_assembly_rcompound.md) *(from operations.py)* `top-level`
|
||||
- [make_cone_rsolid](make_cone_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [make_connector_ref_rconnectorref](make_connector_ref_rconnectorref.md) *(from operations.py)* `top-level`
|
||||
- [make_cylinder_rsolid](make_cylinder_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [make_edge_connector_rconnector](make_edge_connector_rconnector.md) *(from operations.py)* `top-level`
|
||||
- [make_face_connector_rconnector](make_face_connector_rconnector.md) *(from operations.py)* `top-level`
|
||||
- [make_face_from_sketch_rface](make_face_from_sketch_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_face_from_wire_rface](make_face_from_wire_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_face_from_wires_rface](make_face_from_wires_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_helix_redge](make_helix_redge.md) *(from operations.py)* `top-level`
|
||||
- [make_helix_rwire](make_helix_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_line_redge](make_line_redge.md) *(from operations.py)* `top-level`
|
||||
- [make_material_rmaterial](make_material_rmaterial.md) *(from operations.py)* `top-level`
|
||||
- [make_part_rpart](make_part_rpart.md) *(from operations.py)* `top-level`
|
||||
- [make_placement_connector_rconnector](make_placement_connector_rconnector.md) *(from operations.py)* `top-level`
|
||||
- [make_placement_rplacement](make_placement_rplacement.md) *(from operations.py)* `top-level`
|
||||
- [make_point_rvertex](make_point_rvertex.md) *(from operations.py)* `top-level`
|
||||
- [make_polyline_rwire](make_polyline_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_rectangle_rface](make_rectangle_rface.md) *(from operations.py)* `top-level`
|
||||
- [make_rectangle_rwire](make_rectangle_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_scalar_limit_rscalarlimit](make_scalar_limit_rscalarlimit.md) *(from operations.py)* `top-level`
|
||||
- [make_segment_redge](make_segment_redge.md) *(from operations.py)* `top-level`
|
||||
- [make_segment_rwire](make_segment_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_sketch_rsketch](make_sketch_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [make_sphere_rsolid](make_sphere_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [make_spline_redge](make_spline_redge.md) *(from operations.py)* `top-level`
|
||||
- [make_spline_rwire](make_spline_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_three_point_arc_redge](make_three_point_arc_redge.md) *(from operations.py)* `top-level`
|
||||
- [make_three_point_arc_rwire](make_three_point_arc_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_vertex_connector_rconnector](make_vertex_connector_rconnector.md) *(from operations.py)* `top-level`
|
||||
- [make_wire_from_edges_rwire](make_wire_from_edges_rwire.md) *(from operations.py)* `top-level`
|
||||
- [make_wire_from_sketch_rwire](make_wire_from_sketch_rwire.md) *(from operations.py)* `top-level`
|
||||
|
||||
## Transforms
|
||||
|
||||
- [mirror_shape](mirror_shape.md) *(from operations.py)* `top-level`
|
||||
- [rotate_shape](rotate_shape.md) *(from operations.py)* `top-level`
|
||||
- [translate_shape](translate_shape.md) *(from operations.py)* `top-level`
|
||||
|
||||
## 3D Operations
|
||||
|
||||
- [extrude_rsolid](extrude_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [loft_rsolid](loft_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [revolve_rsolid](revolve_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [sweep_rsolid](sweep_rsolid.md) *(from operations.py)* `top-level`
|
||||
|
||||
## Tagging and Selection
|
||||
|
||||
- [apply_tag](apply_tag.md) *(from operations.py)* `top-level`
|
||||
- [list_tags](list_tags.md) *(from operations.py)* `top-level`
|
||||
- [select_edges_by_tag](select_edges_by_tag.md) *(from operations.py)* `top-level`
|
||||
- [select_faces_by_tag](select_faces_by_tag.md) *(from operations.py)* `top-level`
|
||||
|
||||
## Boolean Operations
|
||||
|
||||
- [cut_rsolid](cut_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [intersect_rsolid](intersect_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [union_rsolid](union_rsolid.md) *(from operations.py)* `top-level`
|
||||
|
||||
## Export
|
||||
|
||||
- [export_step](export_step.md) *(from operations.py)* `top-level`
|
||||
- [export_stl](export_stl.md) *(from operations.py)* `top-level`
|
||||
|
||||
## FreeCAD Translation
|
||||
|
||||
- [FreeCADScriptTranslator](FreeCADScriptTranslator.md) *(from translator/freecad_translator/script_translator.py)* `translator backend`
|
||||
- [translate_model_json_to_fcstd](translate_model_json_to_fcstd.md) *(from translator/freecad_translator/api.py)* `translator backend`
|
||||
- [translate_model_json_to_freecad_script](translate_model_json_to_freecad_script.md) *(from translator/freecad_translator/api.py)* `translator backend`
|
||||
|
||||
## Math Helpers
|
||||
|
||||
- [BSplineFitResult](BSplineFitResult.md) *(from math.py)* `top-level`
|
||||
- [fit_cubic_bspline_control_points](fit_cubic_bspline_control_points.md) *(from math.py)* `top-level`
|
||||
|
||||
## Modeling Graph and Replay
|
||||
|
||||
- [GraphSession](GraphSession.md) *(from graph.py)* `top-level`
|
||||
- [export_graph_json](export_graph_json.md) *(from serializer.py)* `top-level`
|
||||
- [export_model_json](export_model_json.md) *(from serializer.py)* `top-level`
|
||||
- [export_session_json](export_session_json.md) *(from serializer.py)* `top-level`
|
||||
- [import_graph_json](import_graph_json.md) *(from serializer.py)* `top-level`
|
||||
- [import_model_json](import_model_json.md) *(from serializer.py)* `top-level`
|
||||
- [import_session_json](import_session_json.md) *(from serializer.py)* `top-level`
|
||||
- [replay_graph](replay_graph.md) *(from serializer.py)* `top-level`
|
||||
- [replay_model_json](replay_model_json.md) *(from serializer.py)* `top-level`
|
||||
- [suspend_graph_recording](suspend_graph_recording.md) *(from graph.py)* `top-level`
|
||||
|
||||
## Expressions and Parameters
|
||||
|
||||
- [Const](Const.md) *(from expr.py)* `top-level`
|
||||
- [Expr](Expr.md) *(from expr.py)* `top-level`
|
||||
- [ExpressionGraph](ExpressionGraph.md) *(from expr.py)* `top-level`
|
||||
- [Var](Var.md) *(from expr.py)* `top-level`
|
||||
- [const](const_function.md) *(from expr.py)* `top-level`
|
||||
- [var](var_function.md) *(from expr.py)* `top-level`
|
||||
|
||||
## Types and Errors
|
||||
|
||||
- [SimpleCADError](SimpleCADError.md) *(from errors.py)* `top-level`
|
||||
- [Sketch](Sketch.md) *(from sketch.py)* `top-level`
|
||||
- [SketchConstraint](SketchConstraint.md) *(from sketch.py)* `top-level`
|
||||
- [SketchConstraintDiagnostic](SketchConstraintDiagnostic.md) *(from sketch.py)* `top-level`
|
||||
- [SketchRef](SketchRef.md) *(from sketch.py)* `top-level`
|
||||
- [SketchSolveResult](SketchSolveResult.md) *(from sketch.py)* `top-level`
|
||||
|
||||
## Advanced Features
|
||||
|
||||
- [chamfer_rsolid](chamfer_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [fillet_rsolid](fillet_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [helical_sweep_rsolid](helical_sweep_rsolid.md) *(from operations.py)* `top-level`
|
||||
- [shell_rsolid](shell_rsolid.md) *(from operations.py)* `top-level`
|
||||
|
||||
## Evolve
|
||||
|
||||
- [make_n_hole_flange_rsolid](make_n_hole_flange_rsolid.md) *(from evolve.py)* `top-level`
|
||||
- [make_naca_propeller_blade_rsolid](make_naca_propeller_blade_rsolid.md) *(from evolve.py)* `top-level`
|
||||
- [make_threaded_rod_rsolid](make_threaded_rod_rsolid.md) *(from evolve.py)* `top-level`
|
||||
|
||||
## Other
|
||||
|
||||
- [Assembly](Assembly.md) *(from product.py)* `top-level`
|
||||
- [Component](Component.md) *(from product.py)* `top-level`
|
||||
- [Connector](Connector.md) *(from product.py)* `top-level`
|
||||
- [ConnectorAnchor](ConnectorAnchor.md) *(from product.py)* `top-level`
|
||||
- [ConnectorRef](ConnectorRef.md) *(from product.py)* `top-level`
|
||||
- [Constraint](Constraint.md) *(from product.py)* `top-level`
|
||||
- [ConstraintReport](ConstraintReport.md) *(from product.py)* `top-level`
|
||||
- [ConstraintResidual](ConstraintResidual.md) *(from product.py)* `top-level`
|
||||
- [GeometryRef](GeometryRef.md) *(from product.py)* `top-level`
|
||||
- [Material](Material.md) *(from product.py)* `top-level`
|
||||
- [Part](Part.md) *(from product.py)* `top-level`
|
||||
- [Placement](Placement.md) *(from product.py)* `top-level`
|
||||
- [ScalarLimit](ScalarLimit.md) *(from product.py)* `top-level`
|
||||
- [SemanticDelta](SemanticDelta.md) *(from topology.py)* `top-level`
|
||||
- [SemanticRef](SemanticRef.md) *(from topology.py)* `top-level`
|
||||
- [add_arc_rsketch](add_arc_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [add_belt_constraint_rassembly](add_belt_constraint_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [add_bspline_rsketch](add_bspline_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [add_circle_rsketch](add_circle_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [add_component_rassembly](add_component_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [add_connector_rassembly](add_connector_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [add_connector_rpart](add_connector_rpart.md) *(from operations.py)* `top-level`
|
||||
- [add_fixed_constraint_rassembly](add_fixed_constraint_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [add_gear_constraint_rassembly](add_gear_constraint_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [add_line_rsketch](add_line_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [add_point_rsketch](add_point_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [add_prismatic_constraint_rassembly](add_prismatic_constraint_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [add_rack_pinion_constraint_rassembly](add_rack_pinion_constraint_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [add_revolute_constraint_rassembly](add_revolute_constraint_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [and_](and_.md) *(from ql.py)* `submodule:ql`
|
||||
- [assign_material_rpart](assign_material_rpart.md) *(from operations.py)* `top-level`
|
||||
- [constrain_angle_rsketch](constrain_angle_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_coincident_rsketch](constrain_coincident_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_collinear_rsketch](constrain_collinear_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_concentric_rsketch](constrain_concentric_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_connect_rsketch](constrain_connect_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_diameter_rsketch](constrain_diameter_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_distance_rsketch](constrain_distance_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_distance_x_rsketch](constrain_distance_x_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_distance_y_rsketch](constrain_distance_y_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_equal_length_rsketch](constrain_equal_length_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_equal_radius_rsketch](constrain_equal_radius_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_fix_rsketch](constrain_fix_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_horizontal_rsketch](constrain_horizontal_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_length_rsketch](constrain_length_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_midpoint_rsketch](constrain_midpoint_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_parallel_rsketch](constrain_parallel_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_perpendicular_rsketch](constrain_perpendicular_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_point_on_rsketch](constrain_point_on_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_radius_rsketch](constrain_radius_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_symmetric_rsketch](constrain_symmetric_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_tangent_rsketch](constrain_tangent_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [constrain_vertical_rsketch](constrain_vertical_rsketch.md) *(from operations.py)* `top-level`
|
||||
- [forward_connector_rassembly](forward_connector_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [geo](geo.md) *(from ql.py)* `submodule:ql`
|
||||
- [get_sketch_entity_rsketchref](get_sketch_entity_rsketchref.md) *(from operations.py)* `top-level`
|
||||
- [get_sketch_point_rsketchref](get_sketch_point_rsketchref.md) *(from operations.py)* `top-level`
|
||||
- [ground_component_rassembly](ground_component_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [identity_placement_rplacement](identity_placement_rplacement.md) *(from operations.py)* `top-level`
|
||||
- [inspect_assembly_constraints_rconstraintreport](inspect_assembly_constraints_rconstraintreport.md) *(from operations.py)* `top-level`
|
||||
- [inspect_sketch_rsketchresult](inspect_sketch_rsketchresult.md) *(from operations.py)* `top-level`
|
||||
- [linear_pattern_rsolidlist](linear_pattern_rsolidlist.md) *(from operations.py)* `top-level`
|
||||
- [measure_constraint_residual_rconstraintresidual](measure_constraint_residual_rconstraintresidual.md) *(from operations.py)* `top-level`
|
||||
- [meta](meta.md) *(from ql.py)* `submodule:ql`
|
||||
- [not_](not_.md) *(from ql.py)* `submodule:ql`
|
||||
- [or_](or_.md) *(from ql.py)* `submodule:ql`
|
||||
- [place_component_rassembly](place_component_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [radial_pattern_rsolidlist](radial_pattern_rsolidlist.md) *(from operations.py)* `top-level`
|
||||
- [render_screenshot_rpath](render_screenshot_rpath.md) *(from operations.py)* `top-level`
|
||||
- [select](select.md) *(from ql.py)* `submodule:ql`
|
||||
- [solve_assembly_constraints_rassembly](solve_assembly_constraints_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [tag](tag.md) *(from ql.py)* `submodule:ql`
|
||||
- [unground_component_rassembly](unground_component_rassembly.md) *(from operations.py)* `top-level`
|
||||
- [value](value.md) *(from ql.py)* `submodule:ql`
|
||||
@@ -0,0 +1,17 @@
|
||||
# ScalarLimit
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class ScalarLimit(lower_value: float, upper_value: float)
|
||||
```
|
||||
|
||||
*Source: product.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import ScalarLimit`
|
||||
|
||||
## Description
|
||||
|
||||
Closed scalar range for a constraint drive coordinate.
|
||||
@@ -0,0 +1,17 @@
|
||||
# SemanticDelta
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class SemanticDelta(created: Tuple[SemanticRef, ...] = (), modified: Tuple[SemanticRef, ...] = (), deleted: Tuple[SemanticRef, ...] = (), metadata: Dict[str, Any] = field(default_factory=dict))
|
||||
```
|
||||
|
||||
*Source: topology.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import SemanticDelta`
|
||||
|
||||
## Description
|
||||
|
||||
Semantic entity change set attached to a single recorded operation.
|
||||
@@ -0,0 +1,17 @@
|
||||
# SemanticRef
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class SemanticRef(graph_id: str, node_id: str, entity_type: str, entity_id: str)
|
||||
```
|
||||
|
||||
*Source: topology.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import SemanticRef`
|
||||
|
||||
## Description
|
||||
|
||||
Stable reference to a semantic model entity in the recorded graph.
|
||||
@@ -0,0 +1,17 @@
|
||||
# SimpleCADError
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class SimpleCADError(operation: str, guidance: ErrorGuidance)
|
||||
```
|
||||
|
||||
*Source: errors.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import SimpleCADError`
|
||||
|
||||
## Description
|
||||
|
||||
Structured ValueError variant for LLM-oriented repair guidance.
|
||||
@@ -0,0 +1,24 @@
|
||||
# Sketch
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Sketch(curves: Iterable[Edge | Wire] | None = None, *, name: Optional[str] = None, plane: Any = 'XY', sketch_id: Optional[str] = None)
|
||||
```
|
||||
|
||||
*Source: sketch.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Sketch`
|
||||
|
||||
## Description
|
||||
|
||||
Declarative constrained sketch container.
|
||||
|
||||
Use `make_sketch_rsketch(...)`, `add_point_rsketch(...)`,
|
||||
`add_line_rsketch(...)`, `add_circle_rsketch(...)`, and
|
||||
`constrain_*_rsketch(...)` as the canonical API for building sketch
|
||||
profiles. Public sketch construction APIs are functional and return an
|
||||
updated `Sketch` document. The legacy `curves` constructor remains only for
|
||||
reading already-built wire/edge containers.
|
||||
@@ -0,0 +1,17 @@
|
||||
# SketchConstraint
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class SketchConstraint(constraint_id: str, kind: str, targets: Tuple[Dict[str, Any], ...], value: Any = None, driving: bool = True, metadata: Dict[str, Any] = field(default_factory=dict))
|
||||
```
|
||||
|
||||
*Source: sketch.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import SketchConstraint`
|
||||
|
||||
## Description
|
||||
|
||||
Serializable constraint inside a declarative sketch.
|
||||
@@ -0,0 +1,17 @@
|
||||
# SketchConstraintDiagnostic
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class SketchConstraintDiagnostic(constraint_id: Optional[str], severity: str, code: str, message: str, residual: Optional[float] = None)
|
||||
```
|
||||
|
||||
*Source: sketch.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import SketchConstraintDiagnostic`
|
||||
|
||||
## Description
|
||||
|
||||
Diagnostic emitted by the sketch solver.
|
||||
@@ -0,0 +1,17 @@
|
||||
# SketchRef
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class SketchRef(sketch_id: str, entity_id: str, *, kind: str, subentity: str = 'geometry')
|
||||
```
|
||||
|
||||
*Source: sketch.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import SketchRef`
|
||||
|
||||
## Description
|
||||
|
||||
Stable reference to a sketch entity or subentity.
|
||||
@@ -0,0 +1,17 @@
|
||||
# SketchSolveResult
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class SketchSolveResult(sketch_id: str, status: str, dof: int, residual_norm: float, iterations: int, solved_points: Dict[str, Tuple[float, float]], solved_scalars: Dict[str, float], diagnostics: Tuple[SketchConstraintDiagnostic, ...] = ())
|
||||
```
|
||||
|
||||
*Source: sketch.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import SketchSolveResult`
|
||||
|
||||
## Description
|
||||
|
||||
Result of solving a declarative sketch.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Var
|
||||
|
||||
## Class Definition
|
||||
|
||||
```python
|
||||
class Var(name: str, default: float, comment: str | None = None, expr_id: str = field(default_factory=lambda : _make_expr_id('var')))
|
||||
```
|
||||
|
||||
*Source: expr.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import Var`
|
||||
|
||||
## Description
|
||||
|
||||
Named scalar parameter with a default fallback value.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_arc_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_arc_rsketch(sketch: Sketch, entity_id: str, start: Union[SketchRef, str], end: Union[SketchRef, str], center: Union[SketchRef, str], *, construction: bool = False) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_arc_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add an arc entity to a sketch.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_belt_constraint_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_belt_constraint_rassembly(assembly: Assembly, constraint_id: str, connector_a: ConnectorRef, connector_b: ConnectorRef, pulley_radius_a: float, pulley_radius_b: float, phase_offset: Optional[float] = None, name: Optional[str] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_belt_constraint_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Couple two revolute axes as belt-linked pulleys with same-direction rotation.
|
||||
@@ -0,0 +1,20 @@
|
||||
# add_bspline_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_bspline_rsketch(sketch: Sketch, entity_id: str, start: Union[SketchRef, str], end: Union[SketchRef, str], control_points: Sequence[Sequence[float]], degree: int = 3, knots: Optional[Sequence[float]] = None, multiplicities: Optional[Sequence[int]] = None, weights: Optional[Sequence[float]] = None, periodic: bool = False, *, construction: bool = False) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_bspline_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a B-spline curve entity to a sketch.
|
||||
|
||||
The start/end point refs link the B-spline into a closed profile
|
||||
loop. Control points are stored as literal 2-D coordinates.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_circle_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_circle_rsketch(sketch: Sketch, entity_id: str, center: Union[SketchRef, str], radius: ScalarLike, *, construction: bool = False) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_circle_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a named circle entity and return an updated sketch document.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_component_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_component_rassembly(assembly: Assembly, item: Union[Part, Assembly], component_id: str, placement: Placement, name: Optional[str] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_component_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Add a placed Part or subassembly component instance to an Assembly.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_connector_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_connector_rassembly(assembly: Assembly, connector: Connector) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_connector_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Attach a connector datum frame to an Assembly definition.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_connector_rpart
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_connector_rpart(part: Part, connector: Connector) -> Part
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_connector_rpart`
|
||||
|
||||
## Description
|
||||
|
||||
Attach a connector datum frame to a Part definition.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_fixed_constraint_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_fixed_constraint_rassembly(assembly: Assembly, constraint_id: str, connector_a: ConnectorRef, connector_b: ConnectorRef, name: Optional[str] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_fixed_constraint_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two component connectors to the same frame.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_gear_constraint_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_gear_constraint_rassembly(assembly: Assembly, constraint_id: str, connector_a: ConnectorRef, connector_b: ConnectorRef, pitch_radius_a: float, pitch_radius_b: float, phase_offset: Optional[float] = None, name: Optional[str] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_gear_constraint_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Couple two revolute axes as meshing gears with inverse rotation.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_line_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_line_rsketch(sketch: Sketch, entity_id: str, start: Union[SketchRef, str], end: Union[SketchRef, str], *, construction: bool = False) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_line_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a named line entity and return an updated sketch document.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_point_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_point_rsketch(sketch: Sketch, point_id: str, x: ScalarLike, y: ScalarLike) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_point_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a named point entity and return an updated sketch document.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_prismatic_constraint_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_prismatic_constraint_rassembly(assembly: Assembly, constraint_id: str, connector_a: ConnectorRef, connector_b: ConnectorRef, drive_distance: Optional[float] = None, distance_limit: Optional[ScalarLimit] = None, name: Optional[str] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_prismatic_constraint_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two connectors as a prismatic slider pair.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_rack_pinion_constraint_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_rack_pinion_constraint_rassembly(assembly: Assembly, constraint_id: str, rack_connector: ConnectorRef, pinion_connector: ConnectorRef, pitch_radius: float, phase_offset: Optional[float] = None, name: Optional[str] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_rack_pinion_constraint_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Couple a prismatic rack axis to a revolute pinion axis.
|
||||
@@ -0,0 +1,17 @@
|
||||
# add_revolute_constraint_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def add_revolute_constraint_rassembly(assembly: Assembly, constraint_id: str, connector_a: ConnectorRef, connector_b: ConnectorRef, drive_angle_degrees: Optional[float] = None, angle_limit: Optional[ScalarLimit] = None, name: Optional[str] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import add_revolute_constraint_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two connectors as a revolute axis pair.
|
||||
@@ -0,0 +1,17 @@
|
||||
# and_
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def and_(*predicates: Predicate) -> Predicate
|
||||
```
|
||||
|
||||
*Source: ql.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- submodule: `from simplecadapi.ql import and_` or `simplecadapi.ql.and_`
|
||||
|
||||
## Description
|
||||
|
||||
Combine predicates so all of them must match.
|
||||
@@ -0,0 +1,23 @@
|
||||
# apply_tag
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def apply_tag(shape: AnyShape, tag: str) -> AnyShape
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import apply_tag`
|
||||
|
||||
## Description
|
||||
|
||||
Attach a normalized tag to a shape using the standard propagation policy.
|
||||
|
||||
Tags must already be normalized lowercase tokens such as
|
||||
``role.mounting_surface`` or ``group.fasteners``. Propagation is intentionally
|
||||
not configurable from the public API; the default tag policy propagates
|
||||
semantic role/anchor/group tags downward and keeps topology-specific tags
|
||||
local.
|
||||
@@ -0,0 +1,17 @@
|
||||
# assign_material_rpart
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def assign_material_rpart(part: Part, material: Material) -> Part
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import assign_material_rpart`
|
||||
|
||||
## Description
|
||||
|
||||
Assign a Material to a Part and return the updated Part.
|
||||
@@ -0,0 +1,17 @@
|
||||
# chamfer_rsolid
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def chamfer_rsolid(solid: Solid, edges: Union[Sequence[Edge], ShapeSelector], distance: ScalarLike) -> Solid
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import chamfer_rsolid`
|
||||
|
||||
## Description
|
||||
|
||||
Apply chamfers to selected solid edges.
|
||||
@@ -0,0 +1,17 @@
|
||||
# const
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def const(value: int | float) -> Const
|
||||
```
|
||||
|
||||
*Source: expr.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import const`
|
||||
|
||||
## Description
|
||||
|
||||
Create a constant scalar node for parameterized modeling.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_angle_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_angle_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], value: ScalarLike, *, constraint_id: Optional[str] = None, driving: bool = True) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_angle_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a driving angle constraint between two sketch lines.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_coincident_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_coincident_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_coincident_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch points to be coincident.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_collinear_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_collinear_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_collinear_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch lines to lie on the same infinite line.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_concentric_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_concentric_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_concentric_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch circles to share a center.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_connect_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_connect_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_connect_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Alias for `constrain_coincident_rsketch` using connection wording.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_diameter_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_diameter_rsketch(sketch: Sketch, circle: Union[SketchRef, str], value: ScalarLike, *, constraint_id: Optional[str] = None, driving: bool = True) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_diameter_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a driving circle diameter constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_distance_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_distance_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], value: ScalarLike, *, constraint_id: Optional[str] = None, driving: bool = True) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_distance_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a driving point-to-point distance constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_distance_x_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_distance_x_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], value: ScalarLike, *, constraint_id: Optional[str] = None, driving: bool = True) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_distance_x_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a driving horizontal distance constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_distance_y_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_distance_y_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], value: ScalarLike, *, constraint_id: Optional[str] = None, driving: bool = True) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_distance_y_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a driving vertical distance constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_equal_length_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_equal_length_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_equal_length_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch lines to have equal length.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_equal_radius_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_equal_radius_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_equal_radius_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch circles to have equal radius.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_fix_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_fix_rsketch(sketch: Sketch, target: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_fix_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Fix a sketch point or entity to its initial coordinates.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_horizontal_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_horizontal_rsketch(sketch: Sketch, line: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_horizontal_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain a sketch line to be horizontal.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_length_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_length_rsketch(sketch: Sketch, line: Union[SketchRef, str], value: ScalarLike, *, constraint_id: Optional[str] = None, driving: bool = True) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_length_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a driving line length constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_midpoint_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_midpoint_rsketch(sketch: Sketch, point: Union[SketchRef, str], line: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_midpoint_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain a sketch point to the midpoint of a line.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_parallel_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_parallel_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_parallel_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch lines to be parallel.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_perpendicular_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_perpendicular_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_perpendicular_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch lines to be perpendicular.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_point_on_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_point_on_rsketch(sketch: Sketch, point: Union[SketchRef, str], entity: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_point_on_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain a sketch point to lie on a line or circle.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_radius_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_radius_rsketch(sketch: Sketch, circle: Union[SketchRef, str], value: ScalarLike, *, constraint_id: Optional[str] = None, driving: bool = True) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_radius_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Add a driving circle radius constraint.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_symmetric_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_symmetric_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], axis: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_symmetric_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain two sketch points to be symmetric about a line axis.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_tangent_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_tangent_rsketch(sketch: Sketch, a: Union[SketchRef, str], b: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_tangent_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain supported sketch curves to be tangent.
|
||||
@@ -0,0 +1,17 @@
|
||||
# constrain_vertical_rsketch
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def constrain_vertical_rsketch(sketch: Sketch, line: Union[SketchRef, str], *, constraint_id: Optional[str] = None) -> Sketch
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import constrain_vertical_rsketch`
|
||||
|
||||
## Description
|
||||
|
||||
Constrain a sketch line to be vertical.
|
||||
@@ -0,0 +1,34 @@
|
||||
# cut_rsolid
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def cut_rsolid(*solids: Union[Solid, Sequence[Solid]], skip_non_intersecting: bool = True) -> Solid
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import cut_rsolid`
|
||||
|
||||
## Description
|
||||
|
||||
Compute the boolean difference of solids.
|
||||
|
||||
Accepts a base solid followed by one or more tool solids, including nested
|
||||
sequences, and returns a single `Solid`.
|
||||
|
||||
## Parameters
|
||||
|
||||
### solids
|
||||
|
||||
- **Description**: One or more Solid objects or sequences of Solid. Nested sequences are flattened before processing; the first solid is the base, the rest are subtracted in order.
|
||||
|
||||
### skip_non_intersecting
|
||||
|
||||
- **Description**: When True, tools with no meaningful intersection are ignored for interactive convenience. Graph replay records this flag and should use False for strict diagnostic workflows.
|
||||
|
||||
## Returns
|
||||
|
||||
Solid: The cut result solid.
|
||||
@@ -0,0 +1,31 @@
|
||||
# export_graph_json
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def export_graph_json(graph: OperationGraph, indent: int = 2) -> str
|
||||
```
|
||||
|
||||
*Source: serializer.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import export_graph_json`
|
||||
|
||||
## Description
|
||||
|
||||
Export an OperationGraph to a JSON string.
|
||||
|
||||
## Parameters
|
||||
|
||||
### graph
|
||||
|
||||
- **Description**: The graph to export.
|
||||
|
||||
### indent
|
||||
|
||||
- **Description**: JSON indentation level.
|
||||
|
||||
## Returns
|
||||
|
||||
JSON string representation.
|
||||
@@ -0,0 +1,22 @@
|
||||
# export_model_json
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def export_model_json(session: 'GraphSession', indent: int = 2) -> str
|
||||
```
|
||||
|
||||
*Source: serializer.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import export_model_json`
|
||||
|
||||
## Description
|
||||
|
||||
Export the canonical 2.0 model seed JSON.
|
||||
|
||||
Current Phase 1 scope uses the active session as the container of:
|
||||
- operation graph
|
||||
- expression graph
|
||||
- capabilities/schema metadata
|
||||
@@ -0,0 +1,17 @@
|
||||
# export_session_json
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def export_session_json(session: 'GraphSession', indent: int = 2) -> str
|
||||
```
|
||||
|
||||
*Source: serializer.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import export_session_json`
|
||||
|
||||
## Description
|
||||
|
||||
Export a graph session including its expression graph.
|
||||
@@ -0,0 +1,50 @@
|
||||
# export_step
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def export_step(shapes: Union[AnyShape, Sequence[AnyShape]], filename: str) -> None
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import export_step`
|
||||
|
||||
## Description
|
||||
|
||||
Export shapes to STEP.
|
||||
|
||||
Use this function when you want to export one shape or many shapes into the
|
||||
same STEP file. Passing `List[Solid]` is valid for pattern outputs or
|
||||
explicit shape collections. Boolean operations return a single `Solid`.
|
||||
|
||||
## Parameters
|
||||
|
||||
### shapes
|
||||
|
||||
- **Description**: A single exportable shape or any nested sequence of exportable shapes. Lists of Solid are supported directly, including pattern or explicitly collected multi-shape results.
|
||||
|
||||
### filename
|
||||
|
||||
- **Description**: Output STEP file path.
|
||||
|
||||
## Returns
|
||||
|
||||
None: Writes the provided shapes into one STEP file.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
```python
|
||||
main_body = make_box_rsolid(10, 4, 4, bottom_face_center=(0, 0, 0))
|
||||
left_cap = make_sphere_rsolid(2.0, center=(-2.0, 2.0, 2.0))
|
||||
right_cap = make_sphere_rsolid(2.0, center=(12.0, 2.0, 2.0))
|
||||
body = union_rsolid(main_body, [left_cap, right_cap])
|
||||
```
|
||||
|
||||
### Example 2
|
||||
```python
|
||||
export_step(body, "rounded_bar.step")
|
||||
```
|
||||
@@ -0,0 +1,50 @@
|
||||
# export_stl
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def export_stl(shapes: Union[AnyShape, Sequence[AnyShape]], filename: str) -> None
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import export_stl`
|
||||
|
||||
## Description
|
||||
|
||||
Export shapes to STL.
|
||||
|
||||
Use this function when you want to export one compound, solid, or face into
|
||||
the same STL file. Passing `List[Solid]` is valid for pattern outputs or
|
||||
explicit shape collections. Boolean operations return a single `Solid`.
|
||||
|
||||
## Parameters
|
||||
|
||||
### shapes
|
||||
|
||||
- **Description**: A single Compound, Solid, or Face, or any nested sequence of those. Lists of Solid are supported directly, including pattern or explicitly collected multi-shape results.
|
||||
|
||||
### filename
|
||||
|
||||
- **Description**: Output STL file path.
|
||||
|
||||
## Returns
|
||||
|
||||
None: Writes the provided shapes into one STL file.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
```python
|
||||
main_body = make_box_rsolid(10, 4, 4, bottom_face_center=(0, 0, 0))
|
||||
left_cap = make_sphere_rsolid(2.0, center=(-2.0, 2.0, 2.0))
|
||||
right_cap = make_sphere_rsolid(2.0, center=(12.0, 2.0, 2.0))
|
||||
body = union_rsolid(main_body, [left_cap, right_cap])
|
||||
```
|
||||
|
||||
### Example 2
|
||||
```python
|
||||
export_stl(body, "rounded_bar.stl")
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
# extrude_rsolid
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def extrude_rsolid(profile: Union[Wire, Face], direction: Tuple[float, float, float], distance: ScalarLike) -> Solid
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import extrude_rsolid`
|
||||
|
||||
## Description
|
||||
|
||||
Create a solid by extruding a profile.
|
||||
@@ -0,0 +1,17 @@
|
||||
# fillet_rsolid
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def fillet_rsolid(solid: Solid, edges: Union[Sequence[Edge], ShapeSelector], radius: ScalarLike) -> Solid
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import fillet_rsolid`
|
||||
|
||||
## Description
|
||||
|
||||
Apply fillets to selected solid edges.
|
||||
@@ -0,0 +1,79 @@
|
||||
# fit_cubic_bspline_control_points
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def fit_cubic_bspline_control_points(sample_points: Sequence[Sequence[float]], *, tolerance: float = 0.001, max_control_points: Optional[int] = None, fairing: float = 1e-06, duplicate_tolerance: float = 1e-12, knot_tolerance: float = 1e-09, raise_on_failure: bool = True) -> BSplineFitResult
|
||||
```
|
||||
|
||||
*Source: math.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import fit_cubic_bspline_control_points`
|
||||
|
||||
## Description
|
||||
|
||||
Fit a minimal cubic B-spline control polygon to sampled curve points.
|
||||
|
||||
Uses chord-length parameterization, cubic clamped B-spline least squares,
|
||||
second-difference fairing regularization, and adaptive simple knot insertion
|
||||
until the maximum sample error is within `tolerance`. Only simple interior
|
||||
knots are inserted, so a cubic result remains C2-continuous at every interior
|
||||
knot.
|
||||
|
||||
## Parameters
|
||||
|
||||
### sample_points
|
||||
|
||||
- **Description**: Ordered 2D or 3D points sampled along the intended curve. Consecutive duplicate points within `duplicate_tolerance` are ignored.
|
||||
|
||||
### tolerance
|
||||
|
||||
- **Description**: Maximum allowed Euclidean fitting error at the input samples.
|
||||
|
||||
### max_control_points
|
||||
|
||||
- **Description**: Upper bound for fitted control points. Defaults to the cleaned sample count, with a cubic minimum of four controls.
|
||||
|
||||
### fairing
|
||||
|
||||
- **Description**: Non-negative second-difference regularization weight. Larger values prefer smoother control polygons while still respecting the error tolerance when possible.
|
||||
|
||||
### duplicate_tolerance
|
||||
|
||||
- **Description**: Distance threshold for removing consecutive duplicate sample points before chord-length parameterization.
|
||||
|
||||
### knot_tolerance
|
||||
|
||||
- **Description**: Normalized parameter spacing threshold used to avoid duplicate or near-boundary interior knots.
|
||||
|
||||
### raise_on_failure
|
||||
|
||||
- **Description**: Raise `ValueError` when the tolerance cannot be reached within `max_control_points`. If false, return the best non-converged result instead.
|
||||
|
||||
## Returns
|
||||
|
||||
`BSplineFitResult` containing cubic degree, control points, a full clamped
|
||||
knot vector, knot multiplicities, sample parameters, and fitting error.
|
||||
|
||||
## Raises
|
||||
|
||||
- **ValueError**: If inputs are invalid, or if the tolerance cannot be met and `raise_on_failure=True`.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
```python
|
||||
```python
|
||||
from simplecadapi.math import fit_cubic_bspline_control_points
|
||||
```
|
||||
|
||||
### Example 2
|
||||
```python
|
||||
samples = [(0.0, 0.0, 0.0), (1.0, 0.4, 0.0), (2.0, 0.0, 0.0)]
|
||||
fit = fit_cubic_bspline_control_points(samples, tolerance=0.01)
|
||||
print(fit.control_points)
|
||||
print(fit.knots, fit.multiplicities)
|
||||
```
|
||||
```
|
||||
@@ -0,0 +1,22 @@
|
||||
# forward_connector_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def forward_connector_rassembly(assembly: Assembly, connector_id: str, source_component_id: str, source_connector_id: str, name: Optional[str] = None, offset: Optional[Placement] = None) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import forward_connector_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Expose an internal component connector as an assembly-level connector.
|
||||
|
||||
The forwarded connector resolves to `source_component.placement *
|
||||
source_connector.placement`, followed by the optional `offset` placement.
|
||||
Parent assemblies can constrain to the subassembly's public connector
|
||||
without depending on its private component structure.
|
||||
@@ -0,0 +1,17 @@
|
||||
# geo
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def geo(field: str, default: Any = None) -> SerializableKey
|
||||
```
|
||||
|
||||
*Source: ql.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- submodule: `from simplecadapi.ql import geo` or `simplecadapi.ql.geo`
|
||||
|
||||
## Description
|
||||
|
||||
Shortcut for reading `geom.*` fields inside QL queries.
|
||||
@@ -0,0 +1,17 @@
|
||||
# get_sketch_entity_rsketchref
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def get_sketch_entity_rsketchref(sketch: Sketch, entity_id: str) -> SketchRef
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import get_sketch_entity_rsketchref`
|
||||
|
||||
## Description
|
||||
|
||||
Return a stable ref for a named sketch entity.
|
||||
@@ -0,0 +1,17 @@
|
||||
# get_sketch_point_rsketchref
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def get_sketch_point_rsketchref(sketch: Sketch, point_path: str) -> SketchRef
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import get_sketch_point_rsketchref`
|
||||
|
||||
## Description
|
||||
|
||||
Return a stable ref for a sketch point or endpoint path.
|
||||
@@ -0,0 +1,17 @@
|
||||
# ground_component_rassembly
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def ground_component_rassembly(assembly: Assembly, component_id: str) -> Assembly
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import ground_component_rassembly`
|
||||
|
||||
## Description
|
||||
|
||||
Ground a component at its current authored placement.
|
||||
@@ -0,0 +1,17 @@
|
||||
# helical_sweep_rsolid
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def helical_sweep_rsolid(profile: Wire, pitch: float, height: float, radius: float, center: Tuple[float, float, float] = (0, 0, 0), dir: Tuple[float, float, float] = (0, 0, 1)) -> Solid
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import helical_sweep_rsolid`
|
||||
|
||||
## Description
|
||||
|
||||
Create a solid by sweeping a profile along a helical path.
|
||||
@@ -0,0 +1,17 @@
|
||||
# identity_placement_rplacement
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def identity_placement_rplacement() -> Placement
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import identity_placement_rplacement`
|
||||
|
||||
## Description
|
||||
|
||||
Create an identity placement.
|
||||
@@ -0,0 +1,27 @@
|
||||
# import_graph_json
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def import_graph_json(json_str: str) -> OperationGraph
|
||||
```
|
||||
|
||||
*Source: serializer.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import import_graph_json`
|
||||
|
||||
## Description
|
||||
|
||||
Import an OperationGraph from a JSON string.
|
||||
|
||||
## Parameters
|
||||
|
||||
### json_str
|
||||
|
||||
- **Description**: JSON string to parse.
|
||||
|
||||
## Returns
|
||||
|
||||
Reconstructed OperationGraph.
|
||||
@@ -0,0 +1,17 @@
|
||||
# import_model_json
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def import_model_json(json_str: str) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
*Source: serializer.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import import_model_json`
|
||||
|
||||
## Description
|
||||
|
||||
Import canonical 2.0 model seed JSON.
|
||||
@@ -0,0 +1,17 @@
|
||||
# import_session_json
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def import_session_json(json_str: str) -> Dict[str, Any]
|
||||
```
|
||||
|
||||
*Source: serializer.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import import_session_json`
|
||||
|
||||
## Description
|
||||
|
||||
Import session payload containing graph and expression graph.
|
||||
@@ -0,0 +1,17 @@
|
||||
# inspect_assembly_constraints_rconstraintreport
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def inspect_assembly_constraints_rconstraintreport(assembly: Assembly) -> ConstraintReport
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import inspect_assembly_constraints_rconstraintreport`
|
||||
|
||||
## Description
|
||||
|
||||
Inspect all assembly constraint residuals without mutating the assembly.
|
||||
@@ -0,0 +1,17 @@
|
||||
# inspect_sketch_rsketchresult
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def inspect_sketch_rsketchresult(sketch: Sketch, *, require_fully_constrained: bool = False, strict: bool = True, tolerance: float = 1e-07, max_iterations: int = 80) -> SketchSolveResult
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import inspect_sketch_rsketchresult`
|
||||
|
||||
## Description
|
||||
|
||||
Inspect sketch constraints by running the solver without recording graph nodes.
|
||||
@@ -0,0 +1,31 @@
|
||||
# intersect_rsolid
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def intersect_rsolid(*solids: Union[Solid, Sequence[Solid]]) -> Solid
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import intersect_rsolid`
|
||||
|
||||
## Description
|
||||
|
||||
Compute the boolean intersection of solids.
|
||||
|
||||
Accepts one or more solids, including nested sequences, and returns a single
|
||||
`Solid`. If the inputs do not overlap meaningfully, the API raises a clear
|
||||
error instead of returning an empty list.
|
||||
|
||||
## Parameters
|
||||
|
||||
### solids
|
||||
|
||||
- **Description**: One or more Solid objects or sequences of Solid. Nested sequences are flattened before processing.
|
||||
|
||||
## Returns
|
||||
|
||||
Solid: The overlap region as a single solid.
|
||||
@@ -0,0 +1,17 @@
|
||||
# linear_pattern_rsolidlist
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def linear_pattern_rsolidlist(shape: AnyShape, direction: Tuple[float, float, float], count: int, spacing: float) -> List[Solid]
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import linear_pattern_rsolidlist`
|
||||
|
||||
## Description
|
||||
|
||||
Create a linear pattern of solids.
|
||||
@@ -0,0 +1,17 @@
|
||||
# list_tags
|
||||
|
||||
## API Definition
|
||||
|
||||
```python
|
||||
def list_tags(shape: AnyShape) -> List[str]
|
||||
```
|
||||
|
||||
*Source: operations.py*
|
||||
|
||||
## Import Surface
|
||||
|
||||
- top-level: `from simplecadapi import list_tags`
|
||||
|
||||
## Description
|
||||
|
||||
Return shape tags in deterministic sorted order.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user