NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::ILight Class Referenceabstract

The light base class. More...

#include <ilight.h>

Inherits mi::base::Interface_declare< 0xbf099107, ... >.

Public Member Functions

virtual void set_intensity (const mi::math::Color_struct &intensity)=0
 Sets the light intensity. More...
 
virtual const mi::math::Color_struct & get_intensity () const =0
 Returns the light intensity. More...
 

Detailed Description

The light base class.

Derived classes define the light sources. Light sources emit light into the scene and enable the rendering system to shade graphics elements such as heightfields or higher-level 3D shapes in a realistic way. The illumination of surfaces using light sources provides visual cues in the scene and enables users of the rendering software to orient themselves in 3D space.

Every light source is defined in the scene description hierarchy and affects all shapes defined further down in the scene description's hierarchy in traversal order. The interface class ILight represents a light source.

A light source exposes the interface methods to set and get the light's intensity, i.e., the weighted color that the light emits, and to turn on and off the light source.

Member Function Documentation

 get_intensity()

virtual const mi::math::Color_struct & nv::index::ILight::get_intensity ( ) const
pure virtual

Returns the light intensity.

Returns
Light intensity

 set_intensity()

virtual void nv::index::ILight::set_intensity ( const mi::math::Color_struct &  intensity)
pure virtual

Sets the light intensity.

Parameters
[in]intensityIntensity of the light

The documentation for this class was generated from the following file: