.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


#####################
IRenderOptionsService
#####################

.. js:class:: wvc.IRenderOptionsService

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



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

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


.. js:data:: wvc.IRenderOptionsService.serviceName

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | serviceName: :js:data:`ServiceName <wvc.ServiceName>`
      



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

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


.. js:method:: wvc.IRenderOptionsService.getAmbientOcclusionEnabled

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



.. js:method:: wvc.IRenderOptionsService.getAmbientOcclusionRadius

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



.. js:method:: wvc.IRenderOptionsService.getAntiAliasingEnabled

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



.. js:method:: wvc.IRenderOptionsService.getBackgroundColor

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



.. js:method:: wvc.IRenderOptionsService.getBloomEnabled

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



.. js:method:: wvc.IRenderOptionsService.getBloomIntensity

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



.. js:method:: wvc.IRenderOptionsService.getBloomThreshold

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



.. js:method:: wvc.IRenderOptionsService.getEyeDomeLightingEnabled

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



.. js:method:: wvc.IRenderOptionsService.getHiddenLineOpacity

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



.. js:method:: wvc.IRenderOptionsService.getMinimumFramerate

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



.. js:method:: wvc.IRenderOptionsService.getReflectionEnabled

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



.. js:method:: wvc.IRenderOptionsService.getShadowBlurSamples

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



.. js:method:: wvc.IRenderOptionsService.getShadowEnabled

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



.. js:method:: wvc.IRenderOptionsService.getShadowInteractive

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



.. js:method:: wvc.IRenderOptionsService.getShowBackfaces

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



.. js:method:: wvc.IRenderOptionsService.getSilhouetteEnabled

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



.. js:method:: wvc.IRenderOptionsService.getSplatRenderingEnabled

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



.. js:method:: wvc.IRenderOptionsService.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.IRenderOptionsService.getSplatRenderingSize

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



.. js:method:: wvc.IRenderOptionsService.resetConfiguration

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



.. js:method:: wvc.IRenderOptionsService.setAmbientOcclusionEnabled

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



.. js:method:: wvc.IRenderOptionsService.setAmbientOcclusionRadius

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



.. js:method:: wvc.IRenderOptionsService.setAntiAliasingEnabled

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



.. js:method:: wvc.IRenderOptionsService.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.IRenderOptionsService.setBloomEnabled

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



.. js:method:: wvc.IRenderOptionsService.setBloomIntensity

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



.. js:method:: wvc.IRenderOptionsService.setBloomThreshold

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



.. js:method:: wvc.IRenderOptionsService.setEyeDomeLightingEnabled

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



.. js:method:: wvc.IRenderOptionsService.setHiddenLineOpacity

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



.. js:method:: wvc.IRenderOptionsService.setMinimumFramerate

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



.. js:method:: wvc.IRenderOptionsService.setReflectionEnabled

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



.. js:method:: wvc.IRenderOptionsService.setShadowBlurSamples

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



.. js:method:: wvc.IRenderOptionsService.setShadowEnabled

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



.. js:method:: wvc.IRenderOptionsService.setShadowInteractive

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



.. js:method:: wvc.IRenderOptionsService.setShowBackfaces

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



.. js:method:: wvc.IRenderOptionsService.setSilhouetteEnabled

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



.. js:method:: wvc.IRenderOptionsService.setSplatRenderingEnabled

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



.. js:method:: wvc.IRenderOptionsService.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.IRenderOptionsService.setSplatRenderingSize

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




