rfm2.ui.widgets Namespace Reference

Functions
def	rfm_ui_templates
def	set_rfm_stylesheet
def	rfm_node_help
def	page_iterator
def	register_condvis_pages
def	expand_closure
def	update_page_visibility
def	rfm_control
def	rfm_ext_control
def	setupControl

Variables
string	RGSTYLESHEET
dictionary	WIDGET_CLASS
list	SPECIAL_WIDGETS
dictionary	CONDVIS_PAGES = {}

Function Documentation

def rfm2.ui.widgets.expand_closure

(

ntype

)

Return a function to update conditional page visibility when a page is
expanded.

Arguments:
    ntype {str} -- node type

Returns:
    function pointer

Here is the caller graph for this function:

def rfm2.ui.widgets.page_iterator

(

lyt

)

Generator recursively finding frameLayout controls enclosed in
'lyt'.
NOTE: it will only find pages that have already been created. The AE only
creates sub pages when they are made visible.

Args:
- layout (str): name/path of the layout we descend into.

Here is the caller graph for this function:

def rfm2.ui.widgets.register_condvis_pages	(		ntype,
			pnames,
			func = None
	)

Recursively parse the editor layout to store layouts affected by
conditional visibility.

Args:
    ntype (str) -- the node type
    pnames (str) -- list of page labels with conditional visibility.

Kwargs:
    func (functions pointer) -- A function to be evaluated once we're done. (default: None)

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.ui.widgets.rfm_control	(		ntype,
			nattr,
			prefix = '',
			debug = False
	)

Implements a classic maya new/replace control workflow.

Args:
- ntype (str): node type
- nattr (str): node dot attribute
- prefix (str): a prefix appended to the control name.
- debug (bool): display debug messages.

Returns:
- None

Here is the call graph for this function:

def rfm2.ui.widgets.rfm_ext_control

(

nattr

)

Creates an extension control.

Here is the call graph for this function:

def rfm2.ui.widgets.rfm_node_help

(

ntype

)

Here is the call graph for this function:

def rfm2.ui.widgets.rfm_ui_templates

(

)

Here is the call graph for this function:

def rfm2.ui.widgets.set_rfm_stylesheet

(

root

)

Here is the caller graph for this function:

def rfm2.ui.widgets.setupControl	(		ui_class,
			desc,
			param,
			ui_prefix,
			ctlname,
			nodeattr
	)

Here is the caller graph for this function:

def rfm2.ui.widgets.update_page_visibility	(		nodeattr,
			retry = False
	)

Update conditional visibility of pages.

We get the list of pages with conditional visibility expressions
and then evaluate their expressions in turn. Page layouts are
referenced by names and will be renamed to match the canonical
format if need be. In practice, it means the renaming will happen
the very first time a node is displayed in the Attribute Editor.

Args:
- nodeattr (str): the full plug, i.e. 'filter1.msg'

Here is the call graph for this function:

Variable Documentation

dictionary rfm2.ui.widgets.CONDVIS_PAGES = {}

string rfm2.ui.widgets.RGSTYLESHEET

list rfm2.ui.widgets.SPECIAL_WIDGETS

Initial value:

= [kk.W_NODEEDITOR, kk.W_OSLEDITOR, kk.W_AOVEDITOR,
                   kk.W_ABCMANIFEST, kk.W_USERATTRIBUTES]

dictionary rfm2.ui.widgets.WIDGET_CLASS

Initial value:

= {'int': uic.NumericalWidget(),
                'int2': uic.Numerical2Widget(),
                'float': uic.NumericalWidget(),
                'float2': uic.Numerical2Widget(),
                'float3': uic.NumericalWidget(),
                'color': uic.ColorWidget(),
                'point': uic.NumericalWidget(),
                'vector': uic.NumericalWidget(),
                'normal': uic.NumericalWidget(),
                'matrix': uic.MatrixWidget(),
                'string': uic.StringWidget(),
                'struct': uic.StringWidget(),
                'message': uic.MessageWidget(),
                kk.W_NODEEDITOR: uic.NodeEditorWidget(),
                kk.W_OSLEDITOR: uic.OSLEditorWidget(),
                kk.W_AOVEDITOR: uic.AOVEditorWidget(),
                kk.W_ABCMANIFEST: uic.AbcManifestWidget(),
                kk.W_USERATTRIBUTES: uiua.UserAttrWidget()}