UT/UT_EnvControl.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        UT_EnvControl.h ( UT Library, C++)
 *
 * COMMENTS:    In Houdini applications, there are many environment variables
 *              which control the behaviour of certain features/capabilities.
 *              This class provides a centralized place to efficiently query
 *              these variables.  The reason for the centralization is so that
 *              we can easily get a list of these control variables.  As well,
 *              this mechanism provides ways of changing the control settings
 *              from environment variables to disk file to registry entry.
 *              Currently only environment variable control is supported.
 *
 *
 *   When adding a new environment variable, please document the variable in
 *   $SHS/help/config.src. 
 */

#ifndef __UT_EnvControl__
#define __UT_EnvControl__

#include "UT_API.h"
#include <SYS/SYS_Types.h>

enum UT_IntControl {
    // UT library: Public interface
    ENV_HOUDINI_WINDOW_CONSOLE,
    ENV_HOUDINI_CONSOLE_LINES,
    ENV_HOUDINI_DISABLE_CONSOLE,
    ENV_HOUDINI_TEXT_CONSOLE,
    ENV_HOUDINI_VERBOSE_ERROR,
    ENV_HOUDINI_INTERRUPT_THRESH,
    ENV_HOUDINI_OLD_SPINNER,
    ENV_HOUDINI_HSERVER_PORT,
    ENV_HOUDINI_DISABLE_CPUID,
    ENV_HOUDINI_DISABLE_MMX,
    ENV_HOUDINI_DISABLE_XMMX,
    ENV_HOUDINI_DISABLE_SSE,
    ENV_HOUDINI_DISABLE_3DNOW,
    ENV_HOUDINI_OSX_SWAP_DEL_AND_BACKSPACE,
    
    // UT: Internal controls
    ENV_HOUDINI_COREDUMP,
    ENV_HOUDINI_UI_COREDUMP,
    ENV_HOUDINI_SYSTRACE,
    ENV_HOUDINI_ENABLE_UNDO_LOG,
    ENV_HOUDINI_INTERRUPT_DEBUG,
    ENV_HOUDINI_NO_ASSERTS,
    ENV_HOUDINI_INTERACTIVE_ASSERTS,
    ENV_HOUDINI_ACCESS_METHOD,
    
    // Houdini Environment File Control
    ENV_HOUDINI_NO_ENV_FILE_OVERRIDES,
    ENV_HOUDINI_NO_ENV_FILE,
    
    // FS: Public interface
    ENV_HOUDINI_DSO_ERROR,
    ENV_HOUDINI_CPP_EXPAND_PRAGMA,

    // IMG3D: Public interface
    ENV_HOUDINI_TEX3D_USAGE,

    // IMG: Public interface
    ENV_HOUDINI_CINEON_WHITE_POINT,
    ENV_HOUDINI_CINEON_BLACK_POINT,
    ENV_HOUDINI_CINEON_FULL_RANGE,
    ENV_HOUDINI_TIFF_SAMPLEFORMAT,
    ENV_HOUDINI_TIFF_BOTTOMLEFT,
    ENV_HOUDINI_DISABLE_IMAGE_DSO,
    ENV_HOUDINI_RAT_USAGE,
    ENV_HOUDINI_THREAD_IMAGE,
    ENV_HOUDINI_MDISPLAY_WAIT,
    // IMG: Private interface
    ENV_HOUDINI_MIP_READ,
    ENV_HOUDINI_FB_FILTER_ORIGINAL,
    ENV_HOUDINI_SOCKET_PORT,
    ENV_HOUDINI_AUDIT_IO,
    ENV_HOUDINI_OLD_RATS,

    // MV: Public interface
    ENV_HOUDINI_QTML_USE_GDI,

    // VEX: Public interface
    ENV_HOUDINI_VEX_OLD_DERIV,
    // VEX: Private interface
    ENV_HOUDINI_VEX_URANDOM,
    ENV_HOUDINI_DISABLE_UNSAFE_VEX,
    ENV_HOUDINI_VEX_OPTIMIZER,

