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

.. oe:namespace:: OEGrapheme


.. _OEGrapheme_OEShapeQueryDisplay:

.. oe:class:: OEShapeQueryDisplay

   .. oe:api::

      class OEShapeQueryDisplay

   This class represents :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` that
   stores the depiction information of a shape query *i.e.* shape reference 
   molecule.
   See example in :ref:`Figure: Example of depicting a shape query<figure_OEShapeQueryDisplay>`.

   .. seealso::

      * The Theory chapter of the **Shape TK** manual.
      * :oe:func:`OEGrapheme::OERenderShapeQuery` function

   .. _figure_OEShapeQueryDisplay:

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

      **Example of depicting a shape query**

   .. admonition:: Code Example

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEShape::OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cff: OEColorForceField) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with default depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap. 

      *cff*
         The :ref:`OEColorForceField <OEShape_OEColorForceField>` object that defines
         various chemical centers and their interactions. 

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

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEShape::OEColorForceField& cff,
                                const OEShapeQueryDisplayOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cff: OEColorForceField,
                                opts: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with given depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap. 

      *cff*
         The :ref:`OEColorForceField <OEShape_OEColorForceField>` object that defines
         various chemical centers and their interactions. 

      *opts*
        The :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>` object
        that defines how the shape query *i.e.* reference molecule 
        is depicted.

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

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEColorForceFieldDisplay& cffdisp)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cffdisp: OEColorForceFieldDisplay) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with default depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap.

      *cffdisp*
         The :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` object that
         stores the depiction information of an
         :ref:`OEColorForceField <OEShape_OEColorForceField>` object.

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

         .. oe:api::

            OEShapeQueryDisplay(const OEChem::OEMolBase& refmol,
                                const OEColorForceFieldDisplay& cffdisp,
                                const OEShapeQueryDisplayOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                                cffdisp: OEColorForceFieldDisplay,
                                opts: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplay

      Constructs an :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      with given depiction options.

      *refmol*
         The **3D** reference molecule of the shape overlap.

      *cffdisp*
         The :ref:`OEColorForceFieldDisplay <OEGrapheme_OEColorForceFieldDisplay>` object that
         stores the depiction information of an
         :ref:`OEColorForceField <OEShape_OEColorForceField>` object.

      *opts*
        The :ref:`OEShapeQueryDisplayOptions <OEGrapheme_OEShapeQueryDisplayOptions>` object
        that defines how the shape query *i.e.* reference molecule
        is depicted.

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

         .. oe:api::

            OEShapeQueryDisplay(const OEShapeQueryDisplay& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeQueryDisplay(rhs: OEShapeQueryDisplay) -> OEShapeQueryDisplay

      Copy constructor.

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

      .. oe:api::

         OEShapeQueryDisplay &operator=(const OEShapeQueryDisplay &rhs)

      Assignment operator.


   .. oe:method:: GetTitle

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

         .. oe:api::

            std::string GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

      Returns the title of the molecule the
      :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object was initialized.


   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEShapeQueryDisplay <OEGrapheme_OEShapeQueryDisplay>` object
      was initialized successfully.
      If initialization was attempted with either an empty molecule or a
      molecule without 3D coordinates, then this method returns false.
