================================
FeaturePlanar (hwx.inspire.core)
================================

Features that are flat face.

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

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

  +---------+
  | normal_ |
  +---------+

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

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

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

.. _normal:
.. property:: normal

Returns vector perpendicular to face.

--------------
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=2)

Returns 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:

       List of points that can be used to visualize
         how the feature is connected.
:rtype: list[Point]


.. _getNormal:
.. method:: getNormal(self, point=None)

Returns vector perpendicular to face.

Point is ignored for FeaturePlanar.

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

Determines the point is on the surface or not.

:param point: Point positionin x, y, z coordinates.
: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.


.. _isperiodic:
.. method:: isperiodic(self)

Returns True if it's a periodic area, False otherwise.