.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEShape

.. meta::
   :keywords: OEShapeOptions, ShapeOptions


.. _OEShape_OEShapeOptions:

.. oe:class:: OEShapeOptions

   .. oe:api::

      class OEShapeOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for :ref:`OEShapeFunc <OEShape_OEShapeFunc>`
   calculations.
   
   The :ref:`OEShapeOptions <OEShape_OEShapeOptions>` class defines the following public methods:
    * :oe:meth:`GetCarbonRadius<OEShape::OEShapeOptions::GetCarbonRadius>`
    * :oe:meth:`GetRadiiApproximation<OEShape::OEShapeOptions::GetRadiiApproximation>` 
    * :oe:meth:`GetScoreType<OEShape::OEShapeOptions::GetScoreType>`
    * :oe:meth:`SetCarbonRadius<OEShape::OEShapeOptions::SetCarbonRadius>`
    * :oe:meth:`SetRadiiApproximation<OEShape::OEShapeOptions::SetRadiiApproximation>` 
    * :oe:meth:`SetScoreType<OEShape::OEShapeOptions::SetScoreType>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEShapeOptions()
            OEShapeOptions(const OEShapeOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEShapeOptions() -> OEShapeOptions
            OEShapeOptions(arg2: OEShapeOptions) -> OEShapeOptions

      Default and copy constructors.

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

      .. oe:api::

         OEShapeOptions &operator=(const OEShapeOptions &)

      Assignment operator.


   .. oe:method:: GetCarbonRadius

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

         .. oe:api::

            double GetCarbonRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetCarbonRadius() -> float

      Gets the radius value for the carbon radius approximation, associated with :oe:const:`OEShape::OEOverlapRadii::Carbon`.

   .. oe:method:: GetRadiiApproximation

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

         .. oe:api::

            unsigned int GetRadiiApproximation() const

      .. oe:language:: python

         .. oe:api:: python

            GetRadiiApproximation() -> int

      Gets the current value of the radii approximation.

   .. oe:method:: GetScoreType

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

         .. oe:api::

            unsigned int GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      Gets the current value of the score type of the function.

   .. oe:method:: SetCarbonRadius

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

         .. oe:api::

            bool SetCarbonRadius(double cradius)

      .. oe:language:: python

         .. oe:api:: python

            SetCarbonRadius(radius: float) -> bool

      Set the radius to use when using :oe:const:`OEShape::OEOverlapRadii::Carbon`. 
      By default this is set to 1.7 |A|.

   .. oe:method:: SetRadiiApproximation

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

         .. oe:api::

            bool SetRadiiApproximation(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetRadiiApproximation(value: int) -> bool

      Set the radius approximation used to calculate overlap. The default is
      :oe:const:`OEShape::OEOverlapRadii::Carbon`. Alternatives are
      defined in the :oe:const:`OEShape::OEOverlapRadii` namespace.

   .. oe:method:: SetScoreType

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

         .. oe:api::

            bool SetScoreType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Set the score type to be reported by this function. The default is
      :oe:const:`OEShape::OEScoreType::Tanimoto`. Alternatives are
      defined in the :oe:constns:`OEShape::OEScoreType` namespace.

