Inventor/elements/SoEnvironmentElement.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : R. ALBOU (Feb 1997)
**=======================================================================*/

#ifndef  _SO_ENVIRONMENT_ELEMENT_
#define  _SO_ENVIRONMENT_ELEMENT_
/* include files */
#include <Inventor/elements/SoReplacedElement.h>
#include <Inventor/SbColor.h>

/*----------------------------------------------------------------------------*/
SoEXTENDER_Documented class  SoEnvironmentElement : public SoReplacedElement {
  SO_ELEMENT_HEADER(SoEnvironmentElement) ;

 public:

  enum FogType {
    NONE,
    HAZE,
    FOG,
    SMOKE
  } ;

  struct  EnvironmentParameters {
    EnvironmentParameters();
    EnvironmentParameters(float ambientIntensity, SbColor ambientColor, SbVec3f attenuation,
                          FogType fogType, SbColor fogColor, float fogStart, float fogVisibility);

    float     ambientIntensity;
    SbColor   ambientColor;
    SbVec3f   attenuation;
    FogType   fogType;
    SbColor   fogColor;
    float     fogStart;
    float     fogVisibility;
  };


#if 1             SoDEPRECATED
  static void set(SoState *state, SoNode *node,
                  float ambientIntensity, const SbColor &ambientColor,
                  const SbVec3f attenuation, FogType fogType, const
                  SbColor fogColor, float fogVisibility);
SoDEPRECATED
  static void get(SoState *state, float &ambientIntensity,
                  SbColor &ambientColor, SbVec3f &attenuation,
                  FogType &fogType, SbColor &fogColor, float &fogVisibility);
SoDEPRECATED
  static void getDefault(float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation,
                         FogType &fogType, SbColor &fogColor, float &fogVisibility);
#endif 
  static void set(SoState *state, SoNode *node, const EnvironmentParameters& envParams) ;

  static void get(SoState *state, EnvironmentParameters& envParams) ;

  static float          getAmbientIntensity(SoState *state) ;
  static const SbColor& getAmbientColor(SoState *state) ;
  static const SbVec3f& getLightAttenuation(SoState *state) ;

  
  // Push copies the values from the previous element
  virtual void  push(SoState *state) ;

private:

  virtual void init(SoState *state);

  virtual SbBool matches(const SoElement* elt) const;

  virtual SoElement* copyMatchInfo() const;

 private:
  
  // Initializes the SoEnvironmentElement class
  static void initClass() ;
  static void exitClass() ;

private:
  float     m_ambientIntensity ;
  SbColor   m_ambientColor ;
  SbVec3f   m_attenuation ;
  FogType   m_fogType ;
  SbColor   m_fogColor ;
  float     m_fogStart ;
  float     m_fogVisibility ;

#if 1             
  virtual void setElt(float ambientIntensity, const SbColor &ambientColor,
                      const SbVec3f attenuation, FogType fogType, const
                      SbColor fogColor, float fogVisibility);
#endif 
  virtual void setElt(const EnvironmentParameters& envParams) ;

  virtual ~SoEnvironmentElement() ;

} ;

/*----------------------------------------------------------------------------*/

#endif // _SO_ENVIRONMENT_ELEMENT_

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/