    // RE: Public interface
    ENV_HOUDINI_OVERRIDE_XRES,
    ENV_HOUDINI_OVERRIDE_YRES,
    ENV_HOUDINI_UISCALE,
    ENV_HOUDINI_OGL_SOFTWARE,
    ENV_HOUDINI_OGL_HARDWARE,
    ENV_HOUDINI_OGL_ERROR_CHECK,
    ENV_HOUDINI_OGL_ENABLE_PBUFFER,
    ENV_HOUDINI_OGL_OVERLAY_SUPPORT,
    ENV_HOUDINI_OGL_DISABLE_RASTER_IN_OVERLAY,
    ENV_HOUDINI_OGL_MARQUEE_FIX,
    ENV_HOUDINI_OGL_INT_RASTER_ZOOM_ONLY,
    ENV_HOUDINI_OGL_FAST_ORDER2,
    ENV_HOUDINI_OGL_ALPHA_PIXMAP,
    ENV_HOUDINI_OGL_ENABLE_TEXTURE_SEQUENCES,
    ENV_HOUDINI_OGL_DISABLE_FBO_RENDER_TO_TEXTURE,
    ENV_HOUDINI_OGL_DISABLE_FBO,
    ENV_HOUDINI_OGL_BITMAP_POINT_MARKERS,
    ENV_HOUDINI_OGL_ENABLE_SHADERS,
    ENV_HOUDINI_OGL_SHADOWMAP_SIZE,

    // CMD
    ENV_HOUDINI_HIP_FROM_PATH,

    // OP
    ENV_HOUDINI_NO_EXPORT_RENAME,
    ENV_HOUDINI_SCRIPT_DEBUG,
    ENV_HOUDINI_COOK_MODE_THRESHOLD,

    // GEO
    ENV_HOUDINI_RMAN_CURVE_STEP,

    // GU
    ENV_HOUDINI_GU_DEBUG,

    // VRAY
    ENV_MANTRA_FORCE_RAY,
    ENV_MANTRA_NOFOGBOX,
    ENV_MANTRA_BIAS_NORMAL,
    ENV_MANTRA_DEBUGMEMORY,

    // COP
    ENV_HOUDINI_HSVCOP_COMPAT,
    ENV_HOUDINI_COP_MOVIE_FAKEREAD,

    // IFD
    ENV_HOUDINI_RMAN_INCLUDE_FIX,
    ENV_HOUDINI_MI_DONT_FLIP_RMAP,
    ENV_HOUDINI_DISABLE_SOHO_SPOOLING,

    // MAT
    ENV_HOUDINI_DISABLE_SAVE_THUMB,

    // UI
    ENV_HOUDINI_UI_DEBUG,
    ENV_HOUDINI_ENABLE_FPS_SCALE,
    ENV_HOUDINI_UI_QUEUE_SIZE,
    ENV_HOUDINI_UI_QUEUE_DEBUG,
    ENV_HOUDINI_X11_SYNCHRONOUS,
    ENV_HOUDINI_WRITE_BINARY_ICONS,
    ENV_HOUDINI_NO_SPLASH,
    ENV_HOUDINI_RASTER_DISPLAY_FIX,
    ENV_HOUDINI_ENABLE_LINUX_TABLET,
    ENV_HOUDINI_USE_NATIVE_FILE_CHOOSER,
    ENV_HOUDINI_MAX_FILE_HISTORY,

    // FP
    ENV_HOUDINI_FPS,

    // OPUI
    ENV_HOUDINI_PERFORMANCE_SIZE,
    ENV_HOUDINI_BUFFEREDSAVE,
    ENV_HOUDINI_HIPEXT,
    ENV_HOUDINI_ENABLE_OLD_PRESETS,

    // DM
    ENV_HOUDINI_SKIP_NAME,

    // GUI
    ENV_HOUDINI_DISABLE_DISPLAYLIST,
    ENV_HOUDINI_DISPLAYLIST_DELAY,

    // GR
    ENV_HOUDINI_DISABLE_POLYTESS_CACHE,

