ntl_lighting.h

Go to the documentation of this file.

/******************************************************************************
 *
 * El'Beem - Free Surface Fluid Simulation with the Lattice Boltzmann Method
 * Copyright 2003-2006 Nils Thuerey
 *
 * a light object
 * default omni light implementation
 *
 *****************************************************************************/
#ifndef NTL_LIGHTING_H
#define NTL_LIGHTING_H

#include "ntl_vector3dim.h"
class ntlMaterial;
class ntlRay;
class ntlRenderGlobals;
class ntlGeometryObject;



/* shadow map directions */
#define LSM_RIGHT 0
#define LSM_LEFT  1
#define LSM_UP    2
#define LSM_DOWN  3
#define LSM_FRONT 4
#define LSM_BACK  5

class ntlLightObject
{
public:
  /* CONSTRUCTORS */
  ntlLightObject(ntlRenderGlobals *glob);
  ntlLightObject(ntlRenderGlobals *glob, const ntlColor& col);
  virtual ~ntlLightObject();

    virtual void prepare( bool );
    
    virtual ntlColor illuminatePoint(ntlRay &reflectedRay, 
                                                                     ntlGeometryObject *closest,
                                                                     ntlColor &highlight);
    const ntlColor
    getShadedColor(const ntlRay &reflectedray, ntlVec3Gfx lightDir,
                                 ntlMaterial *surf, ntlColor &highlight) const;


  /* access methods */
  inline void setActive(bool set) { mActive = set; }
  inline bool getActive() const { return mActive; }
  inline void setCastShadows(bool set) { mCastShadows = set; }
  inline bool getCastShadows() const { return mCastShadows; }
  inline void setColor(ntlColor set) { mcColor = set; }
  inline ntlColor getColor() const { return mcColor; }
  
  void setPosition(ntlVec3Gfx set) { mvPosition = set; }
  ntlVec3Gfx getPosition() const { return mvPosition; }
    

protected:
    ntlRenderGlobals *mpGlob;

    bool mActive;

    bool mCastShadows;

    ntlColor  mcColor;

    ntlVec3Gfx  mvPosition;

private:

};


class ntlMaterial
{
public:
  // CONSTRUCTORS
  ntlMaterial( void );

  ntlMaterial( string name,
         const ntlColor& Ref, const ntlColor& Amb, 
               gfxReal Spec, gfxReal Exp, gfxReal Mirror,
               gfxReal Trans, gfxReal Refrac, gfxReal TAdd,
               const ntlColor& Att, int fres);
  ~ntlMaterial() {};

    inline void calculateFresnel(const ntlVec3Gfx &dir, const ntlVec3Gfx &normal, gfxReal refIndex,
                                                             gfxReal &refl, gfxReal &trans );

protected:

  /* name of the material */
  string mName;

  ntlColor  mDiffuseRefl;
  ntlColor mAmbientRefl;
  gfxReal mSpecular;
  gfxReal mSpecExponent;
  gfxReal mMirror;

  gfxReal mTransparence;
  gfxReal mRefracIndex;
  gfxReal mTransAdditive;
  ntlColor mTransAttCol;
    int mFresnel;


public:
  // access methods

  inline string getName() { return mName; }
  inline ntlColor  getDiffuseRefl() const { return ntlColor(mDiffuseRefl); }
  inline ntlColor getAmbientRefl() const { return ntlColor(mAmbientRefl); }
  inline gfxReal getSpecular() const { return mSpecular; }
  inline gfxReal getSpecExponent() const { return mSpecExponent; }
  inline gfxReal getMirror() const { return mMirror; }
  inline gfxReal getTransparence() const { return mTransparence; }
  inline gfxReal getRefracIndex() const { return mRefracIndex; }
  inline gfxReal getTransAdditive() const { return mTransAdditive; }
  inline ntlColor getTransAttCol() const { return mTransAttCol; }
    inline int getFresnel( void ) { return mFresnel; }



  inline void setName(string set) { mName = set; }
  inline void setDiffuseRefl(ntlColor set) { mDiffuseRefl=set; }
  inline void setAmbientRefl(ntlColor set) { mAmbientRefl=set; }
  inline void setSpecular(gfxReal set) { mSpecular=set; }
  inline void setSpecExponent(gfxReal set) { mSpecExponent=set; }
  inline void setMirror(gfxReal set) { mMirror=set; }
  inline void setTransparence(gfxReal set) { mTransparence=set; }
  inline void setRefracIndex(gfxReal set) { mRefracIndex=set; }
  inline void setTransAdditive(gfxReal set) { mTransAdditive=set; }
  inline void setTransAttCol(ntlColor set) { 
        ntlColor setlog = ntlColor( -log(set[0]), -log(set[1]), -log(set[2]) );
        mTransAttCol=setlog; }
    inline void setFresnel(int set) { mFresnel = set; }

};


/******************************************************************************
 * Macro to define the default surface properties for a newly created object
 *****************************************************************************/
#define GET_GLOBAL_DEFAULT_MATERIAL new ntlMaterial( "default",\
                                        ntlColor( 0.5 ), ntlColor(0.0), \
                                        1.0, 5.0, 0.0,   \
                                                                                /*0.0 test:*/ 0.5 , 1.0, 0.0, \
                                                                                ntlColor( 0.0 ), 0 ); 
                                                                                                                            


/******************************************************************************
 * Calculate reflectance and refratance from Fresnel's law
 * cf. Glassner p. 46
 *****************************************************************************/
inline void 
ntlMaterial::calculateFresnel(const ntlVec3Gfx &dir, const ntlVec3Gfx &normal, gfxReal refIndex,
                                                            gfxReal &refl, gfxReal &trans)
{
    gfxReal c = -dot(dir, normal);
    if(c<0) { 
        refl = 0.0; trans = 0.0; return;
        //c = 0.0;
    }

    gfxReal r0 = ((refIndex-1.0)*(refIndex-1.0)) /
        ((refIndex+1.0)*(refIndex+1.0));
    gfxReal omc = (1.0-c);
    gfxReal r =r0 + (1.0 - r0) * omc*omc*omc*omc*omc;

    //mMirror = r;
    //mTransparence = (1.0 - r);
    refl = r;
    trans = (1.0 - r);
    //errorOut(" fres ");
}


#endif