
#####################
A3DGraphSpotLightData
#####################

.. c:struct:: A3DGraphSpotLightData

   Data for a spotlight source entity (``A3DGraphSpotLight``\ )
   
   
      2.0
   
   
   A spotlight is a lighting source with a given position which casts lights within a specific direction. Only the objects within a given radius of the spotlight's direction are illuminated, with the light rays fading over the distance. Spotlights can be interpreted as more restrictive point lights, where only a subset of the scene is illuminated from it.
   
   All colors within this structure are global indexes to RGB color codes. The actual values can be queried using ``A3DGlobalGetGraphRgbColorData``\ .
   
   ``A3DGraphSpotLightData``\ is one of the four light source types provided by HOOPS. It is associated to the ``kA3DTypeGraphSpotLight``\ entity type. The other available light sources are ``A3DGraphAmbientLightData``\ , ``A3DGraphPointLightData``\ and ``A3DGraphDirectionalLightData``\ .
   
   
      :c:func:`~A3DGraphSpotLightGet`
   
   
   
      :c:func:`~A3DGraphSpotLightCreate`
   
   
   
      :c:struct:`~A3DGraphRgbColorData`
   
   
   
      :c:func:`~A3DGlobalGetGraphRgbColorData`
   
   
   
      :c:func:`~A3DGlobalInsertGraphRgbColor`
   
   
   
      :c:struct:`~A3DGraphMaterialData`
   
   
   
      :c:struct:`~A3DGraphAmbientLightData`
   
   
   
      :c:struct:`~A3DGraphDirectionalLightData`
   
   
   
      :c:struct:`~A3DGraphPointLightData`
   
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :c:member:`~A3DGraphSpotLightData.m_uiAmbientColorIndex`
   * :c:member:`~A3DGraphSpotLightData.m_uiDiffuseColorIndex`
   * :c:member:`~A3DGraphSpotLightData.m_uiSpecularColorIndex`
   * :c:member:`~A3DGraphSpotLightData.m_sDirection`
   * :c:member:`~A3DGraphSpotLightData.m_dFallOffAngle`
   * :c:member:`~A3DGraphSpotLightData.m_dFallOffExponent`
   * :c:member:`~A3DGraphSpotLightData.m_sLocation`
   * :c:member:`~A3DGraphSpotLightData.m_dConstantAttenuation`
   * :c:member:`~A3DGraphSpotLightData.m_dLinearAttenuation`
   * :c:member:`~A3DGraphSpotLightData.m_dQuadraticAttenuation`
   
   



.. rst-class:: kind-group kind-variable

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


.. c:member:: A3DUns32 A3DGraphSpotLightData.m_uiAmbientColorIndex

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The main or ambient color of the light source.
      



.. c:member:: A3DUns32 A3DGraphSpotLightData.m_uiDiffuseColorIndex

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The diffuse color of the light source.
      



.. c:member:: A3DUns32 A3DGraphSpotLightData.m_uiSpecularColorIndex

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DUns32`
      
      The specular color of the light source.
      



.. c:member:: A3DVector3dData A3DGraphSpotLightData.m_sDirection

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DVector3dData`
      
      The direction of the spotlight, expressed in world space coordinates.
      



.. c:member:: A3DDouble A3DGraphSpotLightData.m_dFallOffAngle

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Spotlight angle.
      



.. c:member:: A3DDouble A3DGraphSpotLightData.m_dFallOffExponent

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Fall of factor, expressed as a scale of ``m_dFallOffAngle``\ :*[0.0;1.0]*
      



.. c:member:: A3DVector3dData A3DGraphSpotLightData.m_sLocation

      .. rst-class:: sig-pretty-signature
      
         | :c:struct:`~A3DVector3dData`
      
      The light source position in world space coordinates.
      



.. c:member:: A3DDouble A3DGraphSpotLightData.m_dConstantAttenuation

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Constant attenuation factor usually set to *1.0*\ .
      



.. c:member:: A3DDouble A3DGraphSpotLightData.m_dLinearAttenuation

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Linear attenuation factor.
      



.. c:member:: A3DDouble A3DGraphSpotLightData.m_dQuadraticAttenuation

      .. rst-class:: sig-pretty-signature
      
         | :c:type:`~A3DDouble`
      
      Quadratic attenuation factor.
      




