X3DLightNode.h

Go to the documentation of this file.

//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __X3DLIGHTNODE_H__
#define __X3DLIGHTNODE_H__
 
#include <H3D/X3DChildNode.h>
#include <H3D/H3DDisplayListObject.h>
#include <H3D/H3DRenderStateObject.h>
#include <H3D/SFFloat.h>
#include <H3D/SFColor.h>
 
namespace H3D {
 
  class H3DAPI_API X3DLightNode : 
    public X3DChildNode,
    public H3DDisplayListObject,
    public H3DRenderStateObject {
  public:
 
    struct GLLightInfo {
      GLLightInfo (
                   RGBA _ambient    = RGBA(0.0f,0.0f,0.0f, 1.0f), 
                   RGBA _diffuse    = RGBA(0.0f,0.0f,0.0f,1.0f), 
                   RGBA _specular   = RGBA(0.0f,0.0f,0.0f,1.0f), 
        Vec4f _position = Vec4f(0.0f,0.0f,0.0f,0.0f),
        Vec3f _spotDirection= Vec3f(),
        H3DFloat _spotExponent= 0,
        H3DFloat _spotCutoff= 180.0f,
        H3DFloat _constantAttenuation= 0.0f,
        H3DFloat _linearAttenuation= 0.0f, 
        H3DFloat _quadraticAttenuation= 0.0f ) : 
          ambient ( _ambient ), 
          diffuse ( _diffuse ), 
          specular ( _specular ),
          position ( _position ),
          spotDirection ( _spotDirection ),
            spotExponent( _spotExponent ),
          spotCutoff ( _spotCutoff ),
          linearAttenuation ( _linearAttenuation ), 
          constantAttenuation( _constantAttenuation ),
          quadraticAttenuation ( _quadraticAttenuation ) {}
 
      RGBA ambient;   
      RGBA diffuse;   
      RGBA specular;  
      Vec4f position;
      Vec3f spotDirection;
      H3DFloat spotExponent;
      H3DFloat spotCutoff;          // (range: [0.0,90.0], 180.0) 
      H3DFloat linearAttenuation; 
      H3DFloat constantAttenuation; 
      H3DFloat quadraticAttenuation;    
      
      bool isDirectionalLight() {
        return position.w == 0;
      }
 
      bool isPointLight() {
        return !isDirectionalLight() && spotCutoff == 180;
      }
 
      bool isSpotLight() {
        return !isDirectionalLight() && !isPointLight();
      }
 
    };
 
    X3DLightNode( Inst< SFNode >  _metadata         = 0,
                  Inst< SFFloat>  _ambientIntensity = 0,
                  Inst< SFColor>  _color            = 0,
                  Inst< SFBool >  _global           = 0,
                  Inst< SFFloat>  _intensity        = 0,
                  Inst< SFBool >  _on               = 0,
                  Inst< SFBool >  _shadows          = 0 );
 
    virtual void enableGraphicsState();
 
    virtual void disableGraphicsState();
 
    virtual GLLightInfo getGLLightInfo() 
#ifndef H3D_GENERATE_DOTROUTE_FILES
                                        = 0;
#else
    { return GLLightInfo (RGBA(0.0f,0.0f,0.0f, 1.0f), RGBA(0.0f,0.0f,0.0f,1.0f), 
                   RGBA(0.0f,0.0f,0.0f,1.0f), Vec4f(0.0f,0.0f,0.0f,0.0f), Vec3f(), 0,
           180.0f, 0.0f, 0.0f, 0.0f ); }
#endif
 
    virtual void enableHapticsState( TraverseInfo &ti );
 
    virtual void disableHapticsState( TraverseInfo &ti );
 
    virtual void traverseSG( TraverseInfo &ti );
 
    static GLuint getLightIndex( string name_for_error );
 
    static void decreaseLightIndex() { --global_light_index; }
 
    H3DUniquePtr< SFFloat >  ambientIntensity;
 
    H3DUniquePtr< SFColor >  color;
 
    H3DUniquePtr< SFBool > global;
 
    H3DUniquePtr< SFFloat >  intensity;
 
    H3DUniquePtr< SFBool > on;
 
    H3DUniquePtr< SFBool > shadows;
 
    static H3DNodeDatabase database;
 
  protected:
    GLuint light_index;
    static GLint max_lights;
    static GLint global_light_index;
 
    TraverseInfo * last_ti_ptr;
 
    H3DInt32 traverse_sg_counter;
    H3DInt32 graphics_state_counter;
 
    vector< Matrix4f > global_light_transforms;
 
    bool act_global;
 
    list< bool > had_light_index;
  };
}
 
#endif