rfm2.ui.common Namespace Reference

Classes
class	NumericalWidget
class	Numerical2Widget
class	ColorWidget
class	StringWidget
class	MatrixWidget
class	MessageWidget

Functions
def	set_colorspace (nattr, *args)
def	set_b2r_nmap (nattr, *args)
def	build_txmgr_menu (nattr, ctl)
def	txmgr_ui_create (ctl, nattr, enabled)
def	txmgr_ui_update (ctl, nattr, enabled)
def	resize_editor (name, offset, min_height)
def	rfm_ae_drag_callback (*args)
def	connect_to_time (*args)
def	popup_updater (_ctlname, nodeattr, *args)
def	mapper_updater (nodeattr, options, *args)
def	script_button_cmd (*args)
def	matrix_updater (ctlname, nodeattr, *args)

Variables
	NodeEditorWidget
	AOVEditorWidget
	OSLEditorWidget
	AbcManifestWidget

Detailed Description

Module implementing the main ui widgets

Function Documentation

build_txmgr_menu()

def rfm2.ui.common.build_txmgr_menu	(		nattr,
			ctl
	)

Either build the colorspace menu based on the current color_manager
config or the bump to roughness map type menu.

Here is the call graph for this function:

Here is the caller graph for this function:

connect_to_time()

def rfm2.ui.common.connect_to_time

(

*

args

)

Connect a mayaTime widget to the scene's time node.

Here is the call graph for this function:

mapper_updater()

def rfm2.ui.common.mapper_updater	(		nodeattr,
			options,
		*	args
	)

Update a string attribute's value based on an optionMenu's (popup widget)
selection.
args last value will be the new popup value, passed by Maya.
Previous args values (if any) will be additional update commands to handle
conditional visibility.

Here is the call graph for this function:

matrix_updater()

def rfm2.ui.common.matrix_updater	(		ctlname,
			nodeattr,
		*	args
	)

Update a matrix attribute's value after a user entered new UI values.

popup_updater()

def rfm2.ui.common.popup_updater	(		_ctlname,
			nodeattr,
		*	args
	)

Update a string attribute's value based on an optionMenu's (popup widget)
selection.
args last value will be the new popup value, passed by Maya.
Previous args values (if any) will be additional update commands to handle
conditional visibility.

Here is the call graph for this function:

resize_editor()

def rfm2.ui.common.resize_editor	(		name,
			offset,
			min_height
	)

Used by the script editor widget to resize the editing area.

rfm_ae_drag_callback()

def rfm2.ui.common.rfm_ae_drag_callback

(

*

args

)

Attribute editor callback: make the contril draggable for RenderSetup.

Here is the call graph for this function:

script_button_cmd()

def rfm2.ui.common.script_button_cmd

(

*

args

)

Execute an arbitrary python code snippet.

args:
- script: the python string to execute.
- nattr: the "node.attr" used to make 'node' and 'param' vars
            available at execution time.

Here is the call graph for this function:

set_b2r_nmap()

def rfm2.ui.common.set_b2r_nmap	(		nattr,
		*	args
	)

Unpacks args and sets the mode to either Bump or Normal. The texture
manager will re-process the texture.

set_colorspace()

def rfm2.ui.common.set_colorspace	(		nattr,
		*	args
	)

Unpacks args and asks the texture manager to update the colorspace of the
texture associated with nattr.

txmgr_ui_create()

def rfm2.ui.common.txmgr_ui_create	(		ctl,
			nattr,
			enabled
	)

Create txmanager UI associated with a texture path attribute.

Args:
    ctl (str): main control name
    nattr (str): attribute plug
    enabled (bool): True if the plug has the "texture" or "env" option

Returns:
    str: formLayout control

txmgr_ui_update()

def rfm2.ui.common.txmgr_ui_update	(		ctl,
			nattr,
			enabled
	)

Update txmanager UI associated with a texture path attribute.

Args:
    ctl (str): main control name
    nattr (str): attribute plug
    enabled (bool): True if the plug has the "texture" or "env" option

Here is the call graph for this function:

Variable Documentation

AbcManifestWidget

rfm2.ui.common.AbcManifestWidget

AOVEditorWidget

rfm2.ui.common.AOVEditorWidget

NodeEditorWidget

rfm2.ui.common.NodeEditorWidget

OSLEditorWidget

rfm2.ui.common.OSLEditorWidget