autorigs.ui package

Submodules

autorigs.ui.moduleListItemWidget module

autorigs.ui.moduleTabsWidget module

class autorigs.ui.moduleTabsWidget.ModuleTabsWidget(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

createTabs(prefix, hasproxy, optionswidget=None, paramswidget=None)
fromJSON(json)
rename(name)

autorigs.ui.moduleUiTab module

class autorigs.ui.moduleUiTab.ModuleUiTab

Bases: sphinx.ext.autodoc.importer._MockObject

unlinkAllNodes()

autorigs.ui.uiAssetContainer module

autorigs.ui.uiCharacterSettings module

autorigs.ui.uiCharacterTabs module

autorigs.ui.uiCreateTabs module

autorigs.ui.uiDropDownMenu module

class autorigs.ui.uiDropDownMenu.UiDropDownMenu(label='')

Bases: sphinx.ext.autodoc.importer._MockObject

addOnSelectionChangedCallbacks(fxn)

Add a callback that accepts a string as its argument

clear()
getItem(idx)
repopulate(new_list)

repopulate the list of the menu to the given list

setCurrentIndex(idx)
setText(text)

autorigs.ui.uiGeometryCapture module

autorigs.ui.uiGeometryContainer module

autorigs.ui.uiGeometryInfo module

autorigs.ui.uiGeometryParams module

autorigs.ui.uiMenuBar module

autorigs.ui.uiModuleList module

autorigs.ui.uiNewAutorigDialog module

autorigs.ui.uiParamColor module

class autorigs.ui.uiParamColor.UiParamColor(label, parmnames=None)

Bases: sphinx.ext.autodoc.importer._MockObject

B = 'b'
G = 'g'
NUM_FLOAT_COMPONENTS = 3
R = 'r'
addNodes(nodes)
createColorButton()
createToolTip(parmnames, label, labelbutton, description='')
getValues()
insertNodes(nodes, index=0)
linkParmTuple(nodes, colorprefix)
onNodeChange(channels)
popNode(index=None)
removeNodes(nodes)
setColorButton(color)
setValues(values)
showColorDialog()
unlinkParms()

autorigs.ui.uiParamComboBox module

class autorigs.ui.uiParamComboBox.UiParamComboBox(label, items, default_index=0)

Bases: sphinx.ext.autodoc.importer._MockObject

addCallback(fcn)
eval()
getValues()
setValues(values)
unlinkParms()

autorigs.ui.uiParamDescriptions module

autorigs.ui.uiParamFactory module

class autorigs.ui.uiParamFactory.UiParamFactory
ANGLE = 8
ANGLE_JSON_LABEL = 'angle'
GSCALE = 7
GSCALE_JSON_LABEL = 'globalscale'
JSON_INV_MAPPING = {'angle': 8, 'color': 4, 'globalscale': 7, 'length': 6, 'locators_name': 12, 'locators_num': 13, 'locators_parent_name': 16, 'locators_parent_path': 17, 'locators_parent_type': 18, 'locators_path': 14, 'locators_preset': 19, 'radius': 5, 'rotate': 1, 'rotatex': 9, 'rotatey': 10, 'scale': 2, 'size': 3, 'subdivide': 11, 'translate': 0, 'uvw': 15}

Default mapping between label and extra data on houdini node

JSON_MAPPING_LABELS = {0: 'translate', 1: 'rotate', 2: 'scale', 3: 'size', 4: 'color', 5: 'radius', 6: 'length', 7: 'globalscale', 8: 'angle', 9: 'rotatex', 10: 'rotatey', 11: 'subdivide', 12: 'locators_name', 13: 'locators_num', 14: 'locators_path', 15: 'uvw', 16: 'locators_parent_name', 17: 'locators_parent_path', 18: 'locators_parent_type', 19: 'locators_preset'}
LENGTH = 6
LENGTH_JSON_LABEL = 'length'
LOCATOR_NAME = 12
LOCATOR_NUM = 13
LOCATOR_PARENT_NAME = 16
LOCATOR_PARENT_PATH = 17
LOCATOR_PARENT_TYPE = 18
LOCATOR_PATH = 14
LOCATOR_PRESET = 19
LOCATOR_UVW = 15
MAPPING = {0: ('Translate', ['tx', 'ty', 'tz']), 1: ('Rotate', ['rx', 'ry', 'rz']), 2: ('Scale', ['sx', 'sy', 'sz']), 3: ('Size', ['geoscale']), 4: ('Color', ['dcolor']), 5: ('Radius', ['radius']), 6: ('Length', ['dist']), 7: ('Uniform Scale', ['scale']), 8: ('Angle', ['angle']), 9: ('Rotate X', ['rx']), 10: ('Rotate Y', ['ry']), 11: ('Subdivide', ['subdivide']), 13: ('Locators', ['locators_num'])}
RADIUS = 5
RADIUS_JSON_LABEL = 'radius'
ROTATE = 1
ROTATEX = 9
ROTATEY = 10
ROTATE_JSON_LABEL = 'rotate'
SCALE = 2
SCALE_JSON_LABEL = 'scale'
SIZE = 3
SIZE_JSON_LABEL = 'size'
SUBDIVIDE = 11
SUBDIVIDE_JSON_LABEL = 'subdivide'
TRANSLATE = 0
TRANSLATE_JSON_LABEL = 'translate'
USCALE_JSON_LABEL = 'uscale'
WIRECOLOR = 4
WIRECOLOR_JSON_LABEL = 'color'
classmethod createColorParams(nodes, mapping)
classmethod createFloatParams(nodes, mapping, custom_name='')
classmethod createIntParams(nodes, mapping, custom_name='')
classmethod createParams(paramtype, nodes)
classmethod createTypeParams(param_class, nodes, mapping, custom_name='', *args, **kwargs)
classmethod hasValidNodeList(nodes)
classmethod linkParams(param, paramtype, nodes)
classmethod paramTypeToJSON(paramtype)

autorigs.ui.uiParamFile module

class autorigs.ui.uiParamFile.GroupDropdown(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

popup

Used by autodoc_mock_imports.

showPopup()
class autorigs.ui.uiParamFile.UiParamFile(label, default_text='', file_dialog='Choose File', file_pattern='*', file_type=None, file_extension='')

Bases: sphinx.ext.autodoc.importer._MockObject

fileHasCorrectPattern(filepath)
getText()
setOnTextChanged(fcn)
setText(text)
class autorigs.ui.uiParamFile.UiParamFileIcon(label, default_text='', file_dialog='Choose Icon', file_pattern='*', file_type=None, icon_default=None)

Bases: autorigs.ui.uiParamFile.UiParamFile

linkNode(node)
setText(path)
class autorigs.ui.uiParamFile.UiParamGeoOperator(object_label='Object', group_label='Group', filter_type=nodeTypeFilter.Obj)

Bases: sphinx.ext.autodoc.importer._MockObject

Param field for operator and group selection. The group will refresh automatically upon change in operator node.

BOX_LAYOUT = 1
FORM_LAYOUT = 0
addOnSelectionChanged(fcn)
getGroup()
getOperator()
hideOperator()
repopulate()
setGroup(group)
setOperator(operator)
showOperator()
class autorigs.ui.uiParamFile.UiParamOperator(label, default_operator='', filter_type=nodeTypeFilter.Sop, label_type=0, relative_node=None)

Bases: sphinx.ext.autodoc.importer._MockObject

LABEL_BUTTON_TYPE = 1
Q_LABEL_TYPE = 0
addOperatorCallbacks(node)
eval()
getLabel()
getOperatorNode()
getPath(operator)
getRelativeNode()
getText()
getValues()
linkParm(node, parmname)
nodeChanged

Used by autodoc_mock_imports.

removeOperatorCallbacks(node)
setLabel(label)
setOnEditingFinished(fcn)

Set the callback that’s called when the field is done editing. fcn: a callback that takes the text as its argument

setOnTextChanged(fcn)
setRelativeNode(node)
setText(text)
setValues(values)
unlinkParms()

autorigs.ui.uiParamFloat module

class autorigs.ui.uiParamFloat.UiParamFloat(label, num_components, defaults=(), soft_range=(0, 10), parmnames=None)

Bases: autorigs.ui.uiParamNum.UiParamNum

eval()
getRange()
isAlmostEqual(nodevalue, slidervalue)
setToDefaults()

autorigs.ui.uiParamInt module

class autorigs.ui.uiParamInt.UiParamInt(label, num_components, defaults=(), soft_range=(0, 10), parmnames=None)

Bases: autorigs.ui.uiParamNum.UiParamNum

SLIDER_RANGE_DEFAULT_MAX = 10000
SLIDER_RANGE_DEFAULT_MIN = 0
eval()
getRange()
setRange(min, max, bypass_strict=False)
setValues(values)

autorigs.ui.uiParamLabelButton module

class autorigs.ui.uiParamLabelButton.UiParamLabelButton(label)

Bases: sphinx.ext.autodoc.importer._MockObject

autorigs.ui.uiParamLocatorWidget module

class autorigs.ui.uiParamLocatorWidget.UiParamLocatorWidget(relative_node=None)

Bases: sphinx.ext.autodoc.importer._MockObject

PARENT_PATH = 'parent'
PARENT_TYPE = 'parent_type'
PARENT_TYPE_CUSTOM = 2
PARENT_TYPE_ITEMS = ['None', 'NURBS', 'Custom']
PARENT_TYPE_NONE = 0
PARENT_TYPE_NURBS = 1
PATH = 'locator'
UVW = 'uv'
getParentPathWidget()
getParentTypeWidget()
getPathWidget()
getUvwWidget()
getValues()
locatorChanged

Used by autodoc_mock_imports.

locatorPlaced

Used by autodoc_mock_imports.

setValues(json)
toggleParentVisibility(index, widget)
unlinkParms()
updatePressed

Used by autodoc_mock_imports.

uvwChanged

Used by autodoc_mock_imports.

autorigs.ui.uiParamMultiParm module

class autorigs.ui.uiParamMultiParm.ListItem(widget)

Bases: sphinx.ext.autodoc.importer._MockObject

getWidget()
insert

Used by autodoc_mock_imports.

remove

Used by autodoc_mock_imports.

class autorigs.ui.uiParamMultiParm.UiParamMultiParm(parm_widget_fcn)

Bases: sphinx.ext.autodoc.importer._MockObject

COUNT = 'count'
LIST = 'list'
findIndex(item_widget)
getCount()
getItemWidget(index)
getValues()
getWidget(index)
insertClicked(item_widget)
insertWidget(index)
itemWidgetCreated

Used by autodoc_mock_imports.

itemWidgetDeleted

Used by autodoc_mock_imports.

linkParm(node, parmname)
remapWidgetToIndex(index)
removeClicked(item_widget)
removeWidget(index)
setCount(count)
setLabel(label)
setValues(values)
unlinkParms()
updateCountParm()
updateList(value)
valueChanged

Used by autodoc_mock_imports.

autorigs.ui.uiParamName module

class autorigs.ui.uiParamName.UiParamName(label, default_text='')

Bases: autorigs.ui.uiParamString.UiParamString

getText()
linkParm(node)
onNameChanged(**kwargs)
onTextChanged()
setText(text)
unlinkParm()

autorigs.ui.uiParamNodePicker module

autorigs.ui.uiParamNum module

class autorigs.ui.uiParamNum.MySlider(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

mousePressEvent(event)
class autorigs.ui.uiParamNum.UiParamNum(label, num_components, defaults=(), soft_range=(0, 10), parmnames=None)

Bases: sphinx.ext.autodoc.importer._MockObject

SLIDER_DIV = 10000
SLIDER_RANGE_DEFAULT_MAX = 10000
SLIDER_RANGE_DEFAULT_MIN = 0
abs(value)
addNodes(nodes)
addOnNodeChangedFunction(fcn)
addOnTextChangedFunction(fcn)
copyValues(item)
createToolTip(parmnames, label, labelbutton, description='')
eval()
getRange()
getValues()
hasUnsavedChanges()
hideSlider()
insertNodes(nodes, index=0)
linkParms(nodes, parmnames)
markSaved()
popNode(index=None)
removeNodes(nodes)
setLabel(label)
setRange(min, max, bypass_strict=False)
setText(i, param, str_value, from_node=False)
setToDefaults()
setValues(values)
setupUI()
unlinkParms()

autorigs.ui.uiParamOperator module

class autorigs.ui.uiParamOperator.uiParamOperator(label, default_operator='', operator_dialog='Choose Operator')

Bases: sphinx.ext.autodoc.importer._MockObject

autorigs.ui.uiParamString module

class autorigs.ui.uiParamString.UiParamString(label, default_text='', label_type=0)

Bases: sphinx.ext.autodoc.importer._MockObject

LABEL_BUTTON_TYPE = 1
Q_LABEL_TYPE = 0
eval()
getText()
getValues()
linkParm(node, parmname)
onTextChanged()
setValues(values)
setupUI()
unlinkParms()

autorigs.ui.uiParentComboMenu module

class autorigs.ui.uiParentComboMenu.UiParentComboMenu(label, default_parent, existing_parents, ordered_potential_parents, updateparent_callback=None)

Bases: sphinx.ext.autodoc.importer._MockObject

default_parent = (op, i, gi) where op is the module type, i is the index of the module, and gi is the index of the guide obj. The default parent should always exist (aka master) Existing parents is a list of parents and guides that already exist in the autorigs system. potential_parents are what the module could attach to if they existed. potential_parents is a list of module types

clearPotentials()
createImportWarning()
currentStillExist()
displayWarningJson(json)
fromJSON(json)
getCurrentSelection()
getModuleGuideText(modulename, guidename)
parentChanged()
parentTypeInPotential(parenttype)
toJSON()
unDisplayWarningJson()
updateItemInfos(existing_parents)
updateParent(op, i, gi)
updateParentCombo()

We create a new qmenu everytime because there’s a weird bug in QT or the code that doesn’t seem to allow QMenu to dynamically add more menu items without the menu appearing in the wrong place. For example, if you add a head then add a spine, then click on the button, then the menu shows up at the wrong place if a new menu is not added. This is just a hack to go around that problem for now

updateParents(item_infos)
validParentIds(moduletype, modulename, guidename)

autorigs.ui.uiToggleButtonsWidget module

class autorigs.ui.uiToggleButtonsWidget.ToggleButtonsWidget(label, buttonslabel, default_checkedidx, onbuttonclicked)

Bases: sphinx.ext.autodoc.importer._MockObject

getCurrentIndex()
setCurrentIndex(index)
setOnButtonClicked(fcn)

Module contents