autorigs.modules.advancedFace.lip package

Submodules

autorigs.modules.advancedFace.lip.autoRigsLipBuilder module

class autorigs.modules.advancedFace.lip.autoRigsLipBuilder.AutoRigsLipBuilder(*args, **kwargs)

Bases: autorigs.modules.base.autoRigsBaseBuilder.AutoRigsBaseBuilder

BONE_KEY = 'bone'

BONE_SUFFIX = 'bone'

CONSTRAINTS_KEY = 'constraints'

CONSTRAINTS_SUFFIX = 'constraints_root'

CONTROL_KEY = 'control'

CONTROL_SUFFIX = 'control'

INTERFACE = {'close': ('close', 'Close'), 'folder': ('folder', 'Lips'), 'lid_folder': ('folder', 'Lip'), 'weight': ('weight', 'Lip Weight'), 'zip_left': ('zipleft', 'Zip Left'), 'zip_offset': ('zipoffset', 'Zip Offset'), 'zip_right': ('zipright', 'Zip Right')}

LOC_KEY = 'loc'

LOC_SUFFIX = 'LOC'

LOWER_PREFIX = 'Lower'

LPC_KEY = 'lpc'

LPC_SUFFIX = 'lpc'

NODES = {'averageline': ('make_average_line',), 'averagenull': ('average',), 'basicline': ('basic_line',), 'basiclineresample': ('basic_line_resample',), 'ctrlcurveout': ('ctrl_curve_OUT',), 'curve_geo': ('curvegeo',), 'curvegrpresample': ('grp_resample',), 'curveout': ('curveout',), 'fsp': ('findshortestpath',), 'merge': ('object_merge',), 'movepointswrangle': ('move_points_to_nulls',), 'nctrlcurveout': ('N_curve_OUT',), 'root': ('root',), 'wiredef': ('wiredeform',)}

OFFSET_KEY = 'offset'

OFFSET_SUFFIX = 'offset'

ROOT_KEY = 'root'

ROOT_SUFFIX = 'root'

UPPER_PREFIX = 'Upper'

addLPCMerge(prefix, network, point_group)

assignPoints(nodes, points, lpc_out)

Assign the points on the lpc_out curve that will control the ctrl_lpc constraints

buildLip(point_nums, ctrl_guides, group, lpc_group_name)

Builds one of the upper or lower lips @param point_nums (list of int): List of the 3 points making up the curve @param ctrl_guides (list of hou.Node): List of the eye control guides corresponding to the lid @param group (BuilderGroup): Either self.upper_group or self.lower_group @param lpc_group_name (string): Group name of the polycage points that affect the lid - used for blendshapes

buildLowerLip()

buildRigControls()

Creates the bones and controls based on the guide objects. prefix: the prefix to use for all the nodes created assetnode: the autorig assset node in which to create the rig model: the module’s model for build options buildguide: the module’s buildguides parent: a function takes a node as the argument and parent the node

buildUpperLip()

createFolderTemplate()

Creates the folder parm template for the module. model: the module’s model for build options

createGroups()

createLPCConstraints(node, lpc_out, start, end)

createLidFolder(group)

createLowerFolder()

createMainFolder()

createMainParmTemplate(group)

createUpperFolder()

getLowerParent()

getUpperParent()

isUpper(prefix)

makeAverageLine(group, main_group, network)

makeSticky(prefix, group, main_group, network)

makeStickyNetwork(prefix, group, network)

onCaptureCompleted()

Processes to run after geometry is captured

onCaptureCompletedLid(prefix, points, bonegroup, exclude_group=None)

setLowerParent(node)

setUpperParent(node)

spreadPoints(num_range, points)

updateDicts()

autorigs.modules.advancedFace.lip.buildLipGuide module

class autorigs.modules.advancedFace.lip.buildLipGuide.LipGuide(autorigs_asset, geometryguides, prefix=None)

Bases: autorigs.modules.base.buildBaseGuide.BaseGuide

BUILD_ERROR_MSG = 'Sticky lips require building both the upper and lower lip before generating.'

LIP_PREFIX = ['UpperLip', 'LowerLip']

ROOT = 'liproot'

buildFromJsonExisting(json)

buildFromJsonNew(json, parent=None)

buildLowerLid(numctrls)

buildUpperLid(numctrls)

createSubguides()

deleteGuides()

getGeometryGuide()

getLowerLid()

getMaxLocNum()

getUpperLid()

