autorigs.modules.advancedFace.eye package

Submodules

autorigs.modules.advancedFace.eye.autoRigsEyeBuilder module

class autorigs.modules.advancedFace.eye.autoRigsEyeBuilder.AutoRigsEyeBuilder(*args, **kwargs)

Bases: autorigs.modules.advancedFace.lip.autoRigsLipBuilder.AutoRigsLipBuilder

INTERFACE = {'close': ('close', 'Close'), 'convergence': ('convergence', 'Convergence'), 'eyeball_influence': ('eyeball_influence', 'Eyeball Influence'), 'folder': ('folder', 'Eyes'), 'lid_folder': ('folder', 'Lid'), 'lookat_t': ('lookat_t', 'Lookat Translate'), 'master_lookat_blend': ('master_lookatblend', 'Follow Head'), 'masterlookat_r': ('masterlookat_r', 'Eyes Lookat Rotate'), 'masterlookat_t': ('masterlookat_t', 'Eyes Lookat Translate'), 'side_folder': ('folder', 'Eye'), 'weight': ('weight', 'Weight'), 'zip_left': ('zipleft', 'Zip Left'), 'zip_offset': ('zipoffset', 'Zip Offset'), 'zip_right': ('zipright', 'Zip Right')}
LEFT_PREFIX = 'L'
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',), 'eyefile': ('eye_geoFile',), 'eyegeo': ('eye_geo',), 'eyelookat': ('eye_lookat_ctrl',), 'eyelookatnull': ('eye_lookat_null',), 'eyelookup': ('eye_lookup',), 'eyemerge': ('eye_merge',), 'eyenull': ('eye_null',), 'eyeroot': ('eye_root',), 'fsp': ('findshortestpath',), 'lidroot': ('lid_root',), 'masterlookat': ('master_lookat',), 'masterlookat_target': ('master_lookat_target',), 'merge': ('object_merge',), 'movepointswrangle': ('move_points_to_nulls',), 'nctrlcurveout': ('N_curve_OUT',), 'orbitbone': ('orbit_bone',), 'orbitroot': ('orbit_root',), 'root': ('root',), 'wiredef': ('wiredeform',)}
RIGHT_PREFIX = 'R'
STICK_KEY = 'stick'
STICK_SUFFIX = 'stick'
buildLid(point_nums, ctrl_guides, side_group, group, lpc_group_name)

Builds one of the upper or lower eyelids @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 side_group (Sidegroup): Sidegroup class (either self.left_group or self.right_group) @param group (BuilderGroup): Either an upper or lower builder group belonging to a side_group @param lpc_group_name (string): Group name of the polycage points that affect the lid - used for blendshapes

buildLowerLid(side_group, ismain)
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

buildRigControlsSide(side_group, ismain)

Build controls for one side of the eyes

buildUpperLid(side_group, ismain)
createEyeGeo(side_group, geo_path, grp_path, mirror=False)

Creates a node reference to the eye geometry

createFolderTemplate()

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

createGroups()
createLowerFolder(side_group)
createSideFolderTemplate(side_group, ismain)
createUpperFolder(side_group)
getParent()

Get the parent hook object

getSide(ismain)
getSideGroup(ismain)
hasValidEyeGeo(operator, group)
isUpper(prefix)
makeAverageLine(side_group, group, network)
makeSticky(prefix, side_group, group, network)
makeStickyNetwork(prefix, side_group, group, network)
onCaptureCompleted()

Processes to run after geometry is captured

onCaptureCompletedSide(ismain, side_group)
setParent(parent)
updateDicts()
class autorigs.modules.advancedFace.eye.autoRigsEyeBuilder.SideGroup(assetnode, prefix, group_prefix, nodes, interface, upper_lpc_name, lower_lpc_name)

Bases: object

LOWER_PREFIX = 'Lower'
UPPER_PREFIX = 'Upper'
getGroups()
getLowerGroup()
getLowerLPCName()
getMainGroup()
getUpperGroup()
getUpperLPCName()

