==================================
FeatureCircular (hwx.inspire.core)
==================================

Represents the circumferences of a part.

They are not created through the API but can be retrieved from a part.

----------
Properties
----------

  +---------+---------+---------+
  | axis_   | normal_ | radius_ |
  +---------+---------+---------+

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

  +------------------------------------------------------+
  | findClosestPoint_ (self, referencePoint)             |
  +------------------------------------------------------+
  | getConnectionPoints_ (self, uslices=2, vslices=None) |
  +------------------------------------------------------+
  | isTouching_ (self, point)                            |
  +------------------------------------------------------+
  | isa_ (self, type=None, filter=None, **kwds)          |
  +------------------------------------------------------+

----------------
Property Details
----------------

.. _axis:
.. property:: axis

Returns two points through the center of the circle.

.. _normal:
.. property:: normal

Returns vector perpendicular to circle.

.. _radius:
.. property:: radius

Returns rdius of circle.

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

.. _findClosestPoint:
.. method:: findClosestPoint(self, referencePoint)

Returns the point on feature that nearest to the specified point.

:param referencePoint: Reference point to find closest point on feature.
:type referencePoint: Point

:returns: The closest point of the feature from specified point.
:rtype: Point


.. _getConnectionPoints:
.. method:: getConnectionPoints(self, uslices=2, vslices=None)

Return a list of points that can be used to visualize how the feature
is connected (spider points).

:param uslices: Number of slices in u-direction.
:type uslices: int
:param vslices: Number of slices in v-direction.
:type vslices: int

:returns: Points that can be used to visualize how the
       feature is connected.
:rtype: list[Point]


.. _isTouching:
.. method:: isTouching(self, point)

Determines the point is on the curve or not.

:param point: Point position x,y,z.
:type point: Point


.. _isa:
.. method:: isa(self, type=None, filter=None, **kwds)

Determines the object matches the specified settings or not.

:param type: Specify type of the object.
:type type: Part, Assembly, Contact, ..
:param filter: Return value of specified callback method.
:type filter: method
:param \*\*kwds: Additional keyword arguments to match attributes.