.. oe:namespace:: OEDepict

.. include:: ../substitutions

.. meta::
   :keywords: OE2DPathPoint


.. _OEDepict_OE2DPathPoint:

.. oe:class:: OE2DPathPoint

   .. oe:api::

      class OE2DPathPoint

   Represent a 2D point of a path with associated type from the 
   :oe:constns:`OEDepict::OE2DPathPointType` namespace.

   .. list-table::
      :widths: 100 100

      * - .. image:: ../images/OE2DPoint_AddCurveSegment.*
        - .. image:: ../images/OE2DPoint_AddLineSegment.*

   .. seealso::
  
      * :oe:meth:`OEDepict::OE2DPath::GetPoints` method


   .. ################################################################
      # Constructors
      ################################################################
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OE2DPathPoint(const OE2DPoint& point, unsigned int ptype)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPathPoint(point: OE2DPoint, ptype: int) -> OE2DPathPoint

      Constructs an :ref:`OE2DPathPoint <OEDepict_OE2DPathPoint>` object with a
      given type from the  :oe:constns:`OEDepict::OE2DPathPointType`
      namespace.

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

         .. oe:api::

            OE2DPathPoint(const OE2DPathPoint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DPathPoint(arg2: OE2DPathPoint) -> OE2DPathPoint

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

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

      .. oe:api::

         OE2DPathPoint &operator=(const OE2DPathPoint &rhs)

      Assignment operator.

   .. oe:method:: GetPoint

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

         .. oe:api::

            const OE2DPoint& GetPoint() const

      .. oe:language:: python

         .. oe:api:: python

            GetPoint() -> OE2DPoint

      Returns the 2D coordinates of the point.


   .. oe:method:: GetPointType

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

         .. oe:api::

            unsigned int GetPointType() const

      .. oe:language:: python

         .. oe:api:: python

            GetPointType() -> int

      Returns the type of the point from the 
      :oe:constns:`OEDepict::OE2DPathPointType` namespace.
