===============
Curve (hwx.gui)
===============

A curved line.

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

  +---------------------------------------------------------+
  | addSlider_ (self, **kwds)                               |
  +---------------------------------------------------------+
  | clearMemoryCurve_ (self)                                |
  +---------------------------------------------------------+
  | delete_ (self)                                          |
  +---------------------------------------------------------+
  | formatHoverText_ (self, x, y)                           |
  +---------------------------------------------------------+
  | getNextUnusedColor_ (self)                              |
  +---------------------------------------------------------+
  | getTheClosestPoint_ (self, x, y)                        |
  +---------------------------------------------------------+
  | setHovered_ (self, points, showText=False, event=None)  |
  +---------------------------------------------------------+
  | setMemoryCurve_ (self)                                  |
  +---------------------------------------------------------+
  | setSelected_ (self, points, showText=False, event=None) |
  +---------------------------------------------------------+

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

.. _addSlider:
.. method:: addSlider(self, **kwds)

Adds a curve slider.

.. _clearMemoryCurve:
.. method:: clearMemoryCurve(self)

Clears original curve.

.. _delete:
.. method:: delete(self)

Removes this curve from the plot.

.. _formatHoverText:
.. method:: formatHoverText(self, x, y)

Formats the curve point text when hovered.

:param x: X value to be formatted.
:type x: float
:param y: Y value to be formatted.
:type y: float

:returns: The formatted string with X and Y value.
:rtype: str


.. _getNextUnusedColor:
.. method:: getNextUnusedColor(self)

Gets next unused color.

.. _getTheClosestPoint:
.. method:: getTheClosestPoint(self, x, y)

Gets the closest CurvePoint for the specified x and y.

:param x: Specified x value.
:type x: float
:param y: Specified y value.
:type y: float

:returns: The closest CurvePoint.
:rtype: CurvePoint


.. _setHovered:
.. method:: setHovered(self, points, showText=False, event=None)

Sets the curve points hovered.

:param points: The list of points to be set hovered.
:type points: list[Point]
:param showText: Determines whether to show hovered text.
:type showText: bool
:param event: MouseEvent to capture the hover.
:type event: MouseEvent


.. _setMemoryCurve:
.. method:: setMemoryCurve(self)

Shows original curve when dragging.

.. _setSelected:
.. method:: setSelected(self, points, showText=False, event=None)

Sets the curve points selected.

:param points: The list of points to be set selected.
:type points: list[Point]
:param showText: Determines whether to show selected text.
:type showText: bool
:param event: MouseEvent to. capture the selection.
:type event: MouseEvent