autorigs.ui package

Submodules

autorigs.ui.moduleListItemWidget module

class autorigs.ui.moduleListItemWidget.ItemWidgetLabel(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

paintEvent(event)
class autorigs.ui.moduleListItemWidget.ModuleListItemWidget

Bases: sphinx.ext.autodoc.importer._MockObject

createListItem(autorig_module, has_bypass=True)
fromJSON(json)
getBypass()
getDisplay()
getLock()
getModuleName()
getModuleType()
rename(name)
setBypass(toggle)
setCallbacks(bypass, lock, display)
setDisplay(toggle)
setLock(toggle)
toJSON()
class autorigs.ui.moduleListItemWidget.TopAllItem(modulelist, autorigs_asset, charactertab)

Bases: sphinx.ext.autodoc.importer._MockObject

bypassAll(toggle)
displayAll(toggle)
geoDisplay(toggle)
lockAll(toggle)
setBypassAllWithoutTrigger(toggle)
setDisplayAllWithoutTrigger(toggle)
setLockAllWithoutTrigger(toggle)
autorigs.ui.moduleListItemWidget.createToolButton(parent, tooltip, qticonpath)

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

class autorigs.ui.uiAssetContainer.UiAssetContainerFactory
classmethod createAssetNameContainer()
classmethod createAssetPathContainer()
classmethod createAssetTypeContainer(filled_type)
classmethod createCustomWidgetContainer()
classmethod createDefaultContainer(assetnode)
class autorigs.ui.uiAssetContainer.UiAssetDefault(assetnode)

Bases: sphinx.ext.autodoc.importer._MockObject

getErrorMessageIfAny()
resetSettings(autorigs_asset)
saveSettings(settingsdst)
updateSettings(autorigs_asset)
class autorigs.ui.uiAssetContainer.UiAssetPathOptions(assetnode=None)

Bases: sphinx.ext.autodoc.importer._MockObject

getCurrentData()
getCurrentIndex()
onToggleChanged(index)
saveSettings(settings)
setPathOptionData(settings)
autorigs.ui.uiAssetContainer.getErrorMessage(assetnode, assettype, assetname, customicon)
autorigs.ui.uiAssetContainer.nameExists(assetnode, assetname)
autorigs.ui.uiAssetContainer.typeExists(assetnode, assettype)

autorigs.ui.uiCharacterSettings module

class autorigs.ui.uiCharacterSettings.UiCharacterSettings(autorigs_asset)

Bases: sphinx.ext.autodoc.importer._MockObject

accept()
getNewSettings()
reset()
show()
updateSettings(autorigs_asset)

autorigs.ui.uiCharacterTabs module

class autorigs.ui.uiCharacterTabs.UiCharacterTab(autorigs_asset)

Bases: sphinx.ext.autodoc.importer._MockObject

appendNewModule(newmodule)
buildRig()
buildingTab()
builtTab()
changeTabText(text)
closingTab()
displayBuiltAutorigDialog()
getAutoRigsAsset()
hasUnsavedChanges()
hipClear(answer)
hipSave(answer)
lockTab(lock)
markSaved(saved=True)
saveIfNeeded(answer=2)
saveTab()
selectAsset(select)
setTabTextFunction(fcn, index)
class autorigs.ui.uiCharacterTabs.UiCharacterTabs(maingui)

Bases: sphinx.ext.autodoc.importer._MockObject

addCharacter(autorigs_asset)
appendNewModule(newmodule)
buildRig()
closeTab(index)
currentAutoRigsAsset()
enterEvent(event)
existingCharacter(assetnode, json)
hasCharacter(assetnode)
hasUnsavedChanges()
hipClear()
hipSave()
newCharacter(create_values)
newFromJsonCharacter(json, create_values=None)
removeCharacter(index)
removeCurrentCharacter()
saveAllCharacters()
saveCurrentCharacter()
setMenuWidget(menubar)
switchTab(index)

autorigs.ui.uiCreateTabs module

class autorigs.ui.uiCreateTabs.UiCreateFaceModulesTab(charactertabs)

Bases: autorigs.ui.uiCreateTabs.UiCreateTab

getButtonInfo()
getOnButtonClicked()
onButtonClicked()
class autorigs.ui.uiCreateTabs.UiCreateModulesTab(charactertabs)

Bases: autorigs.ui.uiCreateTabs.UiCreateTab

getButtonInfo()
getOnButtonClicked()
onButtonClicked()
class autorigs.ui.uiCreateTabs.UiCreatePresetsTab(charactertabs)

Bases: autorigs.ui.uiCreateTabs.UiCreateTab

createPresetModule(jsonobj)
createPresetModuleGivenName(name)
createPresetModules(jsonobj)
getButtonInfo()
getOnButtonClicked()
onButtonClicked()
onImportClicked()
class autorigs.ui.uiCreateTabs.UiCreateQuadModulesTab(charactertabs)

Bases: autorigs.ui.uiCreateTabs.UiCreateTab

getButtonInfo()
getOnButtonClicked()
onButtonClicked()
class autorigs.ui.uiCreateTabs.UiCreateTab(charactertabs)

Bases: sphinx.ext.autodoc.importer._MockObject

createModuleGivenName(name)
getCustomStylesheet()
class autorigs.ui.uiCreateTabs.UiCreateTabs(charactertabs)

Bases: sphinx.ext.autodoc.importer._MockObject

getPresetsTab()
reset()
autorigs.ui.uiCreateTabs.getCreateButton(createinfo, onclicked)
autorigs.ui.uiCreateTabs.getCreateButtons(buttoninfo, onclicked)

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

class autorigs.ui.uiGeometryCapture.UiGeometryCaptureDefault

Bases: sphinx.ext.autodoc.importer._MockObject

GEOMETRY_CAPTURE_DEFAULT = 0
GEOMETRY_CAPTURE_LABELS = ['Biharmonic', 'CRegion', 'Proximity']
getCaptureType()
getCreateNetwork()
getDisplayDeform()
saveSettings(settingsdst)
updateSettings(autorigs_asset)
class autorigs.ui.uiGeometryCapture.UiGeometryCaptureFactory
classmethod createCaptureWidget()

autorigs.ui.uiGeometryContainer module

class autorigs.ui.uiGeometryContainer.UiGeometryContainerFactory
classmethod createDefaultWidget()
classmethod createSimpleWidget()
class autorigs.ui.uiGeometryContainer.UiGeometryDefault

Bases: sphinx.ext.autodoc.importer._MockObject

GEOMETRY_SOURCE_LABELS = ['None', 'Operator', 'File', 'Standin']
getErrorMessageIfAny()
onGeoSourceChanged(index)
resetSettings(autorigs_asset)
saveSettings(settingsdst)
updateSettings(autorigs_asset)
class autorigs.ui.uiGeometryContainer.UiGeometryFile

Bases: sphinx.ext.autodoc.importer._MockObject

getText()
onFileOptionsChanged()
onGeoPlacementChanged(index)
resetSettings(settings)
saveSettings(settingsdst)
setText(text)
updateSettings(settings, buildgeoguide)
class autorigs.ui.uiGeometryContainer.UiGeometryOffsetParams

Bases: sphinx.ext.autodoc.importer._MockObject

getOffsets()
linkNode(node)
update(translate, rotate, scale)
class autorigs.ui.uiGeometryContainer.UiGeometryOperator

Bases: sphinx.ext.autodoc.importer._MockObject

getText()
onGeoPlacementChanged(index)
onOperatorOptionsChanged()
resetSettings(settings)
saveSettings(settingsdst)
setOnGeoOperatorTextChange(fcn)
updateSettings(settings, buildgeoguide)
class autorigs.ui.uiGeometryContainer.UiGeometrySimple

Bases: sphinx.ext.autodoc.importer._MockObject

GEOMETRY_SOURCE_LABELS = ['None', 'Operator', 'File', 'Standin']
getCurrentData()
getCurrentIndex()
onSimpleGeoSourceChanged(index)
class autorigs.ui.uiGeometryContainer.UiGeometryStandIn

Bases: sphinx.ext.autodoc.importer._MockObject

onStandInOptionsChanged()
resetSettings(settings)
saveSettings(settingsdst)
updateSettings(settings, buildgeoguide)
autorigs.ui.uiGeometryContainer.createPlacementWidget(onchange)
autorigs.ui.uiGeometryContainer.getErrorMessage(geooption, geodata)

autorigs.ui.uiGeometryInfo module

class autorigs.ui.uiGeometryInfo.UiGeometryInfo(geometryguides)

Bases: sphinx.ext.autodoc.importer._MockObject

DEFAULT_GEO_NAME = 'geo_skin'
GEO_PLACEMENTS = ['As Is', 'Auto Place']
GEO_SOURCES = ['Operator', 'On File', 'Stand-In']
GEO_SOURCE_FILE = 1
GEO_SOURCE_OPERATOR = 0
GEO_SOURCE_STANDIN = 2
OBJFILE_SWITCH_FILE = 1
OBJFILE_SWITCH_OPERATOR = 0
PLACEMENT_AS_IS = 0
PLACEMENT_AUTO_PLACE = 1
PLACEMENT_SWITCH_OBJFILE = 0
PLACEMENT_SWITCH_PLACEGEO = 1
PLACEMENT_SWITCH_STANDIN = 2
getCustomGeoName()
getFilePath()
getInvertedGeoOffset()
getIsEmbedded()
getOperatorPath()
getPlacementIndex()
getSourceOption()

autorigs.ui.uiGeometryParams module

class autorigs.ui.uiGeometryParams.UiGeometryFile(transformnode)

Bases: sphinx.ext.autodoc.importer._MockObject

displayParams(display)
getFileText()
class autorigs.ui.uiGeometryParams.UiGeometryOffsetParams(transformnode)

Bases: sphinx.ext.autodoc.importer._MockObject

fromJSON(json)
linkWidgetParams()
toJSON()
class autorigs.ui.uiGeometryParams.UiGeometryOperator(transformnode)

Bases: sphinx.ext.autodoc.importer._MockObject

displayParams(display)
getOperatorText()
setOnGeoOperatorTextChange(fcn)
class autorigs.ui.uiGeometryParams.UiGeometryStandIn(transformnode)

Bases: sphinx.ext.autodoc.importer._MockObject

autorigs.ui.uiMenuBar module

class autorigs.ui.uiMenuBar.UiMenuBar(parent, charactertabs, createtabs)

Bases: sphinx.ext.autodoc.importer._MockObject

BIPED_PRESET_ACTION = 'Biped'
JSON_ASSET_SECTION = 'AutorigSettings'
MAX_RECENTS = 15
NO_RECENT = 'No Recent Characters'
QUADRUPED_PRESET_ACTION = 'Quadruped'
addToRecentMenu(nodepath)
createMessageDialog(windowtext, text)
getAssetNodeValidJsonObj(nodepath, builtmatter)
loadFromNodePath(path)
menuBar()

Accessor for the menu bar widget.

newAutorig()
newAutorigFromSettings(create_values)
removeActionWithSamePath(path)

autorigs.ui.uiModuleList module

class autorigs.ui.uiModuleList.UiModuleList(autorigs_asset, charactertab)

Bases: sphinx.ext.autodoc.importer._MockObject

appendModuleWidget(listitem, widget)
appendNewModule(module)
bypassAll(bypass)
createRightClickMenu()
deleteAllModules()
displayAll(display)
getToggleWidgets()

If the item is not a selected item, we toggle the item only Otherwise, we toggle all the items that are selected

initializeList(autorigs_asset)
lockAll(lock)
onClickBypass(toggle)
onClickDisplay(toggle)
onClickLock(toggle)
onDisplayContextMenu(point)
onDisplayDetail(i)
onRightClickDelete()
onRightClickExport()
onRightClickRename()
reset()
resizeEvent(event)
shouldToggleAllBypass()
shouldToggleAllDisplay()
shouldToggleAllLock()
updateAllBypass()
updateAllDisplay()
updateAllLock()

autorigs.ui.uiNewAutorigDialog module

class autorigs.ui.uiNewAutorigDialog.UiNewAutorigDialog(has_autorig_type=True)

Bases: sphinx.ext.autodoc.importer._MockObject

PRESET_BIPED = 1
PRESET_BLANK = 0
PRESET_QUADRUPED = 2
accept()
createAutorigTypeWidget()
exec_()
getValues()
nameExists(assetname)
reject()
setValues(assetname, assettype)
typeExists(assettype)

autorigs.ui.uiParamColor module

class autorigs.ui.uiParamColor.UiParamColor(label)

Bases: sphinx.ext.autodoc.importer._MockObject

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

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, 'radius': 5, 'rotate': 1, 'rotatex': 9, 'rotatey': 10, 'scale': 2, 'size': 3, 'translate': 0}

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'}
LENGTH = 6
LENGTH_JSON_LABEL = 'length'
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: ('Scale', ['scale']), 8: ('Angle', ['angle']), 9: ('Rotate X', ['rx']), 10: ('Rotate Y', ['ry'])}
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'
TRANSLATE = 0
TRANSLATE_JSON_LABEL = 'translate'
WIRECOLOR = 4
WIRECOLOR_JSON_LABEL = 'color'
classmethod createColorParams(nodes, mapping)
classmethod createFloatParams(nodes, mapping, custom_name='')
classmethod createParams(paramtype, nodes)
classmethod hasValidNodeList(nodes)
classmethod linkParams(param, paramtype, nodes)
classmethod paramTypeToJSON(paramtype)

