
###############
OverlayViewport
###############

.. js:class:: Overlay.OverlayViewport

   This class is used to store overlay viewport information set via the OverlayManager so that we can retrieve it later
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Overlay.OverlayViewport.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Overlay.OverlayViewport.getAnchor`
   * :js:meth:`~Overlay.OverlayViewport.getPosition`
   * :js:meth:`~Overlay.OverlayViewport.getSize`
   
   




Constructors
============

.. js:method:: Overlay.OverlayViewport.constructor

   .. rst-class:: sig-pretty-signature
   
      | OverlayViewport(**anchor**\ : :js:data:`~OverlayAnchor`\ , **position**\ : *OverlayUnitPoint*\ , **size**\ : *OverlayUnitPoint*\ ): :js:class:`OverlayViewport <Overlay.OverlayViewport>`
   
   **Parameters**
   
      **anchor**\ : :js:data:`~OverlayAnchor`
   
      **position**\ : *OverlayUnitPoint*
   
      **size**\ : *OverlayUnitPoint*
   
   
   **Returns**\ : :js:class:`OverlayViewport <Overlay.OverlayViewport>`
   





Methods
=======

.. js:method:: Overlay.OverlayViewport.getAnchor

   .. rst-class:: sig-pretty-signature
   
      | getAnchor(): :js:data:`~OverlayAnchor`
   
   **Returns**\ : :js:data:`~OverlayAnchor`
   



.. js:method:: Overlay.OverlayViewport.getPosition

   .. rst-class:: sig-pretty-signature
   
      | getPosition(): *OverlayUnitPoint*
   
   **Returns**\ : *OverlayUnitPoint*
   



.. js:method:: Overlay.OverlayViewport.getSize

   .. rst-class:: sig-pretty-signature
   
      | getSize(): *OverlayUnitPoint*
   
   **Returns**\ : *OverlayUnitPoint*
   