resnapGuides()

toJSON()

toggleModule(toggle)

updateCtrls(value)

updateError()

updateSticky(toggle)

class autorigs.modules.advancedFace.lip.buildLipGuide.LipGuidePart(autorigs_asset, prefix, geometryguides)

Bases: autorigs.modules.base.buildBaseGuide.BaseGuide

CONTROL = 'guide'

CONTROL_ROOT = 'ctrlroot'

CTRL_CURVE_OUT = 'ctrlout'

CTRL_SWITCH = 'switch'

GUIDENAMES = {'ctrlout': 'ctrl_curve_OUT', 'ctrlroot': 'lip_ctrl_root', 'guide': 'guide', 'guidecurve': 'lip_curve', 'nctrlout': 'N_curve_OUT', 'objmerge': 'geo', 'points': 'selected_points_group', 'shortestpath': 'make_curve', 'switch': 'controls_switch'}

GUIDE_CURVE = 'guidecurve'

NCTRL_CURVE_OUT = 'nctrlout'

OBJECT_MERGE = 'objmerge'

POINTS_GROUP = 'points'

POINTS_GROUP_NAME = 'selected_points'

SHORTEST_PATH = 'shortestpath'

buildCurveNetwork(numctrls, nodesdata, guidenames, points)

Build the curve sop for either the upper or lower lid/lip @param numctrls (int): Enum of value either 0 or 1 representing 5 or 9 ctrls @param nodesdata (dict): guidenodesdata dictionary @param guidenames (dict): dictionary for key -> node_name

buildFromJsonExisting(json)

buildFromJsonNew(json, parent=None)

destroyControlGuides()

generateControlGuides(numctrls)

generateLid(numctrls)

getControlGuides()

getControlKeys()

getLocNum()

getParent()

getPoints()

isBuilt()

renameGuides(json)

resetLid(numctrls)

resnapControlGuides()

Changes the position of the guides back to hovering over the lips

selectPoints()

setControlRootExpressions(node)

setGuidePosition(guide, point, bounding_z)

setParent(parent)

toJSON()

updateCtrls(value)

autorigs.modules.advancedFace.lip.lipGuideController module

class autorigs.modules.advancedFace.lip.lipGuideController.LipGuideController(model)

onCtrlsChanged(value)

onStickyToggled(value)

autorigs.modules.advancedFace.lip.lipGuideModel module

class autorigs.modules.advancedFace.lip.lipGuideModel.LipGuideModel

Bases: autorigs.modules.base.baseGuideModel.BaseGuideModel

CTRL_DEFAULT = 0

CTRL_FIVE = 0

CTRL_NINE = 1

CTRL_TO_NUM = {0: 5, 1: 9}

LIP_PREFIX = ['UpperLip', 'LowerLip']

NUM_TO_CTRL = {5: 0, 9: 1}

addBuildLowerCallback(fxn)

addBuildUpperCallback(fxn)

addUpdateCtrlsCallback(fxn)

addUpdateStickyCallback(fxn)

buildLowerLid()

buildUpperLid()

getCtrlNumber()

getCtrls()

hasLower()

hasUpper()

isStickyToggled()

setCtrls(value)

setHasLower(value)

setHasUpper(value)

setStickyToggle(value)

autorigs.modules.advancedFace.lip.lipGuideOptions module

class autorigs.modules.advancedFace.lip.lipGuideOptions.ModuleOptionsWidget(buildguide, model, controller)

Bases: autorigs.modules.base.autoRigsBaseWidget.BaseOptionsWidget

CTRL_BUTTON_LABELS = ['5', '9']

CTRL_FIVE = 0

CTRL_NINE = 1

buildLowerLip()

buildUpperLip()

fromJSON(json)

toJSON()

updateSticky(toggle)

autorigs.modules.advancedFace.lip.lipGuideParams module

class autorigs.modules.advancedFace.lip.lipGuideParams.ModuleParamsWidget(buildguide, model)

Bases: autorigs.modules.base.autoRigsBaseWidget.BaseParamWidget

LOWER_LABEL = 'Lower Lip'

UPPER_LABEL = 'Upper Lip'

addComponentTab(layout)

addGuideParams(layout)

addModelCallbacks()

clearLayout(layout)

clearTab(tab, widgets)

fromJSON(json)

onCtrlsChanged(value)

populateTab(tab, guide_keys, guides, widgets)

resetLowerTab()

resetUpperTab()

Module contents