.. role:: clio-optional
   :class: clio-flag clio-flag-optional


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

.. js:class:: cee.ViewerOptions

   Rendering options for a :js:class:`Viewer <cee.Viewer>`
   
   **Examples of the different highlight modes:**
   
   .. image:: /images/HighlightMode.png
      :alt: None
   
   
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ViewerOptions.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.ViewerOptions.alphaChannel`
   * :js:data:`~cee.ViewerOptions.antiAliasing`
   * :js:data:`~cee.ViewerOptions.enableTransparencyWBOIT`
   * :js:data:`~cee.ViewerOptions.forceWebGL1`
   * :js:data:`~cee.ViewerOptions.globalAmbientIntensity`
   * :js:data:`~cee.ViewerOptions.globalDefaultSpecularIntensity`
   * :js:data:`~cee.ViewerOptions.highlightMode`
   * :js:data:`~cee.ViewerOptions.preserveDrawingBuffer`
   * :js:data:`~cee.ViewerOptions.useOperators`
   * :js:data:`~cee.ViewerOptions.wboitMode`
   
   



.. rst-class:: kind-group kind-constructors

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


.. js:method:: cee.ViewerOptions.constructor

      .. rst-class:: sig-pretty-signature
      
         | ViewerOptions(): :js:class:`ViewerOptions <cee.ViewerOptions>`
      
      **Returns**\ : :js:class:`ViewerOptions <cee.ViewerOptions>`
      



.. rst-class:: kind-group kind-properties

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


.. js:data:: cee.ViewerOptions.alphaChannel

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | alphaChannel: *boolean*
      
      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
      



.. js:data:: cee.ViewerOptions.antiAliasing

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | antiAliasing: *boolean*
      
      Use anti aliasing. Default true
      



.. js:data:: cee.ViewerOptions.enableTransparencyWBOIT

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | enableTransparencyWBOIT: *boolean*
      
      Whether to enable high quality transparency using a technique called "Weighted Blended Order-Independent Transparency"
      



.. js:data:: cee.ViewerOptions.forceWebGL1

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | forceWebGL1: *boolean*
      
      This option can be used to force usage of WebGL 1 instead of WebGL2. Default false
      



.. js:data:: cee.ViewerOptions.globalAmbientIntensity

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | globalAmbientIntensity: *number*
      
      Specify the global ambient intensity
      



.. js:data:: cee.ViewerOptions.globalDefaultSpecularIntensity

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | globalDefaultSpecularIntensity: *number*
      
      Specify the global default specular intensity
      



.. js:data:: cee.ViewerOptions.highlightMode

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | highlightMode: :js:data:`HighlightMode <cee.HighlightMode>`
      
      Whether to enable highlighting of parts using a halo
      



.. js:data:: cee.ViewerOptions.preserveDrawingBuffer

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | preserveDrawingBuffer: *boolean*
      
      preserveDrawingBuffer
      



.. js:data:: cee.ViewerOptions.useOperators

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | useOperators: *boolean*
      
      This option enable the use of Operators for input handling and UI
      



.. js:data:: cee.ViewerOptions.wboitMode

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | wboitMode: :js:data:`WBOITMode <cee.WBOITMode>`
      
      Specify how to render opaque parts when there are transparent parts in the scene and enableTransparencyWBOIT is enabled.
      




