===========================
Cavities (hwx.inspire.core)
===========================

A list of hollows in the model

Useful for plugging cavities. Unlike Holes that are used for regular shaped
(cylindrical, slotted) which are used in defining Part connections, like Motors
and Actuators, Cavities can be irregular shaped.

--------------
Public Methods
--------------

  +----------------------------------------------------------+
  | cavities_ (self)                                         |
  +----------------------------------------------------------+
  | getHoleFromFeature_ (self, feature, holeList=True)       |
  +----------------------------------------------------------+
  | getUnfilteredHoleFromFeature_ (self, feature)            |
  +----------------------------------------------------------+
  | getUnfilteredSingleHoleFromFeature_ (self, feature)      |
  +----------------------------------------------------------+
  | makeDirty_ (self)                                        |
  +----------------------------------------------------------+
  | plugAll_ (self)                                          |
  +----------------------------------------------------------+
  | populate_ (self, minsize=None, maxsize=None, parts=None) |
  +----------------------------------------------------------+

--------------
Method Details
--------------

.. _cavities:
.. method:: cavities(self)

Returns a list of hollows in the model

.. _getHoleFromFeature:
.. method:: getHoleFromFeature(self, feature, holeList=True)

Returns the holes found from the specified feature.

:param feature: Part feature on which holes need to be found.
:type feature: Feature
:param holeList: If True, returns the holes as a list.
:type holeList: bool

:returns: Holes found from the feature.
:rtype: Holes


.. _getUnfilteredHoleFromFeature:
.. method:: getUnfilteredHoleFromFeature(self, feature)

Returns aligned hole from specified feature.

:param feature: Part feature on which aligned hole need to be found.
:type feature: Feature

:returns: Aligned Hole found from the feature.
:rtype: AlignedHole


.. _getUnfilteredSingleHoleFromFeature:
.. method:: getUnfilteredSingleHoleFromFeature(self, feature)

Returns the single hole found from specified feature.

:param feature: Part feature on which single hole need to be found.
:type feature: Feature

:returns: Single Hole found from the feature.
:rtype: Hole


.. _makeDirty:
.. method:: makeDirty(self)

Repopulates the holes.


.. _plugAll:
.. method:: plugAll(self)

Create and return parts that fills the cavities

.. _populate:
.. method:: populate(self, minsize=None, maxsize=None, parts=None)

Get the cavities for the specified parts or the entire model
of parts were not specified

:param minsize: Get the holes with a size larger than minsize
:type minsize: float
:param maxsize: Get the holes with a size smaller than maxsize
:type maxsize: float
:param parts: Get the holes for these parts
:type parts: Part, list[Parts]