
################
OverlayInterface
################

.. js:class:: wv.Sc.OverlayInterface

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Sc.OverlayInterface.destroy`
   * :js:meth:`~wv.Sc.OverlayInterface.maxIndex`
   * :js:meth:`~wv.Sc.OverlayInterface.setCamera`
   * :js:meth:`~wv.Sc.OverlayInterface.setViewport`
   * :js:meth:`~wv.Sc.OverlayInterface.setVisible`
   
   



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: wv.Sc.OverlayInterface.destroy

      .. rst-class:: sig-pretty-signature
      
         | destroy(**viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`\ , **index**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`
      
         **index**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Sc.OverlayInterface.maxIndex

      .. rst-class:: sig-pretty-signature
      
         | maxIndex(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wv.Sc.OverlayInterface.setCamera

      .. rst-class:: sig-pretty-signature
      
         | setCamera(**viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`\ , **index**\ : *number*\ , **Camera**\ : :js:class:`Camera <wv.Sc.Camera>`\ ): *void*
      
      **Parameters**
      
      
         **viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`
      
         **index**\ : *number*
      
         **Camera**\ : :js:class:`Camera <wv.Sc.Camera>`
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Sc.OverlayInterface.setViewport

      .. rst-class:: sig-pretty-signature
      
         | setViewport(**viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`\ , **index**\ : *number*\ , **anchor**\ : :js:data:`OverlayAnchor <wv.Sc.OverlayAnchor>`\ , **xOffset**\ : *number*\ , **xUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`\ , **yOffset**\ : *number*\ , **yUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`\ , **width**\ : *number*\ , **widthUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`\ , **height**\ : *number*\ , **heightUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`\ ): *void*
      
      **Parameters**
      
      
         **viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`
      
         **index**\ : *number*
      
         **anchor**\ : :js:data:`OverlayAnchor <wv.Sc.OverlayAnchor>`
      
         **xOffset**\ : *number*
      
         **xUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`
      
         **yOffset**\ : *number*
      
         **yUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`
      
         **width**\ : *number*
      
         **widthUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`
      
         **height**\ : *number*
      
         **heightUnit**\ : :js:data:`OverlayUnit <wv.Sc.OverlayUnit>`
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Sc.OverlayInterface.setVisible

      .. rst-class:: sig-pretty-signature
      
         | setVisible(**viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`\ , **index**\ : *number*\ , **visibility**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **viewKey**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`
      
         **index**\ : *number*
      
         **visibility**\ : *boolean*
      
      
      **Returns**\ : *void*
      




