rfm2.ui.common.BaseWidget Class Reference

Inheritance diagram for rfm2.ui.common.BaseWidget:

Collaboration diagram for rfm2.ui.common.BaseWidget:

Public Member Functions
def	__init__
def	ui_create
def	ui_update
def	setup
def	create
def	update
def	conditional_visibility
def	add_param_popup_menu
def	create_navigation_popup
def	update_navigation_popup
def	__str__

Static Public Member Functions
def	build_navigation_popup_menu

Public Attributes
	nattr
	label
	ctl
	widget
	desc
	param
	uiprefix
	ui_func
	ui_has_builtin_connector
	mayaFunc
	mayaSubControl

Static Public Attributes
list	indexTwoTypes = [kk.W_POPUP, kk.W_MAPPER, kk.W_BOOLEAN, kk.W_CHECKBOX]

Detailed Description

Base class for all widgets.
This will handle the classic create/update cycle of maya controls, as well
as provide a base implementation for widgets attached to simple scalar
attributes.

Constructor & Destructor Documentation

def rfm2.ui.common.BaseWidget.__init__

(

self

)

Member Function Documentation

def rfm2.ui.common.BaseWidget.__str__

(

self

)

def rfm2.ui.common.BaseWidget.add_param_popup_menu

(

self

)

Attach a popupMenu to the parameter widget to revert to the default
value, apply presets, etc.
This is menu will be triggered by:
- OSX: shift-RMB
- Win: shift-RMB
- Linux: shift-RMB

Here is the caller graph for this function:

def rfm2.ui.common.BaseWidget.build_navigation_popup_menu (   args )

static

Here is the call graph for this function:

def rfm2.ui.common.BaseWidget.conditional_visibility	(		self,
			returnFunc = False
	)

Evaluate conditional visibility and attach a callback to trigger a
refresh if need be.

Here is the caller graph for this function:

def rfm2.ui.common.BaseWidget.create	(		self,
			ctlname,
			nodeattr,
			param,
			idx = None,
			dyn = False,
			struct_name = None,
			struct_idx = None
	)

A generic implementation of the widget creation phase.
Inherited by all widget types.

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.ui.common.BaseWidget.create_navigation_popup	(		self,
			ctl
	)

Here is the call graph for this function:

def rfm2.ui.common.BaseWidget.setup	(		self,
			desc,
			param,
			uiprefix
	)

initial setup phase called before the create/update cycle.

Here is the call graph for this function:

def rfm2.ui.common.BaseWidget.ui_create

(

self

)

Create the widget compatible with your data types.

Here is the caller graph for this function:

def rfm2.ui.common.BaseWidget.ui_update

(

self

)

Connect the widget previously created to a specific attribute.
We also handle conditional visibility here.

Here is the caller graph for this function:

def rfm2.ui.common.BaseWidget.update	(		self,
			ctlname,
			nodeattr,
			idx = None,
			label = None,
			dyn = 0,
			struct_name = None,
			struct_idx = None
	)

A generic implementation of the widget updating phase.
Inherited by all widget types.

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.ui.common.BaseWidget.update_navigation_popup	(		self,
			ctl,
			func
	)

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

rfm2.ui.common.BaseWidget.ctl

rfm2.ui.common.BaseWidget.desc

list rfm2.ui.common.BaseWidget.indexTwoTypes = [kk.W_POPUP, kk.W_MAPPER, kk.W_BOOLEAN, kk.W_CHECKBOX]

static

rfm2.ui.common.BaseWidget.label

rfm2.ui.common.BaseWidget.mayaFunc

rfm2.ui.common.BaseWidget.mayaSubControl

rfm2.ui.common.BaseWidget.nattr

rfm2.ui.common.BaseWidget.param

rfm2.ui.common.BaseWidget.ui_func

rfm2.ui.common.BaseWidget.ui_has_builtin_connector

rfm2.ui.common.BaseWidget.uiprefix

rfm2.ui.common.BaseWidget.widget

---

The documentation for this class was generated from the following file:

• /data/wlw/renderman_root/rat/apps/rfm/scripts/rfm2/ui/common.py