hou.setContextOptionConfig HOM function

コンテキストオプションのデフォルト値のUI設定を保持するための文字列を設定します。

setContextOptionConfig(option, config)

Associates a configuration string string with the context option named option. This value is saved in the HIP file, similar to the context option’s default value.

The string content is interpreted by the built-in Context Option editor pane. If a user or studio create their own context option editor UI, they can store arbitrary configuration data in this string. However, in that case, you should avoid using the built-in editor because it will overwrite the string.

Warning

While we provide API for getting and setting a config string, SideFX does not consider the actual format of the string, as written by the built-in context option editor pane, to be public API. The format may change without notice between versions. If you write rely on the config strings created by Houdini, you should understand that they may stop working someday.

The current content is a JSON dictionary with the following keys:

`label`	`str`	A human-readable label for the context option.
`type`	`str`	This controls what type of interface the context option editor shows the user for editing the value. It only configures the user interface. Anyone can still set the option to any value through scripting. `text` A plain text field. `number` A text field that expects a number. `file_path` A text field with a button to open a file chooser. `node_path` A text field with a button to open a node chooser. `float_slider` A numeric text field with a slider. Other config keys below control the slider range. `int_slider` A numeric text field with a slider that snaps to integers. Other config keys below control the slider range. `string_menu` A pop-up menu that sets the option to a string value. See the `menu_items` key below. `int_menu` A pop-up menu that sets the option to an integer value. See the `menu_items` and `autovalues` keys below. `py_menu` A pop-up menu that runs a Python script to generate the menu item labels and values. See the `menu_source` key below. `checkbox` A checkbox. Sets the option value to `0` or `1`. `heading` The option label is displayed as a heading without any editor. You can use this to organize the options into categories.
`order`	`int`	The order in which the option appears in the editor view. Any time the user drag-reorders an option this number is overwritten.
`comment`	`str`	A string explaining the purpose of the context option.
`menu_items`	`array`	A list of `[label_str, value]` pairs, used for mene type editor UIs.
`autovalues`	`bool`	Whether `int_menu` type options should use automatically generated values. If this is on, the “values” for the menu items are set to `0`, `1`, `2`, etc., ignoring the “value” part of the paris in `menu_items`.
`menu_source`	`str`	For a `py_menu` type option, this is the Python source code for generating the menu. If this string is one line (that is, the string contains no newline characters), Houdini evaluates it as an expression. If this string has multiple lines, Houdini runs it as if it was the body of a function, so it should `return` the menu items. The result should be a `list` of `(label_str, value)` pairs.
`minimum`	`int` or `float`	The low end of the slider for `int_slider` and `float_slider` types.
`min_locked`	`bool`	If this is true, the UI doesn’t let the user manually enter numbers smaller than `minimum`.
`maximum`	`int` or `float`	The high end of the slider for `int_slider` and `float_slider` types.
`max_locked`	`bool`	If this is true, the UI doesn’t let the user manually enter numbers larger than `maximum`.

hou.setContextOptionConfig HOM function

hou

Animation ¶

apex ¶

Digital assets ¶

Channels ¶

Cooking ¶

Crowds ¶

Dynamics ¶

Exceptions ¶

File I/O ¶

General ¶

Geometry ¶

Images ¶

Nodes ¶

Node types ¶

Objects ¶

Organization ¶

Parameters ¶

Parameter templates ¶

Performance ¶

Playbar ¶

Preferences ¶

Radial menus ¶

Rendering ¶

Scripting ¶

Shading ¶

Shelf ¶

Solaris ¶

solarisl ¶

Takes ¶

UI ¶

Utility ¶

VEX ¶

Views ¶

viewer ¶

webServer ¶