.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEHighlightByCogwheel, HighlightByCogwheel


.. _OEDepict_OEHighlightByCogwheel:

.. oe:class:: OEHighlightByCogwheel

   .. oe:api::

      class OEHighlightByCogwheel : public OEHighlightBase

   The :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class allows the
   customization of the **cogwheel** highlighting style that is
   associated with the :oe:const:`OEDepict::OEHighlightStyle::Cogwheel`
   constant.
   See example in :ref:`Figure: Example of highlighting using the 'cogwheel' style<figure_OEHighlightStyle_Cogwheel>`.

   .. _figure_OEHighlightStyle_Cogwheel:

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

      **Example of highlighting using the color style**

   The :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` class stores the following properties:

   .. list-table::
      :widths: 100 100 100 150
      :header-rows: 1

      * - Property
        - Get method
        - Set method
        - Corresponding namespace / class / type

      * - atom label
        - :oe:meth:`GetAtomLabelMonochrome<OEDepict::OEHighlightByCogwheel::GetAtomLabelMonochrome>`
        - :oe:meth:`SetAtomLabelMonochrome<OEDepict::OEHighlightByCogwheel::SetAtomLabelMonochrome>`
        - boolean

      * - ball radius scale
        - :oe:meth:`GetBallRadiusScale<OEDepict::OEHighlightByCogwheel::GetBallRadiusScale>`
        - :oe:meth:`SetBallRadiusScale<OEDepict::OEHighlightByCogwheel::SetBallRadiusScale>`
        - floating point number

      * - color
        - :oe:meth:`GetColor<OEDepict::OEHighlightByCogwheel::GetColor>`
        - :oe:meth:`SetColor<OEDepict::OEHighlightByCogwheel::SetColor>`
        - :ref:`OEColor <OESystem_OEColor>`


      * - inner contour
        - :oe:meth:`GetInnerContour<OEDepict::OEHighlightByCogwheel::GetInnerContour>`
        - :oe:meth:`SetInnerContour<OEDepict::OEHighlightByCogwheel::SetInnerContour>`
        - boolean

      * - line width scale
        - :oe:meth:`GetLineWidthScale<OEDepict::OEHighlightByCogwheel::GetLineWidthScale>`
        - :oe:meth:`SetLineWidthScale<OEDepict::OEHighlightByCogwheel::SetLineWidthScale>`
        - floating point number

      * - stick width scale
        - :oe:meth:`GetStickWidthScale<OEDepict::OEHighlightByCogwheel::GetStickWidthScale>`
        - :oe:meth:`SetStickWidthScale<OEDepict::OEHighlightByCogwheel::SetStickWidthScale>`
        - floating point number

   .. seealso::

      * :oe:func:`OEDepict::OEAddHighlighting` function
      * :oe:constns:`OEDepict::OEHighlightStyle` namespace
      * :ref:`OEHighlightByBallAndStick <OEDepict_OEHighlightByBallAndStick>` class
      * :ref:`OEHighlightByColor <OEDepict_OEHighlightByColor>` class
      * :ref:`OEHighlightByLasso <OEDepict_OEHighlightByLasso>` class
      * :ref:`OEHighlightByStick <OEDepict_OEHighlightByStick>` class
      * :ref:`chapter_highlighting` chapter

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHighlightByCogwheel(const OESystem::OEColor& color,
                                  double lineWidthScale = 1.5,
                                  double stickWidthScale = 2.0,
                                  double ballRadiusScale = 2.0,
                                  bool innerContour = true,
                                  bool monochrome = true)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByCogwheel(color: OEColor, lineWidthScale: float = 1.5,
                                  stickWidthScale: float = 2.0,
                                  ballRadiusScale: float = 2.0,
                                  innerContour: bool = True,
                                  monochrome: bool = True) -> OEHighlightByCogwheel

      Creates an :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>` object with the
      specified parameters.

      *color*
         The color used for highlighting.
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetColor` method.

      *lineWidthScale*
         The multiplier that can be used to increase or decrease
         the line width of the 'cogwheel'.
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetLineWidthScale` method.

      *stickWidthScale*
         The multiplier that can be used to increase or decrease
         the stick width of the 'cogwheel' of the highlighted bond(s).
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetStickWidthScale` method.

      *ballRadiusScale*
         The multiplier that can be used to increase or decrease
         the ball radius of the 'cogwheel' of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetBallRadiusScale` method.

      *innerContour*
         Defines whether the inner contour of the 'cogwheel' is drawn or committed.
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetInnerContour` method.

      *monochrome*
         Defines whether or not to change the color of the atom label
         of the highlighted atom(s).
         See also :oe:meth:`OEDepict::OEHighlightByCogwheel::SetAtomLabelMonochrome` method.


      .. ################################################################

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

         .. oe:api::

            OEHighlightByCogwheel(const OEHighlightByCogwheel& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHighlightByCogwheel(rhs: OEHighlightByCogwheel) -> OEHighlightByCogwheel

      Copy constructor.


   .. ################################################################
      # operator=
      ################################################################

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

      .. oe:api::

         OEHighlightByCogwheel &operator=(const OEHighlightByCogwheel &rhs)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEHighlightBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEHighlightByCogwheel

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEHighlightByCogwheel <OEDepict_OEHighlightByCogwheel>`
      object is dynamically allocated and owned by the caller.


   .. oe:method:: GetAtomLabelMonochrome

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

         .. oe:api::

            bool GetAtomLabelMonochrome() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomLabelMonochrome() -> bool

      Returns whether or not the color of the atom label of the highlighted
      atom(s) is changed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetAtomLabelMonochrome` method


   .. oe:method:: GetBallRadiusScale

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

         .. oe:api::

            double GetBallRadiusScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetBallRadiusScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the ball radius of the 'cogwheel' of the highlighted atom(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetBallRadiusScale` method


   .. oe:method:: GetColor

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

         .. oe:api::

            const OESystem::OEColor& GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

      Returns the color of the highlighting.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class


   .. oe:method:: GetInnerContour

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

         .. oe:api::

            bool GetInnerContour() const

      .. oe:language:: python

         .. oe:api:: python

            GetInnerContour() -> bool

      Returns whether the inner contour of the 'cogwheel' is drawn or committed.

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetInnerContour` method


   .. oe:method:: GetLineWidthScale

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

         .. oe:api::

            double GetLineWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetLineWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the line width of the 'cogwheel'

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetLineWidthScale` method


   .. oe:method:: GetStickWidthScale

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

         .. oe:api::

            double GetStickWidthScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetStickWidthScale() -> float

      Returns the multiplier that can be used to increase or decrease
      the stick width of the 'cogwheel' of the highlighted bond(s).

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::SetStickWidthScale` method


   .. oe:method:: SetAtomLabelMonochrome

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

         .. oe:api::

            void SetAtomLabelMonochrome(bool monochrome)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomLabelMonochrome(monochrome: bool) -> None

      Sets whether or not to change the color of the atom label
      of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetAtomLabelMonochrome method<figure_OEHighlightByCogwheel_SetAtomLabelMonochrome>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETATOMLABELMONOCHROME


      .. _figure_OEHighlightByCogwheel_SetAtomLabelMonochrome:

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

         **Example of using the SetAtomLabelMonochrome method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetAtomLabelMonochrome` method


   .. oe:method:: SetBallRadiusScale

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

         .. oe:api::

            void SetBallRadiusScale(double ballRadiusScale)

      .. oe:language:: python

         .. oe:api:: python

            SetBallRadiusScale(ballRadiusScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the ball radius of the 'cogwheel' of the highlighted atom(s).

      Example (:ref:`Figure: Example of using the SetBallRadiusScale method<figure_OEHighlightByCogwheel_SetBallRadiusScale>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETBALLRADIUSSCALE


      .. _figure_OEHighlightByCogwheel_SetBallRadiusScale:

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

         **Example of using the SetBallRadiusScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetBallRadiusScale` method


   .. oe:method:: SetColor

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

         .. oe:api::

            void SetColor(const OESystem::OEColor& color)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(color: OEColor) -> None

      Sets the color of the highlighting.

      Example (:ref:`Figure: Example of using the SetColor method<figure_OEHighlightByCogwheel_SetColor>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETCOLOR


      .. _figure_OEHighlightByCogwheel_SetColor:

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

         **Example of using the SetColor method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetColor` method
         * :ref:`OEColor <OESystem_OEColor>` class


   .. oe:method:: SetInnerContour

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

         .. oe:api::

            void SetInnerContour(bool innerContour)

      .. oe:language:: python

         .. oe:api:: python

            SetInnerContour(innerContour: bool) -> None

      Sets whether the inner contour of the 'cogwheel' is drawn or omitted.

      Example (:ref:`Figure: Example of using the SetInnerContour method<figure_OEHighlightByCogwheel_SetInnerContour>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETINNERCONTOUR


      .. _figure_OEHighlightByCogwheel_SetInnerContour:

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

         **Example of using the SetInnerContour method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetInnerContour` method


   .. oe:method:: SetLineWidthScale

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

         .. oe:api::

            void SetLineWidthScale(double lineWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetLineWidthScale(lineWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the line width of the 'cogwheel'

      Example (:ref:`Figure: Example of using the SetLineWidthScale method<figure_OEHighlightByCogwheel_SetLineWidthScale>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETLINEWIDTHSCALE


      .. _figure_OEHighlightByCogwheel_SetLineWidthScale:

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

         **Example of using the SetLineWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetLineWidthScale` method


   .. oe:method:: SetStickWidthScale

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

         .. oe:api::

            void SetStickWidthScale(double stickWidthScale)

      .. oe:language:: python

         .. oe:api:: python

            SetStickWidthScale(stickWidthScale: float) -> None

      Sets the multiplier that can be used to increase or decrease
      the stick width of the 'cogwheel' of the highlighted bond(s).

      Example (:ref:`Figure: Example of using the SetStickWidthScale method<figure_OEHighlightByCogwheel_SetStickWidthScale>`)

      .. oe:source:: HighlightByCogwheel.py
         :language: python
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.java
         :language: java
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE

      .. oe:source:: HighlightByCogwheel.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-OEHIGHLIGHTBYCOGWHEEL-SETSTICKWIDTHSCALE


      .. _figure_OEHighlightByCogwheel_SetStickWidthScale:

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

         **Example of using the SetStickWidthScale method**

      .. seealso::

         * :oe:meth:`OEDepict::OEHighlightByCogwheel::GetStickWidthScale` method
