.. oe:namespace:: OESystem



.. meta::
   :keywords: OELinearColorGradient, LinearColorGradient


.. _OESystem_OELinearColorGradient:

.. oe:class:: OELinearColorGradient

   .. oe:api::

      class OELinearColorGradient : public OEColorGradientBase

   The :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` class interpolates between colors that
   are defined by using the OEColorStop class.
   See :ref:`Figure Example of linear color gradient<figure_OELinearColorGradient>`

   .. _figure_OELinearColorGradient:

   .. figure:: ../images/OELinearColorGradient.*
      :align:  center

      **Example of linear color gradient** with (-1.0, OERed), (0.0,
      OEWhite) and (+1.0, OEBlue) color stops

   .. seealso::

      * :ref:`OEColorStop <OESystem_OEColorStop>` class
      * :ref:`OEExponentColorGradient <OESystem_OEExponentColorGradient>` class
      * :ref:`OEExponentialColorGradient <OESystem_OEExponentialColorGradient>` class
      * :ref:`OELogarithmicColorGradient <OESystem_OELogarithmicColorGradient>` class


   The following methods are publicly inherited from :ref:`OEColorGradientBase <OESystem_OEColorGradientBase>`:

   ======================================================================= ======================================================================= ========================================================================
   :oe:meth:`operator=<OESystem::OEColorGradientBase::operator=>`          :oe:meth:`GetMaxColor<OESystem::OEColorGradientBase::GetMaxColor>`      :oe:meth:`GetStops<OESystem::OEColorGradientBase::GetStops>`            
   :oe:meth:`AddStop<OESystem::OEColorGradientBase::AddStop>`              :oe:meth:`GetMaxValue<OESystem::OEColorGradientBase::GetMaxValue>`      :oe:meth:`IsEmpty<OESystem::OEColorGradientBase::IsEmpty>`              
   :oe:meth:`DeleteStop<OESystem::OEColorGradientBase::DeleteStop>`        :oe:meth:`GetMinColor<OESystem::OEColorGradientBase::GetMinColor>`      :oe:meth:`NumStops<OESystem::OEColorGradientBase::NumStops>`            
   :oe:meth:`GetColorAt<OESystem::OEColorGradientBase::GetColorAt>`        :oe:meth:`GetMinValue<OESystem::OEColorGradientBase::GetMinValue>`      :oe:meth:`TransformValue<OESystem::OEColorGradientBase::TransformValue>`
   ======================================================================= ======================================================================= ========================================================================


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

   .. oe:method:: Constructors

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

         .. oe:api::

            OELinearColorGradient()

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient() -> OELinearColorGradient

      Default constructor that creates an "empty" color gradient.

      .. note::

         An "empty" color gradient always returns the :oe:const:`OEBlack<OESystem::OESystem::OEBlack>`
         color, when calling the :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`,
         the :oe:meth:`OESystem::OEColorGradientBase::GetMinColor` or
         the :oe:meth:`OESystem::OEColorGradientBase::GetMaxColor` methods.


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

         .. oe:api::

            OELinearColorGradient(const OEColorStop& oneStop)

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient(oneStop: OEColorStop) -> OELinearColorGradient

      Creates an :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` object with
      one color stop. An :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>`
      object that has only one color stop will always return that
      color when calling the
      :oe:meth:`OESystem::OEColorGradientBase::GetColorAt` method.


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

         .. oe:api::

            OELinearColorGradient(const OEColorStop& bgnStop,
                                  const OEColorStop& endStop)

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient(bgnStop: OEColorStop, endStop: OEColorStop) -> OELinearColorGradient

      Creates an :ref:`OELinearColorGradient <OESystem_OELinearColorGradient>` object with
      interpolation range between the two specified color stops.


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

         .. oe:api::

            OELinearColorGradient(const OELinearColorGradient& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OELinearColorGradient(rhs: OELinearColorGradient) -> OELinearColorGradient

      Copy constructor.


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

      .. oe:api::

         OELinearColorGradient &operator=(const OELinearColorGradient &rhs)

      Assignment operator.


   .. oe:method:: TransformValue

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

         .. oe:api::

            double TransformValue(double value) const

      .. oe:language:: python

         .. oe:api:: python

            TransformValue(value: float) -> float

      Performs a :math:`f(x) = x` linear transformation.
      This method is called by :oe:meth:`OESystem::OEColorGradientBase::GetColorAt`
      method to transform a value before performing color interpolation.
