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

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEImageBase, ImageBase


.. _OEDepict_OEImageBase:

.. oe:class:: OEImageBase

   .. oe:api::

      class OEImageBase

   The :ref:`OEImageBase <OEDepict_OEImageBase>` is an abstract class that
   provides methods for drawing basic geometric shapes such as lines,
   circles, rectangles etc.

   The following classes derive from this class:

    * :ref:`OEImage <OEDepict_OEImage>`
    * :ref:`OEImageFrame <OEDepict_OEImageFrame>`

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OEImageBase(double width = 200.0, double height = 200.0)

      .. oe:language:: python

         .. oe:api:: python

            OEImageBase(width: float = 200.0, height: float = 200.0) -> OEImageBase

      Default constructor that creates an image with the specified
      width and height.

      *width, height*
        The dimensions of the image, both have to be positive (non-zero)
        numbers.

   .. ################################################################
      # Clear
      ################################################################

   .. oe:method:: Clear

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

         .. oe:api::

            void Clear(const OESystem::OEColor& color = OESystem::OEWhite)

      .. oe:language:: python

         .. oe:api:: python

            Clear(color: OEColor = OEWhite) -> None

      Clears the image with the given color.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class


   .. ################################################################
      # DrawArc
      ################################################################

   .. oe:method:: DrawArc

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

         .. oe:api::

            void DrawArc(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawArc(c: OE2DPoint, bgnAngle: float, endAngle: float,
                    radius: float, pen: OEPen) -> None

      Draws the outline of an arc.
      See example in :ref:`Figure: Example of arc<figure_OEImageBase_DrawArc>`.

      .. _figure_OEImageBase_DrawArc:

      .. figure:: ../images/OEImageBase-DrawArc.*
         :align:  center
         :scale:  100

         **Example of arc**

      *center*
         The center of the arc.

      *bgnAngle*, *endAngle*
         The two endpoints of the arc (in degrees).
         Both angles are in degrees and their values have to be in a
         range of :math:`[0.0^{\circ}, 360.0^{\circ}]`.
         Angles are interpreted such that :math:`0.0^{\circ}` and
         :math:`360.0^{\circ}` degrees are at the *12 o'clock*
         position, :math:`90.0^{\circ}` degrees corresponds
         to *3 o'clock*, etc.

      *radius*
         The radius of the arc.

      *pen*
         The graphical properties of the curve (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing arcs with various pens<figure_OEImageBase_DrawArc_Pen>`.

      .. _figure_OEImageBase_DrawArc_Pen:

      .. figure:: ../images/OEImageBase-DrawArc-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing arcs with various pens**

      .. note::

         :oe:meth:`OEDepict::OEImageBase::DrawArc` supports all the
         :ref:`OEPen <OEDepict_OEPen>`  properties (i.e. color, line width, line
         stipple) except the fill property.
         See also :oe:meth:`OEDepict::OEImageBase::DrawPie` method.

      Arcs are always drawn in a clockwise direction. This means that
      bgn = :math:`0.0^{\circ}`, end = :math:`90.0^{\circ}` angle pair
      is not the same as bgn = :math:`90.0^{\circ}`, end =
      :math:`0.0^{\circ}` angle pair.
      See examples in :ref:`Table: Example of interpreting the begin and end angles of the arc<table_OEImageBase_DrawArc>`.

      .. _table_OEImageBase_DrawArc:

      .. list-table:: **Example of interpreting the begin and end angles of the arc**
         :widths: 10 10
         :header-rows: 1

         * - bgn = :math:`0.0^{\circ}` end = :math:`90.0^{\circ}`
           - bgn = :math:`90.0^{\circ}` end = :math:`0.0^{\circ}`
         * - .. image:: ../images/OEImageBase-DrawArc-AngleAB.*
               :align:  center
               :scale:  100
           - .. image:: ../images/OEImageBase-DrawArc-AngleBA.*
               :align:  center
               :scale:  100

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. ################################################################
      # DrawCircle
      ################################################################

   .. oe:method:: DrawCircle

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

         .. oe:api::

            void DrawCircle(const OE2DPoint& center, double radius,
                            const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCircle(c: OE2DPoint, radius: float, pen: OEPen) -> None

      Draws a circle.
      See example in :ref:`Figure: Example of circle<figure_OEImageBase_DrawCircle>`.

      .. _figure_OEImageBase_DrawCircle:

      .. figure:: ../images/OEImageBase-DrawCircle.*
         :align:  center

         **Example of circle**

      *center*
         The center of the circle.

      *radius*
         The radius of the circle.

      *pen*
         The graphical properties of the circle (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing circles with various pens<figure_OEImageBase_DrawCircle_Pen>`.

      .. _figure_OEImageBase_DrawCircle_Pen:

      .. figure:: ../images/OEImageBase-DrawCircle-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing circles with various pens**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. ################################################################
      # DrawCubicBezier
      ################################################################

   .. oe:method:: DrawCubicBezier

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

         .. oe:api::

            void DrawCubicBezier(const OE2DPoint& bgn, const OE2DPoint& c1,
                                 const OE2DPoint& c2, const OE2DPoint& end,
                                 const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawCubicBezier(bgn: OE2DPoint, c1: OE2DPoint, c2: OE2DPoint,
                            end: OE2DPoint, pen: OEPen) -> None

      Draws a cubic |Bezier| curve.
      See example in :ref:`Figure: Example of cubic Bezier curve<figure_OEImageBase_DrawCubicBezier>`.

      .. _figure_OEImageBase_DrawCubicBezier:

      .. figure:: ../images/OEImageBase-DrawCubicBezier.*
         :align:  center

         **Example of cubic Bezier curve**

      *bgn, end*
         The end points of the Bezier curve.

      *c1, c2*
         The control points of the curve.

      *pen*
         The graphical properties of the |Bezier| curve (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing cubic Bezier curves with various pens<figure_OEImageBase_DrawCubicBezier_Pen>`.

      .. _figure_OEImageBase_DrawCubicBezier_Pen:

      .. figure:: ../images/OEImageBase-DrawCubicBezier-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing cubic Bezier curves with various pens**

      Example (:ref:`Figure: Example of drawing a cubic Bezier curve<figure_OEImageBase_DrawCubicBezie_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-CUBIC-BEZIER

      .. _figure_OEImageBase_DrawCubicBezie_Example:

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

         **Example of drawing a cubic Bezier curve**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes


   .. ################################################################
      # DrawLine
      ################################################################

   .. oe:method:: DrawLine

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

         .. oe:api::

            void DrawLine(const OE2DPoint& bgn, const OE2DPoint& end,
                          const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawLine(bgn: OE2DPoint, end: OE2DPoint, pen: OEPen) -> None

      Draws a line.
      See example in :ref:`Figure: Example of line<figure_OEImageBase_DrawLine>`.

      .. _figure_OEImageBase_DrawLine:

      .. figure:: ../images/OEImageBase-DrawLine.*
         :align:  center

         **Example of line**

      *bgn*, *end*
         The two endpoints of the line.

      *pen*
         The graphical properties of the line (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing lines with various pens<figure_OEImageBase_DrawLine_Pen>`.

      .. _figure_OEImageBase_DrawLine_Pen:

      .. figure:: ../images/OEImageBase-DrawLine-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing lines with various pens**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # DrawPath
      ################################################################

   .. oe:method:: DrawPath

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

         .. oe:api::

            void DrawPath(const OE2DPath& path, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPath(path: OE2DPath, pen: OEPen) -> None

      Draws as path.
      See example in :ref:`Figure: Example of path<figure_OEImageBase_DrawPath>`.

      .. _figure_OEImageBase_DrawPath:

      .. figure:: ../images/OEImageBase-DrawPath.*
         :align:  center
         :scale:  100

         **Example of path**

      *path*
         The :ref:`OE2DPath <OEDepict_OE2DPath>` object that defines a path as
         a sequence of lines and curves.

      *pen*
         The graphical properties of the pie (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing paths with various pens<figure_OEImageBase_DrawPath_Pen>`.

      .. _figure_OEImageBase_DrawPath_Pen:

      .. figure:: ../images/OEImageBase-DrawPath-Closed-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing paths with various pens**

      Example (:ref:`Figure: Example of drawing a path<figure_OEImageBase_DrawPath_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-DRAW-PATH

      .. _figure_OEImageBase_DrawPath_Example:

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

         **Example of drawing a path**

      .. seealso::

         * :ref:`OE2DPath <OEDepict_OE2DPath>` class
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. ################################################################
      # DrawPie
      ################################################################

   .. oe:method:: DrawPie

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

         .. oe:api::

            void DrawPie(const OE2DPoint& center, double bgnAngle,
                         double endAngle, double radius, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPie(c: OE2DPoint, bgnAngle: float, endAngle: float,
                    radius: float, pen: OEPen) -> None

      Draws a pie.
      See example in :ref:`Figure: Example of drawing a pie<figure_OEImageBase_DrawPie>`.

      .. _figure_OEImageBase_DrawPie:

      .. figure:: ../images/OEImageBase-DrawPie.*
         :align:  center
         :scale:  100

      *center*
         The center of the pie.

      *bgnAngle*, *endAngle*
         The two endpoints of the pie (in degrees).
         Both angles are in degrees and their values have to be in a
         range of :math:`[0.0^{\circ}, 360.0^{\circ}]`.
         Angles are interpreted such that :math:`0.0^{\circ}` and
         :math:`360.0^{\circ}` degrees are at the *12 o'clock*
         position, :math:`90.0^{\circ}` degrees corresponds
         to *3 o'clock*, etc.

      *radius*
         The radius of the pie.

      *pen*
         The graphical properties of the pie (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing pies with various pens<figure_OEImageBase_DrawPie_Pen>`.

      .. _figure_OEImageBase_DrawPie_Pen:

      .. figure:: ../images/OEImageBase-DrawPie-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing pies with various pens**

      Pies are always drawn in a clockwise direction. This means that
      bgn = :math:`0.0^{\circ}`, end = :math:`90.0^{\circ}` angle pair
      is not the same as bgn = :math:`90.0^{\circ}`, end =
      :math:`0.0^{\circ}` angle pair.
      See examples in :ref:`Table: Example of interpreting the begin and end angles of the pie<table_OEImageBase_DrawPie>`.

      .. _table_OEImageBase_DrawPie:

      .. list-table:: **Example of interpreting the begin and end angles of the pie**
         :widths: 10 10
         :header-rows: 1

         * - bgn = :math:`0.0^{\circ}` end = :math:`90.0^{\circ}`
           - bgn = :math:`90.0^{\circ}` end = :math:`0.0^{\circ}`
         * - .. image:: ../images/OEImageBase-DrawPie-AngleAB.*
               :align:  center
               :scale:  100
           - .. image:: ../images/OEImageBase-DrawPie-AngleBA.*
               :align:  center
               :scale:  100

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. ################################################################
      # DrawPoint
      ################################################################

   .. oe:method:: DrawPoint

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

         .. oe:api::

            void DrawPoint(const OE2DPoint& p, const OESystem::OEColor& color) = 0

      .. oe:language:: python

         .. oe:api:: python

            DrawPoint(p: OE2DPoint, color: OEColor) -> None

      Draws a point.
      See example in :ref:`Figure: Example of point<figure_OEImageBase_DrawPoint>`.

      .. _figure_OEImageBase_DrawPoint:

      .. figure:: ../images/OEImageBase-DrawPoint.*
         :align:  center

         **Example of point**

      *p*
         The position of the point, where p = OE2DPoint(x, y).

      *color*
         The color of the point.

      .. seealso::

         * :ref:`OEColor <OESystem_OEColor>` class


   .. ################################################################
      # DrawPolygon
      ################################################################

   .. oe:method:: DrawPolygon

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

         .. oe:api::

            void DrawPolygon(const std::vector<OE2DPoint>& points,
                             const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawPolygon(endPoints: OE2DPointVector, pen: OEPen) -> None

      Draws a closed polygon.
      See example in :ref:`Figure: Example of polygon<figure_OEImageBase_DrawPolygon>`.

      .. _figure_OEImageBase_DrawPolygon:

      .. figure:: ../images/OEImageBase-DrawPolygon.*
         :align:  center

         **Example of polygon**

      *points*
         The series of points that defines the polygon.
         The polygon will be closed *i.e.* the first connected with
         the last point.

      *pen*
         The graphical properties of the polygon (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of polygons lines with various pens<figure_OEImageBase_DrawPolygon_Pen>`.

      .. _figure_OEImageBase_DrawPolygon_Pen:

      .. figure:: ../images/OEImageBase-DrawPolygon-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing polygons with various pens**

      Example (:ref:`Figure: Example of drawing a polygon<figure_OEImageBase_DrawPolygon_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-DRAW-POLYGON

      .. _figure_OEImageBase_DrawPolygon_Example:

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

         **Example of drawing a polygon**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. ################################################################
      # DrawQuadraticBezier
      ################################################################

   .. oe:method:: DrawQuadraticBezier

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

         .. oe:api::

            void DrawQuadraticBezier(const OE2DPoint& bgn, const OE2DPoint& c,
                                     const OE2DPoint& end, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawQuadraticBezier(bgn: OE2DPoint, c1: OE2DPoint, end: OE2DPoint,
                                pen: OEPen) -> None

      Draws a quadratic |Bezier| curve.
      See example in :ref:`Figure: Example of quadratic Bezier curve<figure_OEImageBase_DrawQuadraticBezier>`.

      .. _figure_OEImageBase_DrawQuadraticBezier:

      .. figure:: ../images/OEImageBase-DrawQuadraticBezier.*
         :align:  center

         **Example of quadratic Bezier curve**

      *bgn, end*
         The end points of the |Bezier| curve.

      *c*
         The control point of the curve.

      *pen*
         The graphical properties of the |Bezier| curve (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of drawing quadratic Bezier curves with various pens<figure_OEImageBase_DrawQuadraticBezier_Pen>`.

      .. _figure_OEImageBase_DrawQuadraticBezier_Pen:

      .. figure:: ../images/OEImageBase-DrawQuadraticBezier-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing quadratic Bezier curves with various pens**

      Example (:ref:`Figure: Example of drawing a polygon<figure_OEImageBase_DrawQuadraticBezier_Example>`)

      .. oe:source:: DrawObjects.py
         :language: python
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. oe:source:: DrawObjects.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. oe:source:: DrawObjects.java
         :language: java
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. oe:source:: DrawObjects.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-DRAW-QUADRATIC-BEZIER

      .. _figure_OEImageBase_DrawQuadraticBezier_Example:

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

         **Example of drawing a quadratic Bezier**


      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` classes


   .. ################################################################
      # DrawRectangle
      ################################################################

   .. oe:method:: DrawRectangle

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

         .. oe:api::

            void DrawRectangle(const OE2DPoint& tl, const OE2DPoint& br,
                               const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawRectangle(tl: OE2DPoint, br: OE2DPoint, pen: OEPen) -> None

      Draws a rectangle.
      See example in :ref:`Figure: Example of rectangle<figure_OEImageBase_DrawRectangle>`.

      .. _figure_OEImageBase_DrawRectangle:

      .. figure:: ../images/OEImageBase-DrawRectangle.*
         :align:  center

         **Example of rectangle**

      *tl*
        The top left corner of the rectangle.

      *br*
        The bottom right corner of the rectangle.

      *pen*
         The graphical properties of the rectangle (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of polygons rectangles with various pens<figure_OEImageBase_DrawRectangle_Pen>`.

      .. _figure_OEImageBase_DrawRectangle_Pen:

      .. figure:: ../images/OEImageBase-DrawRectangle-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing rectangles with various pens**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class


   .. ################################################################
      # DrawText
      ################################################################

   .. oe:method:: DrawText

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

         .. oe:api::

            void DrawText(const OE2DPoint& center, const std::string& text,
                          const OEFont& font, double maxwidth = 0.0)

      .. oe:language:: python

         .. oe:api:: python

            DrawText(c: OE2DPoint, text: str, font: OEFont,
                     maxwidth: float = 0.0) -> None

      Draws a text.
      See example in :ref:`Figure: Example of text<figure_OEImageBase_DrawText>`.

      .. _figure_OEImageBase_DrawText:

      .. figure:: ../images/OEImageBase-DrawText.*
         :align:  center

         **Example of text**

      *center*
         The position of the text.

      *text*
         The characters to be displayed.

      *font*
         The graphical properties of the displayed text (such as color,
         font size, etc).
         See examples in :ref:`Figure: Example of drawing texts with various fonts<figure_OEImageBase_DrawText_Font>`.

      *maxwidth*
         If *maxwidth* is specified and the width of the text would exceed
         the given limit, than the size of the font used to display
         the text is automatically reduced.

      .. note::

         The displayed position of the text not only depends on 'c'
         position but also the alignment style of the given
         :ref:`OEFont <OEDepict_OEFont>`.


      .. _figure_OEImageBase_DrawText_Font:

      .. figure:: ../images/OEImageBase-DrawText-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing texts with various fonts**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :oe:constns:`OEDepict::OEAlignment` namespace
         * :ref:`OEFont <OEDepict_OEFont>` class


   .. ################################################################
      # DrawTriangle
      ################################################################

   .. oe:method:: DrawTriangle

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

         .. oe:api::

            void DrawTriangle(const OE2DPoint& a, const OE2DPoint& b,
                              const OE2DPoint& c, const OEPen& pen)

      .. oe:language:: python

         .. oe:api:: python

            DrawTriangle(arg0: OE2DPoint, arg1: OE2DPoint, arg2: OE2DPoint,
                         arg3: OEPen) -> None

      Draws a triangle.
      See example in :ref:`Figure: Example of triangle<figure_OEImageBase_DrawTriangle>`.

      .. _figure_OEImageBase_DrawTriangle:

      .. figure:: ../images/OEImageBase-DrawTriangle.*
         :align:  center

         **Example of triangle**

      *a*, *b*, *c*
        The three corners of the triangle.

      *pen*
         The graphical properties of the triangle (such as color,
         line width, etc).
         See examples in :ref:`Figure: Example of polygons triangles with various pens<figure_OEImageBase_DrawTriangle_Pen>`.

      .. _figure_OEImageBase_DrawTriangle_Pen:

      .. figure:: ../images/OEImageBase-DrawTriangle-Examples.*
         :align:  center
         :scale:  100

         **Example of drawing triangles with various fonts**

      .. seealso::

         * :ref:`OE2DPoint <OEDepict_OE2DPoint>` class
         * :ref:`OEPen <OEDepict_OEPen>` class

   .. ################################################################
      # GetGlobalOffset
      ################################################################

   .. oe:method:: GetGlobalOffset

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

         .. oe:api::

            const OE2DPoint& GetGlobalOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetGlobalOffset() -> OE2DPoint

      Returns the offset from the origin (x=0.0, y=0.0) to the
      top-left corner of the given image.

   .. ################################################################
      # GetHeight
      ################################################################

   .. oe:method:: GetHeight

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

         .. oe:api::

            double GetHeight() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeight() -> float

      Returns the height of the :ref:`OEImageBase <OEDepict_OEImageBase>` object.

   .. ################################################################
      # GetMinFontSize
      ################################################################

   .. oe:method:: GetMinFontSize

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

         .. oe:api::

            unsigned int GetMinFontSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinFontSize() -> int

      Returns the minimum size of the font that can be displayed.


   .. ################################################################
      # GetWidth
      ################################################################

   .. oe:method:: GetWidth

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

         .. oe:api::

            double GetWidth() const

      .. oe:language:: python

         .. oe:api:: python

            GetWidth() -> float

      Returns the width of the :ref:`OEImageBase <OEDepict_OEImageBase>` object.


   .. ################################################################
      # SetMinFontSize
      ################################################################

   .. oe:method:: SetMinFontSize

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

         .. oe:api::

            void SetMinFontSize(unsigned int fontsize)

      .. oe:language:: python

         .. oe:api:: python

            SetMinFontSize(fontsize: int) -> None

      Sets the minimum size of the font that can be displayed.


   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSVGClass

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

         .. oe:api::

            OESVGClass* GetSVGClass(const std::string& name)
            const OESVGClass* GetSVGClass(const std::string& name) const

      .. oe:language:: python

         .. oe:api:: python

            GetSVGClass(name: str) -> OESVGClass

      Returns the :ref:`OESVGClass <OEDepict_OESVGClass>` object with the given
      name. Null pointer will be returned if no class exists on the
      image with the given name.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGClass <OEDepict_OESVGClass>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSVGGroup

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

         .. oe:api::

            OESVGGroup* GetSVGGroup(const std::string& id)
            const OESVGGroup* GetSVGGroup(const std::string& id) const

      .. oe:language:: python

         .. oe:api:: python

            GetSVGGroup(id: str) -> OESVGGroup

      Returns the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object with the given
      name. Null pointer will be returned if no group exists on the
      image with the given name.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: GetSVGGroups

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

         .. oe:api::

            OESystem::OEIterBase<OESVGGroup>* GetSVGGroups()

      .. oe:language:: python

         .. oe:api:: python

            GetSVGGroups() -> Iterable[OESVGGroup]

      Returns an iterator over the SVG groups (:ref:`OESVGGroup <OEDepict_OESVGGroup>`)
      of the image.

      **Example:**

      .. oe:source:: CreateSVGGroup.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. oe:source:: CreateSVGGroup.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. oe:source:: CreateSVGGroup.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. oe:source:: CreateSVGGroup.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GETSVGGROUPS

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class

   .. ################################################################
      #
      ################################################################

   .. oe:method:: NewSVGClass

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

         .. oe:api::

            OESVGClass* NewSVGClass(const std::string& name)

      .. oe:language:: python

         .. oe:api:: python

            NewSVGClass(name: str) -> OESVGClass

      Creates a new :ref:`OESVGClass <OEDepict_OESVGClass>` on the given image.
      A null pointer will be returned and warning message will be thrown
      if the SVG class can not be created.

      *name*
         The name of the :ref:`OESVGClass <OEDepict_OESVGClass>` object.
         For information about valid group names see the documentation
         of the :oe:func:`OEDepict::OEIsValidSVGClassName` function.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGClass <OEDepict_OESVGClass>` class


   .. ################################################################
      #
      ################################################################

   .. oe:method:: NewSVGGroup

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

         .. oe:api::

            OESVGGroup* NewSVGGroup(const std::string& id)

      .. oe:language:: python

         .. oe:api:: python

            NewSVGGroup(id: str) -> OESVGGroup

      Creates a new :ref:`OESVGGroup <OEDepict_OESVGGroup>` on the given image.
      A null pointer will be returned and warning message will be thrown
      if the SVG group can not be created.

      *name*
         The name of the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.
         For information about valid group names see the documentation
         of the :oe:func:`OEDepict::OEIsValidSVGGroupId` function.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class


   .. ################################################################
      #
      ################################################################

   .. oe:method:: PopGroup

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

         .. oe:api::

            bool PopGroup(const OESVGGroup *)

      .. oe:language:: python

         .. oe:api:: python

            PopGroup(arg0: OESVGGroup) -> bool

      Pops the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

      .. note::

         An :ref:`OESVGGroup <OEDepict_OESVGGroup>` object can be used (pushed / popped) only once.
         :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects can be nested.
         They should be used in LIFO (for last in, first out)
         i.e. the group that has been pushed last should be popped first.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
         * :oe:meth:`OEDepict::OEImageBase::PushGroup` method

   .. ################################################################
      #
      ################################################################

   .. oe:method:: PushGroup

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

         .. oe:api::

            bool PushGroup(const OESVGGroup *)

      .. oe:language:: python

         .. oe:api:: python

            PushGroup(arg0: OESVGGroup) -> bool

      Pushes the :ref:`OESVGGroup <OEDepict_OESVGGroup>` object.

      .. note::

         An :ref:`OESVGGroup <OEDepict_OESVGGroup>` object can be used (pushed / popped) only once.
         :ref:`OESVGGroup <OEDepict_OESVGGroup>` objects can be nested.
         They should be used in LIFO (for last in, first out)
         i.e. the group that has been pushed last should be popped first.

      .. seealso::

         * :ref:`chapter_svg` chapter
         * :ref:`OESVGGroup <OEDepict_OESVGGroup>` class
         * :oe:meth:`OEDepict::OEImageBase::PopGroup` method
