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

CLASS. More...

Inheritance diagram for gear.xsi.rig.component.leg_2jnt_02.guide.Guide:
gear.xsi.rig.component.guide.ComponentGuide gear.xsi.rig.guide.MainGuide

Public Member Functions

def postInit
 
def addObjects
 Add more object to the object definition list. More...
 
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...
 
- Public Member Functions inherited from gear.xsi.rig.component.guide.ComponentGuide
def __init__
 Init method. More...
 
def postInit
 Define the objects name and categories. More...
 
def initialHierarchy
 Initial hierachy. More...
 
def addObjects
 Create the objects of the guide. More...
 
def addParameters
 Create the parameter definitions of the guide. More...
 
def addLayout
 Define the layout attached to the parameters. More...
 
def addLogic
 Define the logic attached to the ppg. More...
 
def setFromHierarchy
 
def setFromXml
 
def getAsXml
 Return the guide as an xml definition. More...
 
def draw
 Draw the guide in the scene. More...
 
def drawFromUI
 Launch a pick session to get the position of the guide, then draw the guide in the scene. More...
 
def drawFromXml
 
def pickPositions
 Launch a pick session to get the position of the guide. More...
 
def drawRef
 Create a temporary null to display the picked position. More...
 
def setIndex
 Update the component index to get the next valid one. More...
 
def symmetrize
 Inverse the transform of each element of the guide. More...
 
def rename
 Rename the component. More...
 
def addRoot
 Add a root object to the guide. More...
 
def addLoc
 Add a loc object to the guide. More...
 
def addLocMulti
 Add multiple loc objects to the guide. More...
 
def addCurve
 Add a curve object to the guide. More...
 
def addCurve2
 Add a curve object to the guide. More...
 
def addBlade
 Add a blade object to the guide. More...
 
def addDispCurve
 Add a display curve object to the guide. More...
 
def getObjects
 
def addMinMax
 
def getSize
 
def getName
 Return the fullname of given element of the component. More...
 
def getFullName
 Return the fullname of the component. More...
 
def getType
 Return the type of the component. More...
 
def getObjectNames
 
def getVersion
 
- 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

 pick_transform
 
 save_transform
 
 root
 
 knee
 
 ankle
 
 eff
 
 dispcrv
 
 pBlend
 
 pIkRef
 
 pIkRefArray
 
 pUpvRef
 
 pUpvRefArray
 
 pMaxStretch
 
 pDiv0
 
 pDiv1
 
 pFCurveCombo
 
 pSt_profile
 
 pSq_profile
 
- Public Attributes inherited from gear.xsi.rig.component.guide.ComponentGuide
 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...
 
 root
 
 id
 
 parentComponent
 
 parentLocalName
 
 tra
 
 atra
 dictionary of global transform
 
 pos
 list of global transform
 
 apos
 dictionary of global postion
 
 prim
 list of global position
 
 blades
 List of primitive.
 
 size
 
 root_size
 
 pick_transform
 
 save_transform
 User will have to pick the position of this object name.
 
 save_primitive
 Transform of object name in this list will be saved.
 
 save_blade
 Primitive of object name in this list will be saved.
 
 minmax
 Normal and BiNormal of object will be saved.
 
 pCompType
 
 pCompName
 
 pCompSide
 
 pCompIndex
 
 pConnector
 
 pUIHost
 
 pSetGrp
 
 pCtlGrp
 
 model
 
 settings
 
 parent
 
- 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...
 

Static Public Attributes

 compType = TYPE
 
 compName = NAME
 
 description = DESCRIPTION
 
 author = AUTHOR
 
 url = URL
 
 email = EMAIL
 
 version = VERSION
 
list compatible = ["leg_2jnt_01"]
 
- Static Public Attributes inherited from gear.xsi.rig.component.guide.ComponentGuide
string compType = "component"
 
string compName = "component"
 Component type.
 
string compSide = "C"
 Component default name.
 
int compIndex = 0
 
string description = ""
 Component default index.
 
list connectors = []
 Description of the component.
 
list compatible = []
 
string ctl_grp = ""
 

Additional Inherited Members

- Properties inherited from gear.xsi.rig.component.guide.ComponentGuide
 fullName = property(getFullName)
 
 type = property(getType)
 
 objectNames = property(getObjectNames)
 

Detailed Description

CLASS.

Member Function Documentation

def gear.xsi.rig.component.leg_2jnt_02.guide.Guide.addLayout (   self)

Add layout for new parameters.

Parameters
self
def gear.xsi.rig.component.leg_2jnt_02.guide.Guide.addLogic (   self)

Add logic for new layout.

Parameters
self
def gear.xsi.rig.component.leg_2jnt_02.guide.Guide.addObjects (   self)

Add more object to the object definition list.

Parameters
self
def gear.xsi.rig.component.leg_2jnt_02.guide.Guide.addParameters (   self)

Add more parameter to the parameter definition list.

Parameters
self
def gear.xsi.rig.component.leg_2jnt_02.guide.Guide.postInit (   self)
Parameters
self

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