autorigs.ui.uiParamFile module

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=<sphinx.ext.autodoc.importer._MockObject object>)

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()
repopulate()
setGroup(group)
setOperator(operator)
class autorigs.ui.uiParamFile.UiParamOperator(label, default_operator='', filter_type=<sphinx.ext.autodoc.importer._MockObject object>)

Bases: sphinx.ext.autodoc.importer._MockObject

getText()
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)
setText(text)

autorigs.ui.uiParamFloat module

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

Bases: sphinx.ext.autodoc.importer._MockObject

SLIDER_DIV = 10000.0
SLIDER_RANGE_DEFAULT_MAX = 10000
SLIDER_RANGE_DEFAULT_MIN = 0
addNodes(nodes)
addOnNodeChangedFunction(fcn)
addOnTextChangedFunction(fcn)
copyValues(item)
getRange()
getValues()
hasUnsavedChanges()
insertNodes(nodes, index=0)
linkParms(nodes, parmnames)
markSaved()
popNode(index=None)
removeNodes(nodes)
setLabel(label)
setRange(min, max)
setText(i, floatparam, str_value)
setValues(values)
unlinkParms()

autorigs.ui.uiParamLabelButton module

class autorigs.ui.uiParamLabelButton.UiParamLabelButton(label)

Bases: sphinx.ext.autodoc.importer._MockObject

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

class autorigs.ui.uiParamNodePicker.UiParamNodePicker(label, default_text='', buttonwidth=<sphinx.ext.autodoc.importer._MockObject object>, buttonheight=<sphinx.ext.autodoc.importer._MockObject object>, relative_to_node=None, initial_node=None, node_filter=None)

Bases: sphinx.ext.autodoc.importer._MockObject

getText()
onNodeSelected(node)
setText(text)

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='')

Bases: sphinx.ext.autodoc.importer._MockObject

getText()
onTextChanged()

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