.. role:: ts-api-decorator

#############
ViewerOptions
#############

.. js:module:: cee
   :noindex:

.. container:: ts-api-section

   .. js:class:: ViewerOptions

      Rendering options for a ``Viewer``

      **Examples of the different highlight modes:**

      .. image:: ../../images/HighlightMode.png





.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~cee.ViewerOptions.constructor`



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-class

   * :js:attr:`~cee.ViewerOptions.alphaChannel`
   * :js:attr:`~cee.ViewerOptions.antiAliasing`
   * :js:attr:`~cee.ViewerOptions.enableTransparencyWBOIT`
   * :js:attr:`~cee.ViewerOptions.forceWebGL1`
   * :js:attr:`~cee.ViewerOptions.globalAmbientIntensity`
   * :js:attr:`~cee.ViewerOptions.globalDefaultSpecularIntensity`
   * :js:attr:`~cee.ViewerOptions.highlightMode`
   * :js:attr:`~cee.ViewerOptions.preserveDrawingBuffer`
   * :js:attr:`~cee.ViewerOptions.useOperators`
   * :js:attr:`~cee.ViewerOptions.wboitMode`





------------

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

.. container:: ts-api-section

   .. js:function:: ViewerOptions.constructor()



      :rtype: ViewerOptions



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.alphaChannel

      :type: boolean :ts-api-decorator:`optional`

      If true, the drawing buffer will have an alpha channel which can be useful for compositing with the page
      or for retrieving transparent image snapshots. Default false



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.antiAliasing

      :type: boolean :ts-api-decorator:`optional`

      Use anti aliasing. Default true



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.enableTransparencyWBOIT

      :type: boolean :ts-api-decorator:`optional`

      Whether to enable high quality transparency using a technique called "Weighted Blended Order-Independent Transparency"



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.forceWebGL1

      :type: boolean :ts-api-decorator:`optional`

      This option can be used to force usage of WebGL 1 instead of WebGL2. Default false



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.globalAmbientIntensity

      :type: number :ts-api-decorator:`optional`

      Specify the global ambient intensity



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.globalDefaultSpecularIntensity

      :type: number :ts-api-decorator:`optional`

      Specify the global default specular intensity



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.highlightMode

      :type: HighlightMode :ts-api-decorator:`optional`

      Whether to enable highlighting of parts using a halo



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.preserveDrawingBuffer

      :type: boolean :ts-api-decorator:`optional`

      preserveDrawingBuffer



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.useOperators

      :type: boolean :ts-api-decorator:`optional`

      This option enable the use of Operators for input handling and UI



.. container:: ts-api-section

   .. js:attribute:: ViewerOptions.wboitMode

      :type: WBOITMode :ts-api-decorator:`optional`

      Specify how to render opaque parts when there are transparent parts in the scene and 
       enableTransparencyWBOIT is enabled.