autorigs.modules.advancedFace.eye.buildEyeGuide module

class autorigs.modules.advancedFace.eye.buildEyeGuide.EyeGuide(autorigs_asset, geometryguides)

Bases: autorigs.modules.base.buildBaseGuide.BaseGuide

EYE_ROOT = 'eyeroot'
MAIN_PREFIX = 'main'
SECONDARY_PREFIX = 'secondary'
buildFromJsonExisting(json)
buildFromJsonNew(json, parent=None)
getControlGuides(ismain, part)
getGeometryGuide()
getMainSide()
getMaxLocNum()
getPoints(ismain, part)
getSecondarySide()
getSideGuide(key, ismain=True)
snapEyeToGeometry(side, node, geo, primgrp=None)
toJSON()
toggleModule(toggle)
updateCtrls(value)
updateMirror(value)
updateSide(value)
updateSticky(value)
class autorigs.modules.advancedFace.eye.buildEyeGuide.EyeGuidePart(autorigs_asset, prefix, geometryguides)

Bases: autorigs.modules.advancedFace.lip.buildLipGuide.LipGuidePart

CONTROL = 'guide'
CONTROL_ROOT = 'ctrlroot'
CTRL_CURVE_OUT = 'ctrlout'
CTRL_SWITCH = 'switch'
GUIDENAMES = {'ctrlout': 'ctrl_curve_OUT', 'ctrlroot': 'eye_ctrl_root', 'guide': 'guide', 'guidecurve': 'eye_curve', 'mirrorpoints': 'mirror_points_OUT', 'nctrlout': 'N_curve_OUT', 'objmerge': 'geo', 'points': 'selected_points_group', 'shortestpath': 'make_curve', 'switch': 'controls_switch'}
GUIDE_CURVE = 'guidecurve'
MGUIDENAMES = {'ctrlout': 'ctrl_curve_OUT', 'ctrlroot': 'mirror_eye_ctrl_root', 'guide': 'mirror_guide', 'guidecurve': 'mirror_eye_curve', 'nctrlout': 'N_curve_OUT', 'objmerge': 'geo', 'points': 'selected_points_group', 'shortestpath': 'make_curve', 'switch': 'controls_switch'}
MIRROR_POINTS = 'mirrorpoints'
NCTRL_CURVE_OUT = 'nctrlout'
OBJECT_MERGE = 'objmerge'
POINTS_GROUP = 'points'
SHORTEST_PATH = 'shortestpath'
buildFromJsonExisting(json)
buildFromJsonNew(json)
createMirrorPointsNetwork()

Creates a network in the main side lid that calculates the 3 mirror points of the findshortestpath curve and outputs it to a detail attribute

deleteGuides()
destroyControlGuides(ismain=True)
displayGuides(display)
generateControlGuides(numctrls)
generateLid(numctrls)
generateMirrorControlGuides(numctrls)
generateNodes(numctrls)
getGuideObject(guidename, ismain=True)
getLocNum()
getMirrorControlGuides()
getMirrorPoints()
lockGuides(lock)
removeGuideObject(guidename, ismain=True)
renameGuides(json)
resnapControlGuides()

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

resnapControlGuidesSide(ismain=True)
setMirrorExpressions()
toJSON()
updateCtrls(value)
updateMirror(value)
updateSide(value)
class autorigs.modules.advancedFace.eye.buildEyeGuide.EyeGuideSide(*args, **kwargs)

Bases: autorigs.modules.advancedFace.lip.buildLipGuide.LipGuide

BUILD_ERROR_MSG = 'Sticky eyes require building both the upper and lower lid before generating.'
CENTER_GUIDE = 'center_guide'
LID_PREFIX = ['UpperLid', 'LowerLid']
LOOKAT = 'lookat'
LOOKAT_GUIDECURVE = 'lookat_guidecurve'
ROOT = 'eyeroot'
buildFromJsonExisting(json)
buildFromJsonNew(json, parent=None)
createSubguides()
deleteGuides()
getControlGuides(ismain, part)
getGuideObject(guidename, ismain=True)
getPoints(ismain, part)
showGuides(display)
snapEyeToGeometry(node, geo, primgrp=None)
toJSON()
updateMirror(value)
updateSide(value)

