.. oe:namespace:: OEGrapheme


.. _OEGrapheme_OEPlotMarker:

.. oe:class:: OEPlotMarker

   .. oe:api::

      class OEPlotMarker

   This class represents the :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` class
   that encapsulates properties that determine how a plot is depicted.

   .. seealso::

      * :ref:`OERamachandranPlot <OEGrapheme_OERamachandranPlot>` class


   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPlotMarker(const OEDepict::OEPen& pen,
                         unsigned int style = OEPlotMarkerStyle::Circle,
                         double scale = 1.0)

      .. oe:language:: python

         .. oe:api:: python

            OEPlotMarker(pen: OEPen, style: int, scale: float = 1.0) -> OEPlotMarker

      Creates and initializes an :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` object
      with the given parameters.

      *pen*
         The :ref:`OEPen <OEDepict_OEPen>` object that is used to draw the plot marker.

      *style*
         The property that determine the style of the plot marker.
         This value has to be from the :oe:constns:`OEGrapheme::OEPlotMarkerStyle`
         namespace.

      *scale*
        The multiplier that can be used to increase or to decrease the
        size of the plot market.
        This value has to be in the range of ``[0.25, 4.0]``.

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEPlotMarker(const OEPlotMarker& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEPlotMarker(arg2: OEPlotMarker) -> OEPlotMarker

      Copy constructor.


   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEPlotMarker &operator=(const OEPlotMarker &rhs)

      Assignment operator.


   .. ################################################################
      #
      ####################################x############################

   .. oe:method:: operator!=
      :language: c++

      .. oe:api::

         bool operator!=(const OEPlotMarker &) const

      Determines whether two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are
      different.
      Two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are considered different,
      if any of their properties (such as pen, style or scale) are different.


   .. oe:method:: operator==
      :language: c++

      .. oe:api::

         bool operator==(const OEPlotMarker &) const

      Determines whether two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are
      equal.
      Two :ref:`OEPlotMarker <OEGrapheme_OEPlotMarker>` objects are considered equivalent
      only if all of their properties (such as pen, style or scale) are identical.


   .. oe:method:: GetPen

      .. oe:language:: c++ java csharp

         .. oe:api::

            const OEDepict::OEPen& GetPen() const

      .. oe:language:: python

         .. oe:api:: python

            GetPen() -> OEPen

      Returns the pen of the plot marker.

      .. seealso::

         * :ref:`OEPen <OEDepict_OEPen>` class


   .. oe:method:: GetScale

      .. oe:language:: c++ java csharp

         .. oe:api::

            double GetScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetScale() -> float

      Returns the multiplier that is used to increase or to decrease size
      of the plot marker.


   .. oe:method:: GetStyle

      .. oe:language:: c++ java csharp

         .. oe:api::

            unsigned int GetStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetStyle() -> int

      Returns the style of the plot marker.
      The return value is taken from the :oe:constns:`OEGrapheme::OEPlotMarkerStyle`
      namespace.

      .. seealso::

         * :oe:constns:`OEGrapheme::OEPlotMarkerStyle` namespace
