.. oe:namespace:: OESystem



.. meta::
   :keywords: OEAnnotation, Annotation


.. _OESystem_OEAnnotation:

.. oe:class:: OEAnnotation

   .. oe:api::


      class OEAnnotation : public OESystem::OEBase

   This class represents `OEAnnotation`.

   The following methods are publicly inherited from :ref:`OEBase <OESystem_OEBase>`:

   ======================================================== ========================================================= =========================================================
   :oe:meth:`operator=<OESystem::OEBase::operator=>`        :oe:meth:`GetData<OESystem::OEBase::GetData>`             :oe:meth:`IsDataType<OESystem::OEBase::IsDataType>`      
   :oe:meth:`operator+=<OESystem::OEBase::operator+=>`      :oe:meth:`GetDataIter<OESystem::OEBase::GetDataIter>`     :oe:meth:`SetBaseData<OESystem::OEBase::SetBaseData>`    
   :oe:meth:`AddBaseData<OESystem::OEBase::AddBaseData>`    :oe:meth:`GetDataType<OESystem::OEBase::GetDataType>`     :oe:meth:`SetBoolData<OESystem::OEBase::SetBoolData>`    
   :oe:meth:`AddData<OESystem::OEBase::AddData>`            :oe:meth:`GetDoubleData<OESystem::OEBase::GetDoubleData>` :oe:meth:`SetData<OESystem::OEBase::SetData>`            
   :oe:meth:`Clear<OESystem::OEBase::Clear>`                :oe:meth:`GetFloatData<OESystem::OEBase::GetFloatData>`   :oe:meth:`SetDoubleData<OESystem::OEBase::SetDoubleData>`
   :oe:meth:`CreateCopy<OESystem::OEBase::CreateCopy>`      :oe:meth:`GetIntData<OESystem::OEBase::GetIntData>`       :oe:meth:`SetFloatData<OESystem::OEBase::SetFloatData>`  
   :oe:meth:`DeleteData<OESystem::OEBase::DeleteData>`      :oe:meth:`GetStringData<OESystem::OEBase::GetStringData>` :oe:meth:`SetIntData<OESystem::OEBase::SetIntData>`      
   :oe:meth:`GetBoolData<OESystem::OEBase::GetBoolData>`    :oe:meth:`HasData<OESystem::OEBase::HasData>`             :oe:meth:`SetStringData<OESystem::OEBase::SetStringData>`
   ======================================================== ========================================================= =========================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAnnotation()
            OEAnnotation(const OEAnnotation& rhs)
            OEAnnotation(unsigned int type, const char* title = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEAnnotation() -> OEAnnotation
            OEAnnotation(type: int, title: str = None) -> OEAnnotation
            OEAnnotation(rhs: OEAnnotation) -> OEAnnotation

      Default and copy constructors.

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

      .. oe:api::

         OEAnnotation &operator=(const OEAnnotation &rhs)

      Assignment operator.


   .. oe:method:: AddChild

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

         .. oe:api::

            void AddChild(const OEAnnotation& child)

      .. oe:language:: python

         .. oe:api:: python

            AddChild(child: OEAnnotation) -> None

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBase

   .. oe:method:: GetChildren

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

         .. oe:api::

            OESystem::OEIterBase<OEAnnotation>* GetChildren() const

      .. oe:language:: python

         .. oe:api:: python

            GetChildren() -> Iterable[OEAnnotation]

   .. oe:method:: GetColor

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

         .. oe:api::

            OESystem::OEColor GetColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetColor() -> OEColor

   .. oe:method:: GetDataType

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

         .. oe:api::

            const void* GetDataType() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataType() -> void

   .. oe:method:: GetRenderHint

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

         .. oe:api::

            unsigned int GetRenderHint() const

      .. oe:language:: python

         .. oe:api:: python

            GetRenderHint() -> int

   .. oe:method:: GetTitle

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

         .. oe:api::

            const char* GetTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetTitle() -> str

   .. oe:method:: GetType

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

         .. oe:api::

            unsigned int GetType() const

      .. oe:language:: python

         .. oe:api:: python

            GetType() -> int

   .. oe:method:: IsDataType

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

         .. oe:api::

            bool IsDataType(const void* type) const

      .. oe:language:: python

         .. oe:api:: python

            IsDataType(type: void) -> bool

   .. oe:method:: SetColor

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

         .. oe:api::

            OEAnnotation& SetColor(const OESystem::OEColor &)

      .. oe:language:: python

         .. oe:api:: python

            SetColor(arg2: OEColor) -> OEAnnotation

   .. oe:method:: SetRenderHint

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

         .. oe:api::

            OEAnnotation& SetRenderHint(unsigned int hint)

      .. oe:language:: python

         .. oe:api:: python

            SetRenderHint(hint: int) -> OEAnnotation

   .. oe:method:: SetTitle

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

         .. oe:api::

            void SetTitle(const char *)

      .. oe:language:: python

         .. oe:api:: python

            SetTitle(arg2: str) -> None

   .. oe:method:: SetType

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

         .. oe:api::

            void SetType(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            SetType(type: int) -> None

