.. role:: clio-readonly
   :class: clio-flag clio-flag-readonly

.. role:: clio-static
   :class: clio-flag clio-flag-static


####################
RenderOptionsService
####################

.. js:class:: wvc.RenderOptionsService

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.RenderOptionsService.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~wvc.RenderOptionsService.DefaultConfig`
   * :js:data:`~wvc.RenderOptionsService.serviceName`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wvc.RenderOptionsService.webViewer`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wvc.RenderOptionsService.getAmbientOcclusionEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getAmbientOcclusionRadius`
   * :js:meth:`~wvc.RenderOptionsService.getAntiAliasingEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getBackgroundColor`
   * :js:meth:`~wvc.RenderOptionsService.getBloomEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getBloomIntensity`
   * :js:meth:`~wvc.RenderOptionsService.getBloomThreshold`
   * :js:meth:`~wvc.RenderOptionsService.getEyeDomeLightingEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getHiddenLineOpacity`
   * :js:meth:`~wvc.RenderOptionsService.getMinimumFramerate`
   * :js:meth:`~wvc.RenderOptionsService.getReflectionEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getShadowBlurSamples`
   * :js:meth:`~wvc.RenderOptionsService.getShadowEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getShadowInteractive`
   * :js:meth:`~wvc.RenderOptionsService.getShowBackfaces`
   * :js:meth:`~wvc.RenderOptionsService.getSilhouetteEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getSplatRenderingEnabled`
   * :js:meth:`~wvc.RenderOptionsService.getSplatRenderingPointSizeUnit`
   * :js:meth:`~wvc.RenderOptionsService.getSplatRenderingSize`
   * :js:meth:`~wvc.RenderOptionsService.resetConfiguration`
   * :js:meth:`~wvc.RenderOptionsService.setAmbientOcclusionEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setAmbientOcclusionRadius`
   * :js:meth:`~wvc.RenderOptionsService.setAntiAliasingEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setBackgroundColor`
   * :js:meth:`~wvc.RenderOptionsService.setBloomEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setBloomIntensity`
   * :js:meth:`~wvc.RenderOptionsService.setBloomThreshold`
   * :js:meth:`~wvc.RenderOptionsService.setEyeDomeLightingEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setHiddenLineOpacity`
   * :js:meth:`~wvc.RenderOptionsService.setMinimumFramerate`
   * :js:meth:`~wvc.RenderOptionsService.setReflectionEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setShadowBlurSamples`
   * :js:meth:`~wvc.RenderOptionsService.setShadowEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setShadowInteractive`
   * :js:meth:`~wvc.RenderOptionsService.setShowBackfaces`
   * :js:meth:`~wvc.RenderOptionsService.setSilhouetteEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setSplatRenderingEnabled`
   * :js:meth:`~wvc.RenderOptionsService.setSplatRenderingPointSizeUnit`
   * :js:meth:`~wvc.RenderOptionsService.setSplatRenderingSize`
   
   



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

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


.. js:method:: wvc.RenderOptionsService.constructor

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



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

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


.. js:data:: wvc.RenderOptionsService.DefaultConfig

      .. rst-class:: clio-flags
      
         :clio-static:`static`
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | DefaultConfig: :js:data:`RenderOptionsServiceConfiguration <wvc.RenderOptionsServiceConfiguration>`
      



.. js:data:: wvc.RenderOptionsService.serviceName

      .. rst-class:: clio-flags
      
         :clio-readonly:`readonly`
      
      .. rst-class:: sig-pretty-signature
      
         | serviceName: *"RenderOptionsService"*
      



.. rst-class:: kind-group kind-accessors

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


.. js:method:: wvc.RenderOptionsService.webViewer

      .. rst-class:: sig-pretty-signature
      
         | *get* webViewer(): (*undefined* | *IWebViewer*\ )
      
      **Returns**\ : (*undefined* \| *IWebViewer*\ )
      
      .. rst-class:: sig-pretty-signature
      
         | *set* webViewer(**value**\ : (*undefined* | *IWebViewer*\ )): *void*
      
      **Parameters**
      
      
         **value**\ : (*undefined* \| *IWebViewer*\ )
      
      
      **Returns**\ : *void*
      



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

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


.. js:method:: wvc.RenderOptionsService.getAmbientOcclusionEnabled

      .. rst-class:: sig-pretty-signature
      
         | getAmbientOcclusionEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getAmbientOcclusionRadius

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



.. js:method:: wvc.RenderOptionsService.getAntiAliasingEnabled

      .. rst-class:: sig-pretty-signature
      
         | getAntiAliasingEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getBackgroundColor

      .. rst-class:: sig-pretty-signature
      
         | getBackgroundColor(): :js:class:`VerticalGradient <wvc.VerticalGradient>`
      
      **Returns**\ : :js:class:`VerticalGradient <wvc.VerticalGradient>`
      



.. js:method:: wvc.RenderOptionsService.getBloomEnabled

      .. rst-class:: sig-pretty-signature
      
         | getBloomEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getBloomIntensity

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



.. js:method:: wvc.RenderOptionsService.getBloomThreshold

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



.. js:method:: wvc.RenderOptionsService.getEyeDomeLightingEnabled

      .. rst-class:: sig-pretty-signature
      
         | getEyeDomeLightingEnabled(): *Promise*
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.getHiddenLineOpacity

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



.. js:method:: wvc.RenderOptionsService.getMinimumFramerate

      .. rst-class:: sig-pretty-signature
      
         | getMinimumFramerate(): *Promise*
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.getReflectionEnabled

      .. rst-class:: sig-pretty-signature
      
         | getReflectionEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getShadowBlurSamples

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



.. js:method:: wvc.RenderOptionsService.getShadowEnabled

      .. rst-class:: sig-pretty-signature
      
         | getShadowEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getShadowInteractive

      .. rst-class:: sig-pretty-signature
      
         | getShadowInteractive(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getShowBackfaces

      .. rst-class:: sig-pretty-signature
      
         | getShowBackfaces(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getSilhouetteEnabled

      .. rst-class:: sig-pretty-signature
      
         | getSilhouetteEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getSplatRenderingEnabled

      .. rst-class:: sig-pretty-signature
      
         | getSplatRenderingEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wvc.RenderOptionsService.getSplatRenderingPointSizeUnit

      .. rst-class:: sig-pretty-signature
      
         | getSplatRenderingPointSizeUnit(): (*"Screen Pixels"* | *"CSS Pixels"* | *"World"* | *"Proportion Of Screen Width"* | *"Proportion Of Screen Height"* | *"Proportion Of Bounding Diagonal"*\ )
      
      **Returns**\ : (*"Screen Pixels"* \| *"CSS Pixels"* \| *"World"* \| *"Proportion Of Screen Width"* \| *"Proportion Of Screen Height"* \| *"Proportion Of Bounding Diagonal"*\ )
      



.. js:method:: wvc.RenderOptionsService.getSplatRenderingSize

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



.. js:method:: wvc.RenderOptionsService.resetConfiguration

      .. rst-class:: sig-pretty-signature
      
         | resetConfiguration(**obj**\ : *object*\ ): *Promise*
      
      **Parameters**
      
      
         **obj**\ : *object*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setAmbientOcclusionEnabled

      .. rst-class:: sig-pretty-signature
      
         | setAmbientOcclusionEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setAmbientOcclusionRadius

      .. rst-class:: sig-pretty-signature
      
         | setAmbientOcclusionRadius(**radius**\ : *number*\ ): *Promise*
      
      **Parameters**
      
      
         **radius**\ : *number*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setAntiAliasingEnabled

      .. rst-class:: sig-pretty-signature
      
         | setAntiAliasingEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setBackgroundColor

      .. rst-class:: sig-pretty-signature
      
         | setBackgroundColor(**color**\ : :js:class:`VerticalGradient <wvc.VerticalGradient>`\ ): *Promise*
      
      **Parameters**
      
      
         **color**\ : :js:class:`VerticalGradient <wvc.VerticalGradient>`
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setBloomEnabled

      .. rst-class:: sig-pretty-signature
      
         | setBloomEnabled(**enabled**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setBloomIntensity

      .. rst-class:: sig-pretty-signature
      
         | setBloomIntensity(**intensity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **intensity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setBloomThreshold

      .. rst-class:: sig-pretty-signature
      
         | setBloomThreshold(**threshold**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **threshold**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setEyeDomeLightingEnabled

      .. rst-class:: sig-pretty-signature
      
         | setEyeDomeLightingEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setHiddenLineOpacity

      .. rst-class:: sig-pretty-signature
      
         | setHiddenLineOpacity(**opacity**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **opacity**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setMinimumFramerate

      .. rst-class:: sig-pretty-signature
      
         | setMinimumFramerate(**value**\ : *number*\ ): *Promise*
      
      **Parameters**
      
      
         **value**\ : *number*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setReflectionEnabled

      .. rst-class:: sig-pretty-signature
      
         | setReflectionEnabled(**enabled**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setShadowBlurSamples

      .. rst-class:: sig-pretty-signature
      
         | setShadowBlurSamples(**samples**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **samples**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setShadowEnabled

      .. rst-class:: sig-pretty-signature
      
         | setShadowEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setShadowInteractive

      .. rst-class:: sig-pretty-signature
      
         | setShadowInteractive(**interactive**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **interactive**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setShowBackfaces

      .. rst-class:: sig-pretty-signature
      
         | setShowBackfaces(**show**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **show**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setSilhouetteEnabled

      .. rst-class:: sig-pretty-signature
      
         | setSilhouetteEnabled(**enabled**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: wvc.RenderOptionsService.setSplatRenderingEnabled

      .. rst-class:: sig-pretty-signature
      
         | setSplatRenderingEnabled(**enabled**\ : *boolean*\ ): *Promise*
      
      **Parameters**
      
      
         **enabled**\ : *boolean*
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setSplatRenderingPointSizeUnit

      .. rst-class:: sig-pretty-signature
      
         | setSplatRenderingPointSizeUnit(**unit**\ : (*"Screen Pixels"* | *"CSS Pixels"* | *"World"* | *"Proportion Of Screen Width"* | *"Proportion Of Screen Height"* | *"Proportion Of Bounding Diagonal"*\ )): *Promise*
      
      **Parameters**
      
      
         **unit**\ : (*"Screen Pixels"* \| *"CSS Pixels"* \| *"World"* \| *"Proportion Of Screen Width"* \| *"Proportion Of Screen Height"* \| *"Proportion Of Bounding Diagonal"*\ )
      
      
      **Returns**\ : *Promise*
      



.. js:method:: wvc.RenderOptionsService.setSplatRenderingSize

      .. rst-class:: sig-pretty-signature
      
         | setSplatRenderingSize(**size**\ : *number*\ ): *Promise*
      
      **Parameters**
      
      
         **size**\ : *number*
      
      
      **Returns**\ : *Promise*
      




