ByoungSooPark/cadquery
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2d355177871c0b1a275640659ba203cf3cdf267c
cadquery/doc/classreference.rst

109 lines
1.8 KiB
ReStructuredText
Raw Normal View History

renamed folders to standard ones
2013-04-15 21:22:54 -04:00
.. _classreference:
*************************
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
CadQuery Class Summary
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
*************************
Fix spelling mistakes and typos.
2021-08-25 23:38:52 +01:00
This page documents all of the methods and functions of the CadQuery classes, organized alphabetically.
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
.. seealso::
For a listing organized by functional area, see the :ref:`apireference`
workable version of cqgi version
2015-12-09 21:01:14 -05:00
.. currentmodule:: cadquery
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
Core Classes
---------------------
.. autosummary::
Implement locations() for Wires (#475) * Implement locations() for Wires * Fix errors * Test for locations on a wire * Refactored Mixin1D * Mypy fixes and more refactoring * black fix * Moved _geomAdaptor to concrete classes * Add positionAt * Added positions() * positions() and positionAt() test * Better tests * Extended tangentAt and added docstrings * Test for tangentAt * Fixed defects * Doc fix attempt * Use autoclass on Mixins * specify full name in sphinx
2020-10-30 22:31:51 +01:00
Sketch support (#879) Squashed commit of many changes, see PR #879 for full details.
2021-11-11 10:58:09 +01:00
Sketch
Workplane
Assembly
Constraint
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
Topological Classes
----------------------
now sphinxdoc works
2013-04-23 20:33:39 -04:00
.. autosummary::
Implement locations() for Wires (#475) * Implement locations() for Wires * Fix errors * Test for locations on a wire * Refactored Mixin1D * Mypy fixes and more refactoring * black fix * Moved _geomAdaptor to concrete classes * Add positionAt * Added positions() * positions() and positionAt() test * Better tests * Extended tangentAt and added docstrings * Test for tangentAt * Fixed defects * Doc fix attempt * Use autoclass on Mixins * specify full name in sphinx
2020-10-30 22:31:51 +01:00
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
Shape
now sphinxdoc works
2013-04-23 20:33:39 -04:00
Vertex
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
Edge
Implement locations() for Wires (#475) * Implement locations() for Wires * Fix errors * Test for locations on a wire * Refactored Mixin1D * Mypy fixes and more refactoring * black fix * Moved _geomAdaptor to concrete classes * Add positionAt * Added positions() * positions() and positionAt() test * Better tests * Extended tangentAt and added docstrings * Test for tangentAt * Fixed defects * Doc fix attempt * Use autoclass on Mixins * specify full name in sphinx
2020-10-30 22:31:51 +01:00
cadquery.occ_impl.shapes.Mixin1D
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
Wire
Face
Shell
Implement locations() for Wires (#475) * Implement locations() for Wires * Fix errors * Test for locations on a wire * Refactored Mixin1D * Mypy fixes and more refactoring * black fix * Moved _geomAdaptor to concrete classes * Add positionAt * Added positions() * positions() and positionAt() test * Better tests * Extended tangentAt and added docstrings * Test for tangentAt * Fixed defects * Doc fix attempt * Use autoclass on Mixins * specify full name in sphinx
2020-10-30 22:31:51 +01:00
cadquery.occ_impl.shapes.Mixin3D
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
Solid
Compound
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
now sphinxdoc works
2013-04-23 20:33:39 -04:00
Geometry Classes
------------------
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
.. autosummary::
Implement locations() for Wires (#475) * Implement locations() for Wires * Fix errors * Test for locations on a wire * Refactored Mixin1D * Mypy fixes and more refactoring * black fix * Moved _geomAdaptor to concrete classes * Add positionAt * Added positions() * positions() and positionAt() test * Better tests * Extended tangentAt and added docstrings * Test for tangentAt * Fixed defects * Doc fix attempt * Use autoclass on Mixins * specify full name in sphinx
2020-10-30 22:31:51 +01:00
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
Vector
Matrix
Plane
Added basic docs
2020-09-04 13:11:16 +02:00
Location
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
now sphinxdoc works
2013-04-23 20:33:39 -04:00
Selector Classes
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
---------------------
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
Constraints docs [WIP] (#524) * Initial version of the constraints docs * Adding the assy section * apireference cleanup * Include cutouts * Roadmap cleanup * _query cleanup * Black fix * Add RadiusNthSelector again * Typo fix * Paste error fix * Show detailed selector docs * Another typo fix * Mention other constrain overload * Added test for end()
2020-11-30 13:41:34 +01:00
.. currentmodule:: cadquery.selectors
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
.. autosummary::
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
Selector
NearestToPointSelector
BoxSelector
BaseDirSelector
ParallelDirSelector
DirectionSelector
PerpendicularDirSelector
TypeSelector
Added new selector classes to docs
2020-12-18 12:15:46 +10:30
RadiusNthSelector
CenterNthSelector
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
DirectionMinMaxSelector
Added new selector classes to docs
2020-12-18 12:15:46 +10:30
DirectionNthSelector
Added AreaNthSelector (#688) * Added AreaNthSelector Added AreaNthSelector that is useful for nested features selection. Especially to select one of coplanar nested wires for subsequent extrusion, cutting or filleting. * LengthNthSelector * Explicitly marked _NthSelector class and _NthSelector.key(..) method as abstract using standard abc package * AreaNthSelector ignores "bad" Wires AreaNthSelector.key raises ValueError if temporary face creation fails for a wire for any reason (non-planar, non-closed). That causes _NthSelector that it inherits to ignore such wires. Done so for consistency with RadiusNthSelector that ignores anything it can not get radius from. Co-authored-by: Marcus Boyd <mwb@geosol.com.au>
2021-03-17 06:44:37 +03:00
LengthNthSelector
AreaNthSelector
Tried to get documentation Into Shape
2015-11-28 21:05:20 -05:00
BinarySelector
AndSelector
SumSelector
SubtractSelector
InverseSelector
StringSyntaxSelector
Class Details
---------------
fixed documentation
2015-12-01 22:54:36 -05:00
.. automodule:: cadquery
Implement locations() for Wires (#475) * Implement locations() for Wires * Fix errors * Test for locations on a wire * Refactored Mixin1D * Mypy fixes and more refactoring * black fix * Moved _geomAdaptor to concrete classes * Add positionAt * Added positions() * positions() and positionAt() test * Better tests * Extended tangentAt and added docstrings * Test for tangentAt * Fixed defects * Doc fix attempt * Use autoclass on Mixins * specify full name in sphinx
2020-10-30 22:31:51 +01:00
:show-inheritance:
:members:
Document special members
2021-02-12 08:35:45 +01:00
:special-members:
Implement locations() for Wires (#475) * Implement locations() for Wires * Fix errors * Test for locations on a wire * Refactored Mixin1D * Mypy fixes and more refactoring * black fix * Moved _geomAdaptor to concrete classes * Add positionAt * Added positions() * positions() and positionAt() test * Better tests * Extended tangentAt and added docstrings * Test for tangentAt * Fixed defects * Doc fix attempt * Use autoclass on Mixins * specify full name in sphinx
2020-10-30 22:31:51 +01:00
.. autoclass:: cadquery.occ_impl.shapes.Mixin1D
:show-inheritance:
:members:
.. autoclass:: cadquery.occ_impl.shapes.Mixin3D
:show-inheritance:
renamed folders to standard ones
2013-04-15 21:22:54 -04:00
:members:
Constraints docs [WIP] (#524) * Initial version of the constraints docs * Adding the assy section * apireference cleanup * Include cutouts * Roadmap cleanup * _query cleanup * Black fix * Add RadiusNthSelector again * Typo fix * Paste error fix * Show detailed selector docs * Another typo fix * Mention other constrain overload * Added test for end()
2020-11-30 13:41:34 +01:00
.. automodule:: cadquery.selectors
:show-inheritance:
Added new selector classes to docs
2020-12-18 12:15:46 +10:30
:members:
STEP export * exporters.export: expose STEP options * Use default OCCT write.precision.mode value 0 * Doc update Merge branch 'master' into step
2022-05-21 18:33:14 -04:00
.. automodule:: cadquery.occ_impl.exporters.assembly
:show-inheritance:
:members:
Document `occ_impl.assembly.toJSON` (#1241)
2023-01-24 00:29:32 +13:00
.. autofunction:: cadquery.occ_impl.assembly.toJSON
DXF multilayer support (#1267) * Test DXF export with text * DXF multilayer support Also supports: * setting units * setting color by layer * setting line type by layer * Apply transformation to bspline curve on DXF export * Typing improvements * Improve test coverage --------- Co-authored-by: Lorenz Neureuter <hello@lorenz.space>
2023-03-16 19:39:13 +13:00
.. autoclass:: cadquery.occ_impl.exporters.dxf.DxfDocument
:members:
.. automethod:: __init__
Reference in New Issue Copy Permalink