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


##########
PointLight
##########

.. js:class:: PointLight

   Contains properties of a point 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:`~PointLight.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~PointLight.color`
   * :js:data:`~PointLight.decay`
   * :js:data:`~PointLight.position`
   * :js:data:`~PointLight.power`
   * :js:data:`~PointLight.space`
   * :js:data:`~PointLight.type`
   
   




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

.. js:method:: PointLight.constructor

   .. rst-class:: sig-pretty-signature
   
      | PointLight(**type**\ : :js:data:`LightType <Sc.LightType>`\ , **space**\ : :js:data:`LightSpace <Sc.LightSpace>`\ , **position**\ : :js:class:`~Point3`\ , **color**\ : :js:class:`~Color`\ , **power**\ : *number*\ , **decay**\ : *number*\ ): :js:class:`~PointLight`
   
   **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]].
   
   
      **power**\ : *number*
   
         The light's power. See [[power]].
   
   
      **decay**\ : *number*
   
         The light's power. See [[decay]].
   
   
   
   **Returns**\ : :js:class:`~PointLight`
   





Properties
==========

.. js:data:: PointLight.color

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



.. js:data:: PointLight.decay

   .. rst-class:: sig-pretty-signature
   
      | decay: *number*
   
   How quickly the light will attenuate as it travels further from its source
   



.. js:data:: PointLight.position

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. 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:: PointLight.power

   .. rst-class:: sig-pretty-signature
   
      | power: *number*
   
   How bright the light is
   



.. js:data:: PointLight.space

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



.. js:data:: PointLight.type

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





