SoPreferences.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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
/*==============================================================================
*   Classes     : SoPreferences
*   Author(s)   : Fabien ARNAUD
*   Date        : Jul, 18 2002
*                 Feb, 20 2003
*==============================================================================
*
* Description : Manage environment variables and configuration file
*
*============================================================================*/
 
 
#ifndef _SB_ENVIRONMENT_VARS_H
#define _SB_ENVIRONMENT_VARS_H
 
#include <Inventor/SbBase.h>
#include <Inventor/SbDict.h>
#include <Inventor/SbColor.h>
#include <Inventor/SbVec.h>
 
#include <Inventor/threads/SbThreadMutex.h>
 
class  SoPreferences {
 public:
  // Retrieving values
 
  SoNONUNICODE static const char* getValue (const char* name);
 
  static const SbString* getStringValue( const SbString& name );
 
  SoNONUNICODE static SbBool getBool( const char* name, SbBool defaultValue );
 
  static SbBool getBool( const SbString& name, SbBool defaultValue );
 
  SoNONUNICODE static int getInt( const char* name, int defaultValue );
 
  static int getInt( const SbString& name, int defaultValue);
 
  SoNONUNICODE static long getLong( const char* name, long defaultValue );
 
  static long getLong( const SbString& name, long defaultValue );
 
  SoNONUNICODE static float getFloat( const char* name, float defaultValue );
 
  static float getFloat( const SbString& name, float defaultValue );
 
  SoNONUNICODE static double getDouble( const char* name, double defaultValue );
 
  static double getDouble( const SbString& name, double defaultValue );
 
  SoNONUNICODE static const SbString& getString (const char* name, const SbString& defaultValue);
 
  static const SbString& getString( const SbString& name, const SbString& defaultValue );
 
  SoNONUNICODE static const SbVec3f& getVec3f( const char* name, const SbVec3f& defaultValue );
 
  static const SbVec3f& getVec3f( const SbString& name, const SbVec3f& defaultValue );
 
  SoNONUNICODE static const SbVec2s& getVec2s( const char* name, const SbVec2s& defaultValue );
 
  static const SbVec2s& getVec2s( const SbString& name, const SbVec2s& defaultValue );
 
  SoNONUNICODE static const SbColor& getColor( const char* name, const SbColor& defaultValue );
 
  static const SbColor& getColor( const SbString& name, const SbColor& defaultValue );
 
 
  // Setting values
 
  SoNONUNICODE static void setValue( const char* name, const char* value = NULL );
 
  static void setValue( const SbString& name, const SbString* value = NULL );
 
  SoNONUNICODE static void setBool( const char* name, SbBool value );
 
  static void setBool( const SbString& name, SbBool value );
 
  SoNONUNICODE static void setInt( const char* name, int value );
 
  static void setInt( const SbString& name, int value );
 
  SoNONUNICODE static void setLong( const char* name, long value );
 
  static void setLong( const SbString& name, long value );
 
  SoNONUNICODE static void setFloat( const char* name, float value );
 
  static void setFloat( const SbString& name, float value );
 
  SoNONUNICODE static void setDouble( const char* name, double value );
 
  static void setDouble( const SbString& name, double value );
 
    SoNONUNICODE static void setString (const char* name, const SbString& value);
 
    static void setString( const SbString& name, const SbString& value );
 
  SoNONUNICODE static void setVec3f( const char* name, const SbVec3f& value );
 
  static void setVec3f( const SbString& name, const SbVec3f& value );
 
  SoNONUNICODE static void setVec2s( const char* name, const SbVec2s& value );
 
  static void setVec2s( const SbString& name, const SbVec2s& value );
 
  SoNONUNICODE static void setColor( const char* name, const SbColor& value );
 
 
  static void setColor( const SbString& name, const SbColor& value );
 
  SoNONUNICODE static void readFile (const char* filename);
 
  static void readFile (const SbString& filename);
 
 private:
  static SbDict* s_dictionary;
  static SbThreadMutex s_mutex;
  static void initialize ();
  static SbString s_unspecifiedValue;
  static bool s_verbose_env;
 
private:
  static void clean();
 
  class SoPreferencesImpl;
  friend class SoPreferencesImpl; //VC6 doesn't allow inner classes to access private members
 
};
#endif // _SB_ENVIRONMENT_VARS_H