
#####
Light
#####

.. js:class:: 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:`~Light.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~Light.color`
   * :js:data:`~Light.position`
   * :js:data:`~Light.space`
   * :js:data:`~Light.type`
   
   




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

.. js:method:: Light.constructor

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





Properties
==========

.. js:data:: Light.color

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



.. js:data:: Light.position

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



.. js:data:: Light.space

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



.. js:data:: Light.type

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





