|
gear_mc
|
BUILDER. More...
Public Member Functions | |
| 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 | |
| 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 | |
Properties | |
| fullName = property(getFullName) | |
| type = property(getType) | |
BUILDER.
| def gear.xsi.rig.component.MainComponent.__init__ | ( | self, | |
| rig, | |||
| guide | |||
| ) |
| def gear.xsi.rig.component.MainComponent.addAnimParam | ( | self, | |
| scriptName, | |||
| valueType, | |||
| value, | |||
minimum = None, |
|||
maximum = None, |
|||
sugMinimum = None, |
|||
sugMaximum = None, |
|||
animatable = True, |
|||
readOnly = False, |
|||
keyable = True |
|||
| ) |
Add a parameter to the animation property.
Note that animatable and keyable are True per default.
| self | |
| scriptName | String - Parameter scriptname. |
| valueType | Integer - siVariantType. |
| value | Variant - Default parameter value. |
| minimum | Variant - mininum value. |
| maximum | Variant - maximum value. |
| sugMinimum | Variant - suggested mininum value. |
| sugMaximum | Variant - suggested maximum value. |
| animatable | Boolean - True to make parameter animatable. |
| readOnly | Boolean - True to make parameter readOnly. |
| keyable | Boolean - True to make parameter keyable. |
| def gear.xsi.rig.component.MainComponent.addConnection | ( | self | ) |
Add more connection definition to the set.
REIMPLEMENT. This method should be reimplemented in each component.
Only if you need to use an new connection (not the standard).
| self |
| def gear.xsi.rig.component.MainComponent.addLayout | ( | self | ) |
Define the layout of the anim and setup properties.
REIMPLEMENT. This method should be reimplemented in each component.
| self |
| def gear.xsi.rig.component.MainComponent.addLogic | ( | self | ) |
Define the logic of the anim and setup properties.
REIMPLEMENT. This method should be reimplemented in each component.
| self |
| def gear.xsi.rig.component.MainComponent.addObjects | ( | self | ) |
Add all the objects needed to create the component.
REIMPLEMENT. This method should be reimplemented in each component.
Try not to apply any constraint, operator, or expression in here. Just X3DObjects.
| self |
| def gear.xsi.rig.component.MainComponent.addOperators | ( | self | ) |
Apply operators, constraint, expressions to the hierarchy.
REIMPLEMENT. This method should be reimplemented in each component.
We shouldn't create any new object in this method.
| self |
| def gear.xsi.rig.component.MainComponent.addParameters | ( | self | ) |
Add parameters to the anim and setup properties to control the component.
REIMPLEMENT. This method should be reimplemented in each component.
| self |
| def gear.xsi.rig.component.MainComponent.addSetupFCurveParam | ( | self, | |
| scriptName, | |||
| ref_fcv | |||
| ) |
Add a parameter to the setup property.
Note that animatable and keyable are false per default.
| self | |
| scriptName | String - Parameter scriptname. |
| valueType | Integer - siVariantType. |
| value | Variant - Default parameter value. |
| minimum | Variant - mininum value. |
| maximum | Variant - maximum value. |
| sugMinimum | Variant - suggested mininum value. |
| sugMaximum | Variant - suggested maximum value. |
| animatable | Boolean - True to make parameter animatable. |
| readOnly | Boolean - True to make parameter readOnly. |
| keyable | Boolean - True to make parameter keyable. |
| def gear.xsi.rig.component.MainComponent.addSetupParam | ( | self, | |
| scriptName, | |||
| valueType, | |||
| value, | |||
minimum = None, |
|||
maximum = None, |
|||
sugMinimum = None, |
|||
sugMaximum = None, |
|||
animatable = False, |
|||
readOnly = False, |
|||
keyable = False |
|||
| ) |
Add a parameter to the setup property.
Note that animatable and keyable are false per default.
| self | |
| scriptName | String - Parameter scriptname. |
| valueType | Integer - siVariantType. |
| value | Variant - Default parameter value. |
| minimum | Variant - mininum value. |
| maximum | Variant - maximum value. |
| sugMinimum | Variant - suggested mininum value. |
| sugMaximum | Variant - suggested maximum value. |
| animatable | Boolean - True to make parameter animatable. |
| readOnly | Boolean - True to make parameter readOnly. |
| keyable | Boolean - True to make parameter keyable. |
| def gear.xsi.rig.component.MainComponent.addToGroup | ( | self, | |
| objects, | |||
names = ["hidden"] |
|||
| ) |
Add the object in a collection for later group creation.
| self | |
| objs | Single or List of X3DObject - object to put in group |
| names | Single or List of String - names of the groups to create |
| def gear.xsi.rig.component.MainComponent.connect | ( | self | ) |
Connect the component to the rest of the rig using the defined connection.
| def gear.xsi.rig.component.MainComponent.connect_standard | ( | self | ) |
standard connection definition.
This is a simple parenting of the root.
| self |
| def gear.xsi.rig.component.MainComponent.connect_standardWithIkRef | ( | self | ) |
standard connection definition with ik and upv references.
| self |
| def gear.xsi.rig.component.MainComponent.getFullName | ( | self | ) |
return the fullname of the component
| self |
| def gear.xsi.rig.component.MainComponent.getHost | ( | self | ) |
Get the host for the properties.
| self |
| def gear.xsi.rig.component.MainComponent.getName | ( | self, | |
name = "", |
|||
side = None |
|||
| ) |
Return the name for component element.
| self | |
| name | String - Name. |
| def gear.xsi.rig.component.MainComponent.getRelation | ( | self, | |
| name | |||
| ) |
Return the relational object from guide to rig.
| self | |
| local | name of the guide object. |
| def gear.xsi.rig.component.MainComponent.getType | ( | self | ) |
return the type of the component
| self |
| def gear.xsi.rig.component.MainComponent.initialHierarchy | ( | self | ) |
Build the initial hierarchy of the component.
Add the root and if needed the shadow root
| self |
| def gear.xsi.rig.component.MainComponent.postConnect | ( | self | ) |
Post connection actions.
REIMPLEMENT. This method should be reimplemented in each component.
| self |
| def gear.xsi.rig.component.MainComponent.setRelation | ( | self | ) |
Set the relation beetween object from guide to rig.
REIMPLEMENT. This method should be reimplemented in each component.
| self |
| def gear.xsi.rig.component.MainComponent.step_00 | ( | self | ) |
Step 00.
Initial Hierarchy, create objects and set the connection relation.
| self |
| def gear.xsi.rig.component.MainComponent.step_01 | ( | self | ) |
Step 01.
Get the properties host, create parameters and set layout and logic.
| self |
| def gear.xsi.rig.component.MainComponent.step_02 | ( | self | ) |
Step 02.
Apply all the operators.
| self |
| def gear.xsi.rig.component.MainComponent.step_03 | ( | self | ) |
Step 03.
Connect the component to the rest of the rig.
| self |
| def gear.xsi.rig.component.MainComponent.step_04 | ( | self | ) |
Step 04.
Finalize the component.
| self |
1.8.5
