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

An interface class representing a directional light. More...

#include <ilight.h>

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

Public Member Functions

virtual void set_direction (const mi::math::Vector_struct< mi::Float32, 3 > &d)=0
 Sets the direction of the directional light. More...
 
virtual const mi::math::Vector_struct< mi::Float32, 3 > & get_direction () const =0
 Returns the direction of the directional light. More...
 

Detailed Description

An interface class representing a directional light.

A directional light source illuminates all graphics elements equally from a given direction; it defines an oriented light with an origin at infinity. That is, a directional light source has a directional vector and parallel light rays travel along the direction. The directional light contributes to diffuse and specular reflections but does not contribute to ambient reflections.

Member Function Documentation

 get_direction()

virtual const mi::math::Vector_struct< mi::Float32, 3 > & nv::index::IDirectional_light::get_direction ( ) const
pure virtual

Returns the direction of the directional light.

Returns
Direction vector

 set_direction()

virtual void nv::index::IDirectional_light::set_direction ( const mi::math::Vector_struct< mi::Float32, 3 > &  d)
pure virtual

Sets the direction of the directional light.

Parameters
[in]dDirection vector

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