.. oe:namespace:: OEGrapheme



.. meta::
   :keywords: OEAlignedDepictionFrom3DOptions, AlignedDepictionFrom3DOptions


.. _OEGrapheme_OEAlignedDepictionFrom3DOptions:

.. oe:class:: OEAlignedDepictionFrom3DOptions

   .. oe:api::

      class OEAlignedDepictionFrom3DOptions

   This class represents :ref:`OEAlignedDepictionFrom3DOptions <OEGrapheme_OEAlignedDepictionFrom3DOptions>` that
   stores parameters that are used when generating 2D coordinates by
   calling the :oe:func:`OEGrapheme::OEPrepareAlignedDepictionFrom3D` function.

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

      * - Property
        - Get method
        - Set method

      * - clear coords
        - :oe:meth:`GetClearCoords<OEGrapheme::OEAlignedDepictionFrom3DOptions::GetClearCoords>`
        - :oe:meth:`SetClearCoords<OEGrapheme::OEAlignedDepictionFrom3DOptions::SetClearCoords>`

      * - max number of bond rotations
        - :oe:meth:`GetMaxBondRotations<OEGrapheme::OEAlignedDepictionFrom3DOptions::GetMaxBondRotations>`
        - :oe:meth:`SetMaxBondRotations<OEGrapheme::OEAlignedDepictionFrom3DOptions::SetMaxBondRotations>`

      * - suppressing hydrogens
        - :oe:meth:`GetSuppressHydrogens<OEGrapheme::OEAlignedDepictionFrom3DOptions::GetSuppressHydrogens>`
        - :oe:meth:`SetSuppressHydrogens<OEGrapheme::OEAlignedDepictionFrom3DOptions::SetSuppressHydrogens>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEAlignedDepictionFrom3DOptions(bool clearCoords = true,
                                            bool suppressH = true)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignedDepictionFrom3DOptions(clearFitCoords: bool = True,
                                            suppressH: bool = True) -> OEAlignedDepictionFrom3DOptions

      Default constructor that initializes an :ref:`OEAlignedDepictionFrom3DOptions <OEGrapheme_OEAlignedDepictionFrom3DOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of the OEAlignedDepictionFrom3DOptions class**
         :widths: 100 100
         :header-rows: 1

         * - Property
           - Default value

         * - clear coordinates
           - true

         * - max number of bond rotations
           - :math:`2^{16} = 65536`

         * - suppressing hydrogens
           - true

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

         .. oe:api::

            OEAlignedDepictionFrom3DOptions(const OEAlignedDepictionFrom3DOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEAlignedDepictionFrom3DOptions(rhs: OEAlignedDepictionFrom3DOptions) -> OEAlignedDepictionFrom3DOptions

      Copy constructor.


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

      .. oe:api::

         OEAlignedDepictionFrom3DOptions &operator=(const OEAlignedDepictionFrom3DOptions &rhs)

      Assignment operator.


   .. oe:method:: GetClearCoords

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

         .. oe:api::

            bool GetClearCoords() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearCoords() -> bool


      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::SetClearCoords` method


   .. oe:method:: GetMaxBondRotations

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

         .. oe:api::

            unsigned int GetMaxBondRotations() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxBondRotations() -> int

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::SetSuppressHydrogens` method


   .. oe:method:: GetSuppressHydrogens

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

         .. oe:api::

            bool GetSuppressHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetSuppressHydrogens() -> bool

      Returns whether the explicit hydrogens are suppressed in the 
      molecule prior to generating the 2D coordinates.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::SetSuppressHydrogens` method


   .. oe:method:: SetClearCoords

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

         .. oe:api::

            void SetClearCoords(bool clearcoords)

      .. oe:language:: python

         .. oe:api:: python

            SetClearCoords(arg2: bool) -> None

      If false and the fit molecule has 2D coordinates, then these coordinates are
      used for the alignment.
      Otherwise the 2D coordinates of the fitted molecule are generated
      by calling the :oe:func:`OEGrapheme::OEPrepareDepictionFrom3D` function.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::GetClearCoords` method


   .. oe:method:: SetMaxBondRotations

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

         .. oe:api::

            void SetMaxBondRotations(unsigned int maxrotations)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxBondRotations(arg2: int) -> None

      Sets the maximum number of bond rotations performed during the 
      2D coordinate generation process.

      *maxrotations*

         The zero value means that there is no limit. Upon reaching this limit, 
         the process terminates and returns the "best" aligned 2D coordinates.

      .. hint::

         The default value for maximum number of bond rotations is
         :math:`2^{16} = 65536`. This means that by default only the first
         16 single bonds of the molecule will be rotated to find the "best"
         aligned 2D layout.

         It is recommended to use this parameter if the input 3D molecule has 
         a large number of rotatable bonds.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::GetMaxBondRotations` method


   .. oe:method:: SetSuppressHydrogens

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

         .. oe:api::

            void SetSuppressHydrogens(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSuppressHydrogens(arg2: bool) -> None

      Sets whether the explicit hydrogens are suppressed in the
      molecule prior to generating the 2D coordinates.
      Only hydrogens that are necessary to faithfully represent tetrahedral
      stereochemistry will be kept.

      .. seealso::

         * :oe:meth:`OEGrapheme::OEAlignedDepictionFrom3DOptions::GetSuppressHydrogens` method

