
#####
Light
#####

.. js:class:: wv.Light

   Contains properties of a light. More information can be found `here <https://docs.techsoft3d.com/hoops/visualize-web/latest/prog_guide/viewing/scene_attributes/lights.html>`__\ .
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.Light.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~wv.Light.color`
   * :js:data:`~wv.Light.position`
   * :js:data:`~wv.Light.space`
   * :js:data:`~wv.Light.type`
   
   



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

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


.. js:method:: wv.Light.constructor

      .. rst-class:: sig-pretty-signature
      
         | Light(**type**\ : :js:data:`LightType <wv.Sc.LightType>`\ , **space**\ : :js:data:`LightSpace <wv.Sc.LightSpace>`\ , **position**\ : :js:class:`Point3 <wv.Point3>`\ , **color**\ : :js:class:`Color <wv.Color>`\ ): :js:class:`Light <wv.Light>`
      
      **Parameters**
      
      
         **type**\ : :js:data:`LightType <wv.Sc.LightType>`
      
      
            The light's type. See [[type]].
      
      
         **space**\ : :js:data:`LightSpace <wv.Sc.LightSpace>`
      
      
            The space in which a light is defined. See [[space]]
      
      
         **position**\ : :js:class:`Point3 <wv.Point3>`
      
      
            The light's position. See [[position]].
      
      
         **color**\ : :js:class:`Color <wv.Color>`
      
      
            The light's color. See [[color]].
      
      
      
      **Returns**\ : :js:class:`Light <wv.Light>`
      



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

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


.. js:data:: wv.Light.color

      .. rst-class:: sig-pretty-signature
      
         | color: :js:class:`Color <wv.Color>`
      
      The light's color.
      



.. js:data:: wv.Light.position

      .. rst-class:: sig-pretty-signature
      
         | position: :js:class:`Point3 <wv.Point3>`
      
      The light's position in the scene. See [[LightType.Directional]] for information on how the position is interpreted for directional lights.
      



.. js:data:: wv.Light.space

      .. rst-class:: sig-pretty-signature
      
         | space: :js:data:`LightSpace <wv.Sc.LightSpace>`
      
      The space in which the light's position is defined.
      



.. js:data:: wv.Light.type

      .. rst-class:: sig-pretty-signature
      
         | type: :js:data:`LightType <wv.Sc.LightType>`
      
      The light's type.
      




