.. oe:namespace:: OESystem



.. meta::
   :keywords: OEColorStop, ColorStop


.. _OESystem_OEColorStop:

.. oe:class:: OEColorStop

   .. oe:api::

      class OEColorStop

   The :ref:`OEColorStop <OESystem_OEColorStop>` class stores a color
   (:ref:`OEColor <OESystem_OEColor>`) and value (double) pair that is used
   by the color gradient classes.

   .. seealso::

      * :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>` base class
      * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class
      * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class
      * :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class
      * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class


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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEColorStop(double value, const OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            OEColorStop(value: float, color: OEColor) -> OEColorStop

      Default constructor.

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

         .. oe:api::

            OEColorStop(const OEColorStop& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEColorStop(rhs: OEColorStop) -> OEColorStop

      Copy constructor.

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

      .. oe:api::

         OEColorStop &operator=(const OEColorStop &rhs)

      Assignment operator.

   .. ################################################################
      # GetColor
      ################################################################

   .. oe:method:: GetColor

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

         .. oe:api::

            const OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the :ref:`OEColor <OESystem_OEColor>` stored in the
      :ref:`OEColorStop <OESystem_OEColorStop>` object.

   .. ################################################################
      # GetValue
      ################################################################

   .. oe:method:: GetValue

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

         .. oe:api::

            double GetValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetValue() -> float

      Returns the value stored in the :ref:`OEColorStop <OESystem_OEColorStop>`
      object.