    // MATUI
    ENV_HOUDINI_TOP_POS_SINGLE_PASS,

    // Custom
    ENV_HOUDINI_COP_TESTFRACTION,
    ENV_HOUDINI_ABEKAS_PAL_XRES,
    ENV_HOUDINI_ABEKAS_PAL_YRES,
    ENV_HOUDINI_IPLAY_IP,

    // LM
    ENV_HOUDINI_NOHKEY,
    ENV_HOUDINI_NOHKEY_APPRENTICE,

    // CHOP
    ENV_HOUDINI_CHOP_OLDNOISE,

    // SHOP
    ENV_HOUDINI_FULL_SHADERSTRING,

    // VOP
    ENV_HOUDINI_RSL_HASHING,

    // SHLF
    ENV_HOUDINI_NO_DEFAULT_SHELF_TOOLS,

    // Other
    ENV_HOUDINI_CONDENSE_HIP,

    // Backwards Compatability
    ENV_HOUDINI4_COMPATIBILITY,
    ENV_HOUDINI55_COMPATIBILITY,
    ENV_HOUDINI6_COMPATIBILITY,
    ENV_HOUDINI7_COMPATIBILITY,
    ENV_HOUDINI8_COMPATIBILITY,
    ENV_HOUDINI95_COMPATIBILITY,

    ENV_HOUDINI6_FILTER_COMPATIBILITY,
    ENV_HOUDINI_MUV_ATTRIB_COMPATIBILITY,
    ENV_HOUDINI_SIMPLIFIED_NODE_NAMES,

    ENV_HOUDINI_LMINFO_VERBOSE,

    // hscript
    ENV_HSCRIPT_NO_HISTORY,
    ENV_HSCRIPT_SAFEQUIT,

    ENV_HOUDINI_OLD_CONST_BEHAVIOUR,

    // OS-Specific to work around various system specific bugs
    ENV_HOUDINI_IRIX_OSTRSTREAM_MAX_SIZE,

    // This is for "internal use" only.  It turns on features that are not
    // ready for prime-time.
    ENV_HOUDINI_EXPERIMENTAL,

    // Maximum number of files to keep in the backup directory
    ENV_HOUDINI_MAX_BACKUP_FILES,

    ENV_HOUDINI_JITTERY_CAMERA,

    ENV_HOUDINI_ERRORLOG_LEVEL,

    ENV_HOUDINI_MAXTHREADS,
    ENV_HOUDINI_MAXSPUS,

    ENV_HOUDINI_MMB_PAN,
    ENV_HOUDINI_INTERNAL_IGNORE_SIGNALS,

    ENV_HOUDINI_EXTERNAL_HELP_BROWSER,

    ENV_HOUDINI_CASE_SENSITIVE_FS,

    // Allows the user to set their own width of 
    // the middle section of each node.
    ENV_HOUDINI_NODE_WIDTH,

    // Controls the number of complete FBX scenes to
    // keep cached in memory after import. Defaults to 1.
    ENV_HOUDINI_MAX_CACHED_FBX_SCENES,
    ENV_HOUDINI_NETEXCHANGE_HEARTBEAT,
    
    ENV_HOUDINI_MAX_VOLUME_RES,

    ENV_MAX_INT_CONTROLS
};

enum UT_FltControl {
    // UT: Public interface
    ENV_HOUDINI_GAUSS_EXP,
    ENV_HOUDINI_MITCHELL_B,
    ENV_HOUDINI_MITCHELL_C,

    // UT: Internal variables
    ENV_HOUDINI_SYSTRACE_THRESH,

    // IMG: Public interface
    ENV_HOUDINI_CINEON_FILM_GAMMA,
    ENV_HOUDINI_IMAGE_DISPLAY_GAMMA,

    // UI
    ENV_HOUDINI_CHOP_LINE_WIDTH,
    ENV_HOUDINI_COLOR_PICKER_GAMMA,
    ENV_HOUDINI_LINUX_DOUBLE_CLICK_TIME,

    // GR
    ENV_HOUDINI_LOD,

