.. oe:namespace:: OESzmap

.. meta::
   :keywords: OEIsClashing

.. oe:function:: OEIsClashing

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

      .. oe:api::

         bool OEIsClashing(OESzmap::OESzmapEngine& szmap, const float* xyz)
         bool OEIsClashing(OESzmap::OESzmapEngine& szmap, const double* xyz)

   .. oe:language:: python

      .. oe:api:: python

         OEIsClashing(szmap: OESzmapEngine, xyz: OEFloatArray) -> bool
         OEIsClashing(szmap: OESzmapEngine, xyz: OEDoubleArray) -> bool


   Determines whether the probe associated with the :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` provided
   *clashes* with the context molecule at the specified 3D point. A *clash* means
   every orientation of the probe had a combined
   :oe:const:`OESzmap::OEComponent::Interaction` + :oe:const:`OESzmap::OEComponent::VDW`
   energy total greater than the cutoff defined in the
   :ref:`OESzmapEngine <OESzmap_OESzmapEngine>` at the specified point.
   See :oe:meth:`OESzmap::OESzmapEngineOptions::GetMaskCutoff` and
   :oe:meth:`OESzmap::OESzmapEngineOptions::SetMaskCutoff`.

   The 3D point is a float or double array of size three with coordinates in {x,y,z} order.

   It is recommended you call this function before calling
   :oe:func:`OESzmap::OECalcSzmapValue` or :oe:func:`OESzmap::OECalcSzmapResults`,
   as data for clashing points is generally meaningless.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`


   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-CALC-SZMAP-RESULTS

   .. seealso::

      * :ref:`GetSzmapEnergies<szmap_examples_szmapenergies>` example
      * :ref:`SzmapBestOrientations<szmap_examples_szmapbestorientations>` example

