.. include:: ../../common/cookbook/cookbook-hyperlinks

.. oe:namespace:: OEGrapheme

.. meta::
   :keywords: OEShapeQueryDisplayOptions, ShapeQueryDisplayOptions


.. _OEGrapheme_OEShapeQueryDisplayOptions:

.. oe:class:: OEShapeQueryDisplayOptions

   .. oe:api::

      class OEShapeQueryDisplayOptions : public OEDepict::OE2DMolDisplayOptions

   This class represents :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>`
   that encapsulates properties that determine how the reference molecule
   of a shape overlap is depicted by the :oe:func:`OEGrapheme::OERenderShapeQuery` function.

   .. seealso::

      * :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` class
      * :oe:func:`OEGrapheme::OERenderShapeQuery` function

   .. admonition:: Code Example

      * `Visualizing Shape and Color Overlap`_ **OpenEye Python Cookbook** recipe

   The following methods are publicly inherited from :ref:`OE2DMolDisplayOptions <OEDepict_OE2DMolDisplayOptions>`:

   ====================================================================================================== ====================================================================================================== ======================================================================================================
   :oe:meth:`operator=<OEDepict::OE2DMolDisplayOptions::operator=>`                                       :oe:meth:`GetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::GetHydrogenStyle>`                         :oe:meth:`SetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineAtomLabelGapScale>`
   :oe:meth:`GetAromaticStyle<OEDepict::OE2DMolDisplayOptions::GetAromaticStyle>`                         :oe:meth:`GetMargin<OEDepict::OE2DMolDisplayOptions::GetMargin>`                                       :oe:meth:`SetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::SetBondLineGapScale>`
   :oe:meth:`GetAtomColor<OEDepict::OE2DMolDisplayOptions::GetAtomColor>`                                 :oe:meth:`GetScale<OEDepict::OE2DMolDisplayOptions::GetScale>`                                         :oe:meth:`SetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFont>`
   :oe:meth:`GetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::GetAtomColorStyle>`                       :oe:meth:`GetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetSuperAtomLabelFont>`               :oe:meth:`SetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetBondPropLabelFontScale>`
   :oe:meth:`GetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFont>`                         :oe:meth:`GetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::GetSuperAtomStyle>`                       :oe:meth:`SetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetBondPropertyFunctor>`
   :oe:meth:`GetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomLabelFontScale>`               :oe:meth:`GetTitleFont<OEDepict::OE2DMolDisplayOptions::GetTitleFont>`                                 :oe:meth:`SetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::SetBondStereoStyle>`
   :oe:meth:`GetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFont>`                 :oe:meth:`GetTitleFontScale<OEDepict::OE2DMolDisplayOptions::GetTitleFontScale>`                       :oe:meth:`SetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::SetBondWidthScaling>`
   :oe:meth:`GetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetAtomPropLabelFontScale>`       :oe:meth:`GetTitleHeight<OEDepict::OE2DMolDisplayOptions::GetTitleHeight>`                             :oe:meth:`SetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::SetDefaultBondPen>`
   :oe:meth:`GetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetAtomPropertyFunctor>`             :oe:meth:`GetTitleLocation<OEDepict::OE2DMolDisplayOptions::GetTitleLocation>`                         :oe:meth:`SetDimensions<OEDepict::OE2DMolDisplayOptions::SetDimensions>`
   :oe:meth:`GetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::GetAtomStereoStyle>`                     :oe:meth:`GetWidth<OEDepict::OE2DMolDisplayOptions::GetWidth>`                                         :oe:meth:`SetHeight<OEDepict::OE2DMolDisplayOptions::SetHeight>`
   :oe:meth:`GetBackgroundColor<OEDepict::OE2DMolDisplayOptions::GetBackgroundColor>`                     :oe:meth:`SetAromaticStyle<OEDepict::OE2DMolDisplayOptions::SetAromaticStyle>`                         :oe:meth:`SetHydrogenStyle<OEDepict::OE2DMolDisplayOptions::SetHydrogenStyle>`
   :oe:meth:`GetBondColorStyle<OEDepict::OE2DMolDisplayOptions::GetBondColorStyle>`                       :oe:meth:`SetAtomColor<OEDepict::OE2DMolDisplayOptions::SetAtomColor>`                                 :oe:meth:`SetMargin<OEDepict::OE2DMolDisplayOptions::SetMargin>`
   :oe:meth:`GetBondLineAtomLabelGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineAtomLabelGapScale>` :oe:meth:`SetAtomColorStyle<OEDepict::OE2DMolDisplayOptions::SetAtomColorStyle>`                       :oe:meth:`SetMargins<OEDepict::OE2DMolDisplayOptions::SetMargins>`
   :oe:meth:`GetBondLineGapScale<OEDepict::OE2DMolDisplayOptions::GetBondLineGapScale>`                   :oe:meth:`SetAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFont>`                         :oe:meth:`SetScale<OEDepict::OE2DMolDisplayOptions::SetScale>`
   :oe:meth:`GetBondPropLabelFont<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFont>`                 :oe:meth:`SetAtomLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomLabelFontScale>`               :oe:meth:`SetSuperAtomLabelFont<OEDepict::OE2DMolDisplayOptions::SetSuperAtomLabelFont>`
   :oe:meth:`GetBondPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::GetBondPropLabelFontScale>`       :oe:meth:`SetAtomPropLabelFont<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFont>`                 :oe:meth:`SetSuperAtomStyle<OEDepict::OE2DMolDisplayOptions::SetSuperAtomStyle>`
   :oe:meth:`GetBondPropertyFunctor<OEDepict::OE2DMolDisplayOptions::GetBondPropertyFunctor>`             :oe:meth:`SetAtomPropLabelFontScale<OEDepict::OE2DMolDisplayOptions::SetAtomPropLabelFontScale>`       :oe:meth:`SetTitleFont<OEDepict::OE2DMolDisplayOptions::SetTitleFont>`
   :oe:meth:`GetBondStereoStyle<OEDepict::OE2DMolDisplayOptions::GetBondStereoStyle>`                     :oe:meth:`SetAtomPropertyFunctor<OEDepict::OE2DMolDisplayOptions::SetAtomPropertyFunctor>`             :oe:meth:`SetTitleFontScale<OEDepict::OE2DMolDisplayOptions::SetTitleFontScale>`
   :oe:meth:`GetBondWidthScaling<OEDepict::OE2DMolDisplayOptions::GetBondWidthScaling>`                   :oe:meth:`SetAtomStereoStyle<OEDepict::OE2DMolDisplayOptions::SetAtomStereoStyle>`                     :oe:meth:`SetTitleHeight<OEDepict::OE2DMolDisplayOptions::SetTitleHeight>`
   :oe:meth:`GetDefaultBondPen<OEDepict::OE2DMolDisplayOptions::GetDefaultBondPen>`                       :oe:meth:`SetBackgroundColor<OEDepict::OE2DMolDisplayOptions::SetBackgroundColor>`                     :oe:meth:`SetTitleLocation<OEDepict::OE2DMolDisplayOptions::SetTitleLocation>`
   :oe:meth:`GetHeight<OEDepict::OE2DMolDisplayOptions::GetHeight>`                                       :oe:meth:`SetBondColorStyle<OEDepict::OE2DMolDisplayOptions::SetBondColorStyle>`                       :oe:meth:`SetWidth<OEDepict::OE2DMolDisplayOptions::SetWidth>`
   ====================================================================================================== ====================================================================================================== ======================================================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEShapeQueryDisplayOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplayOptions() -> OEShapeQueryDisplayOptions

      Default constructor.

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

         .. oe:api::

            OEShapeQueryDisplayOptions(const OEShapeQueryDisplayOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplayOptions(rhs: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplayOptions

      Copy constructors.


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

      .. oe:api::

         OEShapeQueryDisplayOptions &operator=(const OEShapeQueryDisplayOptions &rhs)

      Assignment operator.


   .. oe:method:: ClearSurfaceArcFxn

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

         .. oe:api::

            void ClearSurfaceArcFxn()

      .. oe:language:: python

         .. oe:api:: python

            ClearSurfaceArcFxn() -> None

      Removes the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetSurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetSurfaceArcFxn`


   .. oe:method:: GetClearBackground

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

         .. oe:api::

            bool GetClearBackground() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearBackground() -> bool

      Returns whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape query.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetClearBackground`


   .. oe:method:: GetColorAtomStyle

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

         .. oe:api::

            unsigned int GetColorAtomStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorAtomStyle() -> int

      Returns the style that is used to define how color atoms are depicted
      by the :oe:func:`OEGrapheme::OERenderShapeQuery` function.
      The return value is taken from the :oe:constns:`OEGrapheme::OEColorAtomStyle`
      namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetColorAtomStyle`
         * :oe:constns:`OEGrapheme::OEColorAtomStyle` namespace


   .. oe:method:: GetDepictOrientation

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

         .. oe:api::

            unsigned int GetDepictOrientation() const

      .. oe:language:: python

         .. oe:api:: python

            GetDepictOrientation() -> int

      Returns the preferred orientation of 2D layout if the shape query.
      The return value is taken from the
      :oe:constns:`OEDepict::OEDepictOrientation` namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetDepictOrientation` method


   .. oe:method:: GetSurfaceArcFxn

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

         .. oe:api::

            const OESurfaceArcFxnBase* GetSurfaceArcFxn() const

      .. oe:language:: python

         .. oe:api:: python

            GetSurfaceArcFxn() -> OESurfaceArcFxnBase

      Returns the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::ClearSurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::SetSurfaceArcFxn`


   .. oe:method:: SetClearBackground

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

         .. oe:api::

            void SetClearBackground(bool clear)

      .. oe:language:: python

         .. oe:api:: python

            SetClearBackground(clear: bool) -> None

      Sets whether or not the image is cleared
      (by calling :oe:meth:`OEDepict::OEImageBase::Clear` method)
      prior to the rendering of the shape query.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetClearBackground`


   .. oe:method:: SetColorAtomStyle

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

         .. oe:api::

            void SetColorAtomStyle(unsigned int style)

      .. oe:language:: python

         .. oe:api:: python

            SetColorAtomStyle(style: int) -> None

      Sets the style that defines how color atoms are
      depicted by the :oe:func:`OEGrapheme::OERenderShapeQuery` function.

      *style*
         This value has to be from the :oe:constns:`OEGrapheme::OEColorAtomStyle`
         namespace.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetColorAtomStyle`
         * :oe:constns:`OEGrapheme::OEColorAtomStyle` namespace

   .. oe:method:: SetDepictOrientation

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

         .. oe:api::

            void SetDepictOrientation(unsigned int orientation)

      .. oe:language:: python

         .. oe:api:: python

            SetDepictOrientation(arg2: int) -> None

      Sets the preferred orientation of 2D layout of the shape query.

      *orientation*
         This value has to be from the :oe:constns:`OEDepict::OEDepictOrientation`
         namespace.

      .. note::

         Changing the orientation of the layout of the shape query consequently effects
         the orientation of the shape and color overlaps mapped to the given shape query.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetDepictOrientation` method
         * :oe:constns:`OEDepict::OEDepictOrientation` namespace


   .. oe:method:: SetSurfaceArcFxn

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

         .. oe:api::

            void SetSurfaceArcFxn(const OESurfaceArcFxnBase& arcfxn)

      .. oe:language:: python

         .. oe:api:: python

            SetSurfaceArcFxn(arcfxn: OESurfaceArcFxnBase) -> None

      Sets the surface drawing functor that is drawn to represent the 2D
      molecule surface of the reference molecule when calling the
      :oe:func:`OEGrapheme::OERenderShapeQuery` function.


      .. seealso::

         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::ClearSurfaceArcFxn`
         * :oe:meth:`OEGrapheme::OEShapeQueryDisplayOptions::GetSurfaceArcFxn`