    // Custom
    ENV_HOUDINI_WF_GAMMA,

    // ROP: Internal variables
    ENV_HOUDINI_CHECK_XFORM,

    ENV_MAX_FLT_CONTROLS
};

enum UT_StrControl {
    // UT: Public interface
    ENV_HOME,
    ENV_USER,
    ENV_EDITOR,
    ENV_VISUAL,
    ENV_SHELL,
    ENV_HFS,
    ENV_HOUDINI_OS,
    ENV_HOUDINI_TEMP_DIR,
    ENV_HOUDINI_DESKTOP_DIR,
    ENV_HOUDINI_UNDO_DIR,
    ENV_HOUDINI_MESSAGE_CMD,
    ENV_HOUDINI_CONFIRM_CMD,
    ENV_HOUDINI_ASSERT_CMD,
    ENV_HOUDINI_WEB_BROWSER_CMD,

    // UT: Internal variables
    ENV_HOUDINI_SYSTRACE_FILENAME,

    // IMG: Public interface
    ENV_HOUDINI_DEF_TEXTURE_COLOR,

    // VEX(VMAT)
    ENV_HOUDINI_DEFAULT_SURFACE,
    ENV_HOUDINI_DEFAULT_LIGHT,
    ENV_HOUDINI_DEFAULT_PHOTON,
    ENV_HOUDINI_DEFAULT_AMBIENT,
    ENV_HOUDINI_DEFAULT_MATTE,
    ENV_HOUDINI_DEFAULT_OGLSURF,
    ENV_HOUDINI_DEFAULT_OGLSEL,
    ENV_HOUDINI_DEFAULT_SHADOW,

    // RE
    ENV_HOUDINI_OGL_DISABLE_SMOOTH_STIPPLED_LINES,

    // HOM
    ENV_HOUDINI_SCRIPT_LICENSE,

    // OP
    ENV_HOUDINI_COPY_SUFFIX,

    // GEO
    ENV_HOUDINI_RMAN_CURVE_BASIS,

    // COP
    ENV_HOUDINI_CINEON_RENDER_LUT,
    ENV_HOUDINI_CINEON_PREVIEW_LUT,
    ENV_HOUDINI_COP_DISKDEFAULT,
    ENV_HOUDINI_IMAGE_DISPLAY_LUT,
    ENV_HOUDINI_IMAGE_INSPECT_LUT,

    // CHOP
    ENV_HOUDINI_UNITS,

    // IFD
    ENV_HOUDINI_MANTRA_SHADOW,
    ENV_HOUDINI_MANTRA_REFLECT,
    ENV_HOUDINI_RI_SHADERPATH,
    ENV_HOUDINI_RI_TEXTUREPATH,
    ENV_HOUDINI_RI_EYESPLITS,

    // UI
    ENV_HOUDINI_FILE_VIEWER,
    ENV_HOUDINI_UI_PATH,
    ENV_HOUDINI_UI_RESOURCES,
    ENV_HOUDINI_UI_APP_PATH,
    ENV_HOUDINI_UI_AUDIO_PATH,
    ENV_HOUDINI_UI_CURSOR_PATH,
    ENV_HOUDINI_UI_ICON_PATH,
    ENV_HOUDINI_ICON_CACHE_DIR,

    // FUI
    ENV_HOUDINI_STPATH,
    ENV_HOUDINI_STEDIT,

    // CHUI
    ENV_HOUDINI_CHOP_IMAGE,

    // OPUI
    ENV_HOUDINI_DOUBLEBUFFER,
    ENV_HOUDINI_WORKSHEET_BOXPICK,
    ENV_HOUDINI_DEFOPTYPEPREFIX,

    // Custom
    ENV_HOUDINI_VRML_CONVERT,
    ENV_HOUDINI_VRML2_CONVERT,
    ENV_HOUDINI_ABEKAS_LOGIN_NAME,
    ENV_HOUDINI_ABEKAS_LOGIN_PASS,
    ENV_HOUDINI_MPLAY_WRITE_CMD,
    ENV_HOUDINI_MPLAY_FLIP_CMD,
    ENV_HOUDINI_MPLAY_LOCKPATH,
    ENV_HOUDINI_PLAY_WRITE_CMD,
    ENV_HOUDINI_PLAY_FLIP_CMD,
    ENV_HOUDINI_VIEW_METACAM,   //OTLs that lock to view in a special way

