SoLight.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
 **=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
 **=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_LIGHT_
#define  _SO_LIGHT_
 
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFColor.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/SbViewportRegion.h>
 
class SoCamera;
 
//
//  Class: SoLight
//
//  Abstract base light source node.
//
 
class  SoLight : public SoNode
{
 
  SO_NODE_ABSTRACT_HEADER( SoLight );
 
public:
  SoSFBool on;
 
  SoSFFloat intensity;
 
  SoSFColor color;
 
private:
  virtual void callback( SoCallbackAction* action );
 
  virtual void doAction( SoAction* action );
 
private:
  virtual inline SoCamera* getCamera( SoState* state, SoPath* scene, float visibilityLength );
 
  static void initClass();
  static void exitClass();
 
  // Returns the light Id.
  int32_t getLightId() const;
 
  struct LightConfiguration
  {
    bool enabled;
    SbVec4f position;
    SbMatrix transform;
 
    SbVec3f spotDirection;
    float spotExponent;
    float spotCutoff;
 
    SbVec4f ambientIntensity;
    SbVec4f diffuseIntensity;
    SbVec4f specularIntensity;
 
    float constantAttenuation;
    float linearAttenuation;
    float quadraticAttenuation;
 
    LightConfiguration()
      : transform(1, 0, 0, 0,
                  0, 1, 0, 0,
                  0, 0, 1, 0,
                  0, 0, 0, 1)
    {
      enabled = false;
      position = SbVec4f( 0, 0, 0, 0 );
      spotDirection = SbVec3f( 0, 0, -1 );
      spotExponent = 0.0f;
      spotCutoff = 180.0f;
      ambientIntensity = SbVec4f( 0, 0, 0, 1 );
      diffuseIntensity = SbVec4f( 1, 1, 1, 1 );
      specularIntensity = SbVec4f( 1, 1, 1, 1 );
      constantAttenuation = 1.0f;
      linearAttenuation = 0.0f;
      quadraticAttenuation = 0.0f;
    }
  };
 
  LightConfiguration lightConfiguration;
 
private:
  struct Members
  {
    Members();
    ~Members();
    void unref();
 
    int32_t m_lightId;
    SoCamera* m_camera;
  };
  Members m_members;
 
  static SoLight::Members* getMembers( const SoLight* sg );
 
  SoLight(); // Makes this abstract
 
  virtual ~SoLight();
};
 
/*******************************************************************************/
SoCamera*
SoLight::getCamera( SoState*, SoPath*, float )
{
  return NULL;
}
 
#endif /* _SO_LIGHT_ */