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


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

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



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

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


.. js:method:: wv.PointLight.constructor

      .. rst-class:: sig-pretty-signature
      
         | PointLight(**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>`\ , **power**\ : *number*\ , **decay**\ : *number*\ ): :js:class:`PointLight <wv.PointLight>`
      
      **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]].
      
      
         **power**\ : *number*
      
      
            The light's power. See [[power]].
      
      
         **decay**\ : *number*
      
      
            The light's power. See [[decay]].
      
      
      
      **Returns**\ : :js:class:`PointLight <wv.PointLight>`
      



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

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


.. js:data:: wv.PointLight.color

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



.. js:data:: wv.PointLight.decay

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



.. js:data:: wv.PointLight.position

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

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



.. js:data:: wv.PointLight.space

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

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




