cadquery/doc/classreference.rst

.. _classreference:

*************************
CadQuery Class Summary
*************************

This page documents all of the methods and functions of the CadQuery classes, organized alphabatically.

.. seealso::

    For a listing organized by functional area, see the :ref:`apireference`

.. currentmodule:: cadquery

Core Classes
---------------------

.. autosummary::

     CQ
     Workplane
     Assembly
     Constraint

Topological Classes
----------------------

.. autosummary::
    
    Shape
    Vertex
    Edge
    cadquery.occ_impl.shapes.Mixin1D
    Wire
    Face
    Shell
    cadquery.occ_impl.shapes.Mixin3D
    Solid
    Compound

Geometry Classes
------------------

.. autosummary::

    Vector
    Matrix
    Plane
    Location

Selector Classes
---------------------


.. autosummary::

    Selector
    NearestToPointSelector
    BoxSelector
    BaseDirSelector
    ParallelDirSelector
    DirectionSelector
    DirectionNthSelector
    RadiusNthSelector
    PerpendicularDirSelector
    TypeSelector
    DirectionMinMaxSelector
    BinarySelector
    AndSelector
    SumSelector
    SubtractSelector
    InverseSelector
    StringSyntaxSelector


Class Details
---------------

.. automodule:: cadquery
   :show-inheritance: 
   :members:

.. autoclass:: cadquery.occ_impl.shapes.Mixin1D
   :show-inheritance: 
   :members:

.. autoclass:: cadquery.occ_impl.shapes.Mixin3D
   :show-inheritance: 
   :members:
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			`*************************`

			`This page documents all of the methods and functions of the CadQuery classes, organized alphabatically.`

			`.. 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
fixed documentation 2015-12-01 22:54:36 -05:00			`CQ`
			`Workplane`
Added basic docs 2020-09-04 13:11:16 +02:00			`Assembly`
Doc tweaks 2020-09-07 15:37:13 +02:00			`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
fixed documentation 2015-12-01 22:54:36 -05:00
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`
Update api and class reference 2017-04-22 00:40:24 +02:00			`DirectionNthSelector`
Added RadiusNthSelector 2020-11-18 17:26:01 +10:30			`RadiusNthSelector`
Tried to get documentation Into Shape 2015-11-28 21:05:20 -05:00			`PerpendicularDirSelector`
			`TypeSelector`
			`DirectionMinMaxSelector`
			`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:`

			`.. 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:`