UserPreference String Constant


Variables

const wchar_t *  siAutoInspect
const wchar_t *  siCompensationFlag
const wchar_t *  siCustomCommandLibCache
const wchar_t *  siCustomOperatorLibCache
const wchar_t *  siDisplayCallbackLibCache
const wchar_t *  siDisplayLibCache
const wchar_t *  siDisplayPassLibCache
const wchar_t *  siEventLibCache
const wchar_t *  siFilterLibCache
const wchar_t *  siMenuLibCache
const wchar_t *  siPropertyLibCache
const wchar_t *  siRTShaderLibCache
const wchar_t *  siScrCommandLogEnabled
const wchar_t *  siScrCommandLogFileName
const wchar_t *  siScrCommandLogMaxSize
const wchar_t *  siScrCommandLogToFile
const wchar_t *  siScrCommandLogUnlimitedSize
const wchar_t *  siScrLanguage
const wchar_t *  siScrMessageLogEnabled
const wchar_t *  siScrRealTimeMessagingEnabled
const wchar_t *  siTimeDisplayFormatDisplayAsFrames
const wchar_t *  siTimeDisplayFormatDisplayUserFormat
const wchar_t *  siTimeDisplayFormatUserFormat
const wchar_t *  siTimeFormatDefaultFrameFormat
const wchar_t *  siTimeFormatDefaultFrameRate
const wchar_t *  siTransformAxisMode
const wchar_t *  siTransformRefMode
const wchar_t *  siUILayoutDefault

Detailed Description

All user preference string constants.

Note: You can use either the name of the constant (under the Constant column) or the string it represents (under the Value column), as long as you remember that the Value is a string (so you need to use quotation marks), but the Constant is an enum, so you can't use quotation marks.
See also:
GetUserPref, SetUserPref, siDefaultTimeFormat, siDisplayTimeFormat

Variable Documentation

const wchar_t* siAutoInspect

["AutoInspectEnabled"] TRUE to force the property dialogs to automatically pop up on object creation.

Corresponds to User Preferences > Interaction > General > Automatically Popup Property Editors on Node Creation in the User Interface.

Note: This preference cannot be changed permanently via scripting. SeeProperty Editor Automatic Inspection for more information.

const wchar_t* siCompensationFlag

["SI3D_CONSTRAINT_COMPENSATION_MODE"] Toggle the Comp button in the Constrain panel.

Possible values are:

0 = off<br>
1 = on<br>
Corresponds to Constrain < Compensation in the main-menu.

const wchar_t* siCustomCommandLibCache

["CustomCommandLibCache"] This preference enables or disables the custom command library cache. Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siCustomOperatorLibCache

["CustomOperatorLibCache"] This preference enables or disables the custom operator library cache. Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siDisplayCallbackLibCache

["DisplayCallbackLibCache"] This preference enables or disables the custom display callback library cache. Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siDisplayLibCache

["DisplayLibCache"] This preference enables or disables the custom view library cache. Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siDisplayPassLibCache

["DisplayPassLibCache"] This preference enables or disables the custom display pass library cache. Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siEventLibCache

["EventLibCache"] This preference enables or disables the event library cache. Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siFilterLibCache

["FilterLibCache"] This preference enables or disables the custom filter library cache. Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siMenuLibCache

["MenuLibCache"] This preference enables or disables the custom menu library cache. Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siPropertyLibCache

["PropertyLibCache"] This preference enables or disables the custom property library cache. Disabling the cache allows developers to recompile a plug-in library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siRTShaderLibCache

["RTShaderLibCache"] This preference enables or disables the Realtime shader library cache. Disabling the cache allows developers to recompile an add-on library without having to unload it explicitly. Disabling a cache can drastically affect the performance of Softimage, therefore it is recommended to disable it only in the context of add-ons development. For performance reasons, the state of the cache is not persisted with the scene. By default the cache is enabled at startup, therefore users have to disable it at each session.

const wchar_t* siScrCommandLogEnabled

["SCR_CMDLOG_ENABLED"] Set to True to enable command execution logging in the scripting history window.

const wchar_t* siScrCommandLogFileName

["SCR_CMDLOG_FILENAME"] Use this user preference to specify the name of the file to use for logging commands and messages. Use siSrcCommandLogToFile to enable logging to file.

const wchar_t* siScrCommandLogMaxSize

["SCR_CMDLOG_MAXSIZE"] Use this user preference to get and set the maximum size for the scripting command/message log.

const wchar_t* siScrCommandLogToFile

["SCR_CMDLOG_TOFILE"] Set to True to log the scripting command/message to a file. Use siSrcCommandLogFileName to specify the log file name.

const wchar_t* siScrCommandLogUnlimitedSize

["SCR_CMDLOG_UNLIMITEDSIZE"] Set to True to allow the scripting command/message log to be of an unlimited size.

const wchar_t* siScrLanguage

["SCR_LANGUAGE"] Use this user preference to get and set the preferred scripting language. Possible values are:

"VB Script Language"

"JScript Language"

"PerlScript Language"

"Python ActiveX Scripting"

const wchar_t* siScrMessageLogEnabled

["SCR_MSGLOG_ENABLED"] Set to True to enable message logging in the scripting history window.

const wchar_t* siScrRealTimeMessagingEnabled

["SCR_RTMSG_ENABLED"] Set to True to enable real-time message logging in the scripting history window. Messages are delivered immediately as they arrive instead of reported at the end of the command execution.

const wchar_t* siTimeDisplayFormatDisplayAsFrames

["SI3D_TIMEDISPLAYFORMAT_DISPLAYASFRAMES"] Set to True to display time as frame.

const wchar_t* siTimeDisplayFormatDisplayUserFormat

["SI3D_TIMEDISPLAYFORMAT_DISPLAYUSERFORMAT"] Set to True to use the default frame format or false for a user selected format for display purposes.

const wchar_t* siTimeDisplayFormatUserFormat

["SI3D_TIMEDISPLAYFORMAT_USERFORMAT"] Use this user preference to specify the user display frame format. The value will be corresponding to siDisplayTimeFormat .

const wchar_t* siTimeFormatDefaultFrameFormat

["SI3D_TIMEFORMAT_DEFAULTFRAMEFORMAT"] Use this user preference to specify the default frame format. The value will be corresponding to siDefaultTimeFormat .

const wchar_t* siTimeFormatDefaultFrameRate

["SI3D_TIMEFORMAT_DEFAULTFRAMERATE"] Use this user preference to access the default frame rate.

const wchar_t* siTransformAxisMode

["3D_TRANSFO_EDITED_AXIS_CHANGED"] Set the Transformation Axis Mode.

The values to provide are actually bitmasks with bit zero for X, bit one for Y, and bit two for Z.

const wchar_t* siTransformRefMode

["3D_TRANSFO_REFERENTIAL_CHANGED"] Set the TransRefValues values for a list of possible values.

const wchar_t* siUILayoutDefault

["UI_LAYOUT_DEFAULT"] Use this user preference to specify the default current layout that will be used when starting Softimage.