    // Path variables
    ENV_HOUDINI_PATH,
    ENV_HOUDINI_DSO_PATH,
    ENV_HOUDINI_IMAGE_DSO_PATH,
    ENV_HOUDINI_AUDIO_DSO_PATH,
    ENV_HOUDINI_OTL_PATH,
    ENV_HOUDINI_OPLIBRARIES_PATH,
    ENV_HOUDINI_OTLSCAN_PATH,
    ENV_HOUDINI_SCRIPT_PATH,
    ENV_HOUDINI_SOHO_PATH,
    ENV_HOUDINI_GALLERY_PATH,
    ENV_HOUDINI_DESKTOP_PATH,
    ENV_HOUDINI_MACRO_PATH,
    ENV_HOUDINI_TOOLBAR_PATH,
    ENV_HOUDINI_CUSTOM_PATH,

    ENV_HOUDINI_TEXTURE_PATH,
    ENV_HOUDINI_GEOMETRY_PATH,
    ENV_HOUDINI_CLIP_PATH,

    ENV_HOUDINI_VEX_PATH,

    ENV_HOUDINI_GLSL_PATH,

    ENV_HOUDINI_OUTLINEFONT_PATH,

    ENV_HOUDINI_BACKUP_DIR,

    ENV_HOUDINI_BACKUP_FILENAME,
    ENV_HOUDINI_AUTOSAVE_FILENAME,

    ENV_HOUDINI_VIEW_MANTRA,
    ENV_HOUDINI_VIEW_RMAN,
    ENV_HOUDINI_DEFAULT_RIB_RENDERER,
    ENV_HOUDINI_RIBSHADER_DIR,

    ENV_HOUDINI_THUMB_RENDER,

    // These are here so we can have them show up in hconfig and provide
    // help.  They should only be used implicitly.
    ENV_HSITE,          // Between HFS and HOME.
    ENV_JOB,            // We should not use JOB!

    ENV_HOUDINI_ERRORLOG_FILENAME,

    ENV_HOUDINI_SPLASH_MESSAGE,

    ENV_MAX_STR_CONTROLS
};

class UT_API UT_EnvControl {
public:
     UT_EnvControl();
    ~UT_EnvControl();

    static int           getInt(UT_IntControl i)
                                { return getControl().myIValues[i]; }
    static fpreal        getFloat(UT_FltControl i)
                                { return getControl().myFValues[i]; }
    static const char   *getString(UT_StrControl i)
                                { return getControl().mySValues[i]; }

    // Look up the appropriate variable name for the token
    static const char   *getIntVar(UT_IntControl i);
    static const char   *getFloatVar(UT_FltControl i);
    static const char   *getStringVar(UT_StrControl i);

    static void          setStringVar(UT_StrControl i, const char *value);

    // Look up the appropriate old style variable name for the token.  This can
    // be used to check for old environment variables.
    static const char   *getOldIntVar(UT_IntControl i);
    static const char   *getOldFloatVar(UT_FltControl i);
    static const char   *getOldStringVar(UT_StrControl i);

    static void          varChanged(const char *varname);

    static void          initialize()   { getControl().doInit(); }

private:
    void                 doInit();
    void                 setDefaults();
    void                 loadEnvironmentFile();
    void                 loadEnvironment();

    int                          myIValues[ENV_MAX_INT_CONTROLS];
    float                        myFValues[ENV_MAX_FLT_CONTROLS];
    char                        *mySValues[ENV_MAX_STR_CONTROLS];

    static UT_EnvControl        &getControl()
                                 {
                                    if (!theControl)
                                        theControl = new UT_EnvControl();
                                    return *theControl;
                                 }
    static UT_EnvControl        *theControl;
};

#endif

---