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

COMPONENT. More...

Inheritance diagram for gear.xsi.rig.component.wing_01.Component:
gear.xsi.rig.component.MainComponent

Public Member Functions

def addObjects
 Add all the objects needed to create the component. More...
 
def addParameters
 Add parameters to the anim and setup properties to control the component. More...
 
def addLayout
 Define the layout of the anim and setup properties. More...
 
def addLogic
 Define the logic of the anim and setup properties. More...
 
def addOperators
 Apply operators, constraints, expressions to the hierarchy. More...
 
def setRelation
 Set the relation beetween object from guide to rig. More...
 
def connect_standard
 standard connection definition. More...
 
- Public Member Functions inherited from gear.xsi.rig.component.MainComponent
def __init__
 Init Method. More...
 
def step_00
 Step 00. More...
 
def step_01
 Step 01. More...
 
def step_02
 Step 02. More...
 
def step_03
 Step 03. More...
 
def step_04
 Step 04. More...
 
def step_05
 NOT YET AVAILABLE.
 
def initialHierarchy
 Build the initial hierarchy of the component. More...
 
def addObjects
 Add all the objects needed to create the component. More...
 
def addToGroup
 Add the object in a collection for later group creation. More...
 
def addToCtlGroup
 
def addShadow
 
def getNormalFromPos
 
def getBiNormalFromPos
 
def addCtl
 
def getHost
 Get the host for the properties. More...
 
def addParameters
 Add parameters to the anim and setup properties to control the component. More...
 
def addLayout
 Define the layout of the anim and setup properties. More...
 
def addLogic
 Define the logic of the anim and setup properties. More...
 
def setUI
 
def addAnimParam
 Add a parameter to the animation property. More...
 
def addSetupParam
 Add a parameter to the setup property. More...
 
def addSetupFCurveParam
 Add a parameter to the setup property. More...
 
def addOperators
 Apply operators, constraint, expressions to the hierarchy. More...
 
def addConnection
 Add more connection definition to the set. More...
 
def setRelation
 Set the relation beetween object from guide to rig. More...
 
def getRelation
 Return the relational object from guide to rig. More...
 
def initConnector
 
def connect
 Connect the component to the rest of the rig using the defined connection. More...
 
def connect_standard
 standard connection definition. More...
 
def connect_standardWithIkRef
 standard connection definition with ik and upv references. More...
 
def postConnect
 Post connection actions. More...
 
def finalize
 
def getName
 Return the name for component element. More...
 
def getFullName
 return the fullname of the component More...
 
def getType
 return the type of the component More...
 

Public Attributes

 normal
 
 length0
 
 length1
 
 length2
 
 fk0_ctl
 
 fk1_ctl
 
 fk2_ctl
 
 ik_cns
 
 ikcns_ctl
 
 ik_ctl
 
 upv_cns
 
 upv_ctl
 
 bone0
 
 bone1
 
 ctrn_loc
 
 eff_loc
 
 mid_ctl
 
 memb_loc
 
 memb_crv
 
 tws0_loc
 
 tws0_rot
 
 tws1_loc
 
 tws1_rot
 
 tws2_loc
 
 tws2_rot
 
 end_ref
 
 divisions
 
 div_cns
 
 ikref_names
 
 upvref_names
 
 ikref_count
 
 upvref_count
 
 pFullName
 
 pBlend
 
 pIkRoll
 
 pIkCns
 
 pIkRef
 
 pUpvRef
 
 pScale
 
 pMaxStretch
 
 pSoftness
 
 pSlide
 
 pReverse
 
 pRoundness
 
 pVolume
 
 pDriver
 
 pFCurveCombo
 
 pSt_profile
 
 pSq_profile
 
 st_value
 
 sq_value
 
 pEdit
 
 pStretch
 
 pSquash
 
 pRestDist
 
 pStartPos
 
 pEndPos
 
 ikrefItems
 
 upvrefItems
 
- Public Attributes inherited from gear.xsi.rig.component.MainComponent
 rig
 
 guide
 
 options
 
 model
 
 settings
 
 name
 
 side
 
 index
 
 size
 
 color_fk
 
 color_ik
 
 negate
 
 n_sign
 
 n_factor
 
 groups
 
 controlers
 Dictionary of groups.
 
 inv_params
 List of all the controlers of the component.
 
 anim_layout
 
 anim_logic
 
 setup_layout
 
 setup_logic
 
 ui
 
 connections
 
 relatives
 
 stepMethods
 
 root
 
 shd_org
 
 uihost
 
 anim_prop
 
 setup_prop
 
 parent
 
 parent_comp
 

Additional Inherited Members

- Static Public Attributes inherited from gear.xsi.rig.component.MainComponent
list steps = ["Objects", "Properties", "Operators", "Connect", "Finalize"]
 
tuple local_params = ("posx", "posy", "posz", "rotx", "roty", "rotz", "rotorder", "sclx", "scly", "sclz")
 
tuple t_params = ("posx", "posy", "posz")
 
tuple r_params = ("rotx", "roty", "rotz", "rotorder")
 
tuple s_params = ("sclx", "scly", "sclz")
 
tuple tr_params = ("posx", "posy", "posz", "rotx", "roty", "rotz", "rotorder")
 
tuple rs_params = ("rotx", "roty", "rotz", "rotorder", "sclx", "scly", "sclz")
 
tuple x_axis = XSIMath.CreateVector3(1,0,0)
 
tuple y_axis = XSIMath.CreateVector3(0,1,0)
 
tuple z_axis = XSIMath.CreateVector3(0,0,1)
 
- Properties inherited from gear.xsi.rig.component.MainComponent
 fullName = property(getFullName)
 
 type = property(getType)
 

Detailed Description

COMPONENT.

The main component class.

Member Function Documentation

def gear.xsi.rig.component.wing_01.Component.addLayout (   self)

Define the layout of the anim and setup properties.

Parameters
self
def gear.xsi.rig.component.wing_01.Component.addLogic (   self)

Define the logic of the anim and setup properties.

Parameters
self
def gear.xsi.rig.component.wing_01.Component.addObjects (   self)

Add all the objects needed to create the component.

Parameters
self
def gear.xsi.rig.component.wing_01.Component.addOperators (   self)

Apply operators, constraints, expressions to the hierarchy.


In order to keep the code clean and easier to debug, we shouldn't create any new object in this method.

Parameters
self
def gear.xsi.rig.component.wing_01.Component.addParameters (   self)

Add parameters to the anim and setup properties to control the component.

Parameters
self
def gear.xsi.rig.component.wing_01.Component.connect_standard (   self)

standard connection definition.

Parameters
self
def gear.xsi.rig.component.wing_01.Component.setRelation (   self)

Set the relation beetween object from guide to rig.


Parameters
self

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