autorigs.modules.advancedFace.eye.eyeGuideController module

class autorigs.modules.advancedFace.eye.eyeGuideController.EyeGuideController(model)
onCtrlsChanged(value)
onMirrorToggled(value)
onSideChanged(value)
onStickyToggled(value)

autorigs.modules.advancedFace.eye.eyeGuideModel module

class autorigs.modules.advancedFace.eye.eyeGuideModel.EyeGuideModel

Bases: autorigs.modules.base.baseGuideModel.BaseGuideModel

CTRL_DEFAULT = 0
CTRL_FIVE = 0
CTRL_NINE = 1
CTRL_TO_NUM = {0: 5, 1: 9}
NUM_TO_CTRL = {5: 0, 9: 1}
PART_LOWER = 1
PART_UPPER = 0
SIDE_DEFAULT = 0
SIDE_LEFT = 0
SIDE_MAIN = 0
SIDE_RIGHT = 1
SIDE_SECONDARY = 1
addBuildLowerCallback(fxn, side)
addBuildUpperCallback(fxn, side)
addUpdateCtrlsCallback(fxn)
addUpdateMirrorCallback(fxn)
addUpdateSideCallback(fxn)
addUpdateStickyCallback(fxn)
buildLowerLid(side)
buildUpperLid(side)
getCtrlNumber()
getCtrls()
getHasLower(side=None)
getHasUpper(side=None)
getLeftGroup()
getLeftOperator()
getRightGroup()
getRightOperator()
getSide()
hasLower(side)
hasMain()
hasSecondary()
hasUpper(side)
isGeometryToggled()
isMirrored()
isStickyToggled()
setCtrls(value)
setGeometryToggle(value)
setHasLower(value, side=None)
setHasUpper(value, side=None)
setLeftGroup(group)
setLeftOperator(operator)
setMirrored(value)
setRightGroup(group)
setRightOperator(operator)
setSide(value)
setStickyToggle(value)

autorigs.modules.advancedFace.eye.eyeGuideOptions module

class autorigs.modules.advancedFace.eye.eyeGuideOptions.ModuleOptionsWidget(buildguide, model, controller)

Bases: autorigs.modules.base.autoRigsBaseWidget.BaseOptionsWidget

CTRL_BUTTON_LABELS = ['5', '9']
CTRL_FIVE = 0
CTRL_NINE = 1
LID_PREFIX = ['UpperLid', 'LowerLid']
SIDE_BUTTON_LABELS = ['Left', 'Right']
SIDE_LEFT = 0
SIDE_RIGHT = 1
buildLowerLid(side)
buildUpperLid(side)
changeFormLayout(formlayout)
createBuildSideButtons(side)
fromJSON(json)
onGeometryToggled(value)
toJSON()
updateLeftEyeGeo()
updateMirror(toggle)
updateRightEyeGeo()
updateSide(side)
updateSticky(toggle)

autorigs.modules.advancedFace.eye.eyeGuideParams module

class autorigs.modules.advancedFace.eye.eyeGuideParams.ModuleParamsWidget(eyeguide, model)

Bases: autorigs.modules.base.autoRigsBaseWidget.BaseParamWidget

SIDE_LABELS = ['Left Side', 'Right Side']
fromJSON(json)
toJSON()
unlinkAllNodes()
updateMirror(value)
updateSide(value)
class autorigs.modules.advancedFace.eye.eyeGuideParams.ModuleParamsWidgetSide(eyeguide, model, side)

Bases: autorigs.modules.advancedFace.lip.lipGuideParams.ModuleParamsWidget

LOWER_LABEL = 'Lower Lid'
UPPER_LABEL = 'Upper Lid'
addGuideParams(layout)
addModelCallbacks()

autorigs.modules.advancedFace.eye.eyeModule module

Module contents