HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
UT_EnvControl Class Reference

#include <UT_EnvControl.h>

Public Member Functions

 UT_EnvControl ()
 
 ~UT_EnvControl ()
 
 UT_EnvControl (const UT_EnvControl &)=delete
 
UT_EnvControl & operator= (const UT_EnvControl &)=delete
 
void init ()
 

Static Public Member Functions

static int getInt (UT_IntControl i)
 
static fpreal getFloat (UT_FltControl i)
 
static const char * getString (UT_StrControl i)
 
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)
 
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 bool varChanged (const char *varname, const char *value)
 
static void changeExistLookupDefault (UT_IntControl i, int new_def)
 
static UT_Variant getVarValue (const char *varname)
 
static void setAdditionalEnvironmentFiles (const UT_StringArray &files)
 
static const UT_StringArray & getAdditionalEnvironmentFiles ()
 Return the current list of additional environment files. More...
 
static void logMessages ()
 
static void loadPackages (UT_StringArray const &pkg_paths, UT_Package::Loader &pkg_loader)
 
static UT_Package::Package & loadPackage (char const *pkg_filepath, UT_Package::Loader &pkg_loader)
 
static UT_Package::Loader & packageLoader ()
 

Detailed Description

Definition at line 898 of file UT_EnvControl.h.

Constructor & Destructor Documentation

UT_EnvControl::UT_EnvControl ( )
UT_EnvControl::~UT_EnvControl ( )
UT_EnvControl::UT_EnvControl ( const UT_EnvControl &  )
delete

Member Function Documentation

static void UT_EnvControl::changeExistLookupDefault ( UT_IntControl  i,
int  new_def 
)
static
static const UT_StringArray& UT_EnvControl::getAdditionalEnvironmentFiles ( )
static

Return the current list of additional environment files.

static fpreal UT_EnvControl::getFloat ( UT_FltControl  i)
inlinestatic

Definition at line 911 of file UT_EnvControl.h.

static const char* UT_EnvControl::getFloatVar ( UT_FltControl  i)
static
static int UT_EnvControl::getInt ( UT_IntControl  i)
inlinestatic

Definition at line 909 of file UT_EnvControl.h.

static const char* UT_EnvControl::getIntVar ( UT_IntControl  i)
static
static const char* UT_EnvControl::getOldFloatVar ( UT_FltControl  i)
static
static const char* UT_EnvControl::getOldIntVar ( UT_IntControl  i)
static
static const char* UT_EnvControl::getOldStringVar ( UT_StrControl  i)
static
static const char* UT_EnvControl::getString ( UT_StrControl  i)
inlinestatic
Examples:
FS/FS_HomeHelper.C.

Definition at line 913 of file UT_EnvControl.h.

static const char* UT_EnvControl::getStringVar ( UT_StrControl  i)
static
static UT_Variant UT_EnvControl::getVarValue ( const char *  varname)
static

Queries the cached variable value. Unrecognized variables are returned as UT_Variant::Type::Unknown. String values are returned as UT_Variant::Type::Pointer to allow distinguishing between null pointers and empty strings. If you intend to hold onto the string value beyond immediately using it, you must make your own copy!

void UT_EnvControl::init ( )
static UT_Package::Package& UT_EnvControl::loadPackage ( char const *  pkg_filepath,
UT_Package::Loader &  pkg_loader 
)
static
static void UT_EnvControl::loadPackages ( UT_StringArray const &  pkg_paths,
UT_Package::Loader &  pkg_loader 
)
static
static void UT_EnvControl::logMessages ( )
inlinestatic

Definition at line 971 of file UT_EnvControl.h.

UT_EnvControl& UT_EnvControl::operator= ( const UT_EnvControl &  )
delete
static UT_Package::Loader& UT_EnvControl::packageLoader ( )
static
static void UT_EnvControl::setAdditionalEnvironmentFiles ( const UT_StringArray &  files)
static

Set all additional .env files to be parsed for env variable values. It is best to call getAdditionalEnvironmentFiles() first and then append to the list because this function will overwrite all the additional paths that were previously set. You can still use the HOUDINI_NO_ENV_FILE_OVERRIDES to disallow overwrites, knowing that these files get applied AFTER the default houdini.env file in the user's home directory. That said, HOUDINI_NO_ENV_FILE will have no effect on this function. If additional files are set, they will be used, regardless of the value of HOUDINI_NO_ENV_FILE.

static void UT_EnvControl::setStringVar ( UT_StrControl  i,
const char *  value 
)
static
static void UT_EnvControl::varChanged ( const char *  varname)
inlinestatic

Indicate that the given variable changed and update our cached values. If varname is NULL, then all variables are updated.

Definition at line 931 of file UT_EnvControl.h.

static bool UT_EnvControl::varChanged ( const char *  varname,
const char *  value 
)
static

Update the cached varname value with the given value so that we can avoid an extraneous HoudiniGetenv() for the equivalent code snippet:

HoudiniSetenv(name, value);
UT_EnvControl::varChanged(name);
Returns
true if name was found and value is non-null, in which case the HoudiniSetenv() was called, else false is returned.
The documentation for this class was generated from the following file: