.. oe:namespace:: OEDepict


.. meta::
   :keywords: OEAtomDisplayBase, AtomDisplayBase


.. _OEDepict_OEAtomDisplayBase:

.. oe:class:: OEAtomDisplayBase

   .. oe:api::

      class OEAtomDisplayBase : public OESystem::OEBase

   The :ref:`OEAtomDisplayBase <OEDepict_OEAtomDisplayBase>` class is the abstract
   interface for representing atom display information 
   within **OEDepict TK**.
   See :ref:`Figure: OEDepict TK atom display class hierarchy<figure_OEAtomDisplayBase_Hierarchy>`.

   .. _figure_OEAtomDisplayBase_Hierarchy:

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

      **OEDepict TK atom display class hierarchy**

   The following classes derive from this class:
    * :ref:`OE2DAtomDisplay <OEDepict_OE2DAtomDisplay>`

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

      .. oe:api::

         OEAtomDisplayBase & operator=(const OEAtomDisplayBase &)

      Assignment operator.


   .. ################################################################
      # GetDataType
      ################################################################

   .. oe:method:: GetDataType

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

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

      This function is used to perform run-time type
      identification.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::GetDataType` method in the **OEChem TK** manual


   .. ################################################################
      # GetAtom
      ################################################################

   .. oe:method:: GetAtom

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

         .. oe:api::

            const OEChem::OEAtomBase* GetAtom() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtom() -> OEAtomBase

      Returns the const pointer of the :ref:`OEAtomBase <OEChem_OEAtomBase>`
      object for which display properties are stored in the class derived
      from the :ref:`OEAtomDisplayBase <OEDepict_OEAtomDisplayBase>` abstract class.


   .. ################################################################
      # IsDataType
      ################################################################

   .. oe:method:: IsDataType

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

         .. oe:api::

            bool IsDataType(const void *) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(arg2: void) -> bool

      Returns whether type is the same as the instance this method is  
      called on.

      .. seealso::

         * :oe:meth:`OESystem::OEBase::IsDataType` method in the **OEChem TK** manual


   .. ################################################################
      # IsVisible
      ################################################################

   .. oe:method:: IsVisible

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

         .. oe:api::

            bool IsVisible() const

      .. oe:language:: python

         .. oe:api:: python

            IsVisible() -> bool

      Returns whether or not the atom is depicted (*i.e.* visible).


   .. ################################################################
      # SetVisible
      ################################################################

   .. oe:method:: SetVisible

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

         .. oe:api::

            void SetVisible(bool visible)

      .. oe:language:: python

         .. oe:api:: python

            SetVisible(visible: bool) -> None

      Sets the visibility of an atom.
