gear_mc
 All Classes Namespaces Functions Variables
Public Member Functions | Public Attributes | List of all members
gear.xsi.rig.guide.RigGuide Class Reference

Rig guide class. More...

Inheritance diagram for gear.xsi.rig.guide.RigGuide:
gear.xsi.rig.guide.MainGuide

Public Member Functions

def __init__
 
def addParameters
 Add more parameter to the parameter definition list. More...
 
def addLayout
 Add layout for new parameters. More...
 
def addLogic
 Add logic for new layout. More...
 
def setFromSelection
 set the guide hierarchy from selection. More...
 
def setFromHierarchy
 set the guide from given hierarchy. More...
 
def findComponentRecursive
 
def setFromFile
 
def setFromXml
 set the guide hierarchy from given xml definition. More...
 
def addOptionsValues
 Gather or change some options values according to some others. More...
 
def importFromXml
 Import guide from xml. More...
 
def exportToXml
 Export a guide to xml. More...
 
def initialHierarchy
 Create the initial rig gudie hierarchy (model, options...) More...
 
def drawNewComponent
 Add a new component to the guide. More...
 
def draw
 
def update
 
def duplicate
 Duplicate the guide hierarchy. More...
 
def isValidModel
 Check if given model is a guide model. More...
 
def getComponentGuide
 
- Public Member Functions inherited from gear.xsi.rig.guide.MainGuide
def __init__
 
def addParameters
 Add more parameter to the parameter definition list. More...
 
def addLayout
 Add layout for new parameters. More...
 
def addLogic
 Add logic for new layout. More...
 
def addProperty
 Add a property (sn_PSet) with all the parameters from the parameter definition list. More...
 
def getParametersAsXml
 
def setParamDefValue
 Set the value of parameter with matching scriptname. More...
 
def setParamDefValuesFromProperty
 Set the parameter values from given property. More...
 
def setParamDefValuesFromXml
 Set the parameter values from given xml defintion. More...
 
def addParam
 Add a paramDef to the list. More...
 
def addFCurveParam
 Add a paramDef to the list. More...
 
def addToGroup
 Add the object to a group. More...
 

Public Attributes

 paramNames
 
 paramDefs
 List of parameter name cause it's actually important to keep them sorted. More...
 
 values
 Dictionary of parameter definition. More...
 
 layout
 Dictionary of options values. More...
 
 logic
 PPGLayout object. More...
 
 valid
 PPGLogic object. More...
 
 controlers
 
 components
 Dictionary of controlers Keys are the component fullname (ie. More...
 
 componentsIndex
 Dictionary of component.
 
 parents
 List of component name sorted by order creation (hierarchy order)
 
 plog
 List of the parent of each component, in same order as self.components.
 
 pRigName
 
 pMode
 
 pIsolateResult
 
 pPopUp
 
 pStep
 
 pSetHidden
 
 pSetDeformers
 
 pSetUnselect
 
 pSetGeometries
 
 pRColorfkr
 
 pRColorikr
 
 pCColorfkr
 
 pCColorikr
 
 pLColorfkr
 
 pLColorikr
 
 pInspectSettings
 
 pShadowRig
 
 pNegate
 
 pAddGeo
 
 pGeoPath
 
 pSkinPath
 
 pAddXRig
 
 pXRigPath
 
 pProdName
 
 pSynopticList
 
 pSynopticSelect
 
 pSynoptic
 
 pComments
 
 model
 
 options
 
 controlers_org
 
 hidden_grp
 
 unselectable_grp
 
 controlers_grp
 
- Public Attributes inherited from gear.xsi.rig.guide.MainGuide
 paramNames
 
 paramDefs
 List of parameter name cause it's actually important to keep them sorted. More...
 
 values
 Dictionary of parameter definition. More...
 
 layout
 Dictionary of options values. More...
 
 logic
 PPGLayout object. More...
 
 valid
 PPGLogic object. More...
 

Detailed Description

Rig guide class.


This is the class for complete rig guide definition.
It contains the component guide in correct hierarchy order and the options to generate the rig.
Provide the methods to add more component, import/export guide.

Member Function Documentation

def gear.xsi.rig.guide.RigGuide.addLayout (   self)

Add layout for new parameters.

Parameters
self
def gear.xsi.rig.guide.RigGuide.addLogic (   self)

Add logic for new layout.

Parameters
self
def gear.xsi.rig.guide.RigGuide.addOptionsValues (   self)

Gather or change some options values according to some others.

Parameters
self
def gear.xsi.rig.guide.RigGuide.addParameters (   self)

Add more parameter to the parameter definition list.

Parameters
self
def gear.xsi.rig.guide.RigGuide.drawNewComponent (   self,
  parent,
  comp_type 
)

Add a new component to the guide.

Parameters
self
parentX3DObject - Parent of this new component guide.
compTypeString - Type of component to add.
def gear.xsi.rig.guide.RigGuide.duplicate (   self,
  root,
  symmetrize = False 
)

Duplicate the guide hierarchy.

Parameters
self
rootX3DObject
symmetrizeBoolean
Returns
X3DObject - The root of the newly created hierarchy.
def gear.xsi.rig.guide.RigGuide.exportToXml (   self,
  model,
  path 
)

Export a guide to xml.

Parameters
self
modelModel - Model of the guide to export.
pathString.
def gear.xsi.rig.guide.RigGuide.importFromXml (   self,
  path 
)

Import guide from xml.

Parameters
self
pathString.
def gear.xsi.rig.guide.RigGuide.initialHierarchy (   self)

Create the initial rig gudie hierarchy (model, options...)

Parameters
self
def gear.xsi.rig.guide.RigGuide.isValidModel (   self,
  model 
)

Check if given model is a guide model.

Parameters
self
modelModel - Model to check.
Returns
Boolean - True if the model is valid.
def gear.xsi.rig.guide.RigGuide.setFromHierarchy (   self,
  root,
  branch = True 
)

set the guide from given hierarchy.

Parameters
self
rootX3DObject - The root of the hierarchy to parse.
branchBoolean - True to parse children components
def gear.xsi.rig.guide.RigGuide.setFromSelection (   self)

set the guide hierarchy from selection.

Parameters
self
def gear.xsi.rig.guide.RigGuide.setFromXml (   self,
  xml_guide 
)

set the guide hierarchy from given xml definition.

Parameters
self
xml_docxml_node - Xml definition of the guide.

Member Data Documentation

gear.xsi.rig.guide.RigGuide.components

Dictionary of controlers Keys are the component fullname (ie.

'arm_L0')

gear.xsi.rig.guide.RigGuide.layout

Dictionary of options values.

gear.xsi.rig.guide.RigGuide.logic

PPGLayout object.

gear.xsi.rig.guide.RigGuide.paramDefs

List of parameter name cause it's actually important to keep them sorted.

gear.xsi.rig.guide.RigGuide.valid

PPGLogic object.

gear.xsi.rig.guide.RigGuide.values

Dictionary of parameter definition.


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