gear::xsi::rig::guide::MainGuide Class Reference

The main guide class. More...

Inherited by gear::xsi::rig::component::guide::ComponentGuide, and gear::xsi::rig::guide::RigGuide.

Public Member Functions

def __init__
def addParameters
 Add more parameter to the parameter definition list.
def addLayout
 Add layout for new parameters.
def addLogic
 Add logic for new layout.
def addProperty
 Add a property (sn_PSet) with all the parameters from the parameter definition list.
def getParametersAsXml
def setParamDefValue
 Set the value of parameter with matching scriptname.
def setParamDefValuesFromProperty
 Set the parameter values from given property.
def setParamDefValuesFromXml
 Set the parameter values from given xml defintion.
def addParam
 Add a paramDef to the list.
def addFCurveParam
 Add a paramDef to the list.
def addToGroup
 Add the object to a group.

Data Fields

 paramNames
 paramDefs
 values
 layout
 logic
 valid

Detailed Description

The main guide class.


Provide the methods to add parameters, set parameter values, create property...

Member Function Documentation

def gear::xsi::rig::guide::MainGuide::addParameters (   self  ) 

Add more parameter to the parameter definition list.

REIMPLEMENT. This method should be reimplemented in each guide.

Parameters:
self 

Reimplemented in gear::xsi::rig::component::arm_2jnt_01::guide::Guide, gear::xsi::rig::component::chain_01::guide::Guide, gear::xsi::rig::component::chain_cns_01::guide::Guide, gear::xsi::rig::component::control_01::guide::Guide, gear::xsi::rig::component::foot_bk_01::guide::Guide, gear::xsi::rig::component::guide::ComponentGuide, gear::xsi::rig::component::leg_2jnt_01::guide::Guide, gear::xsi::rig::component::leg_3jnt_01::guide::Guide, gear::xsi::rig::component::meta_01::guide::Guide, gear::xsi::rig::component::neck_ik_01::guide::Guide, gear::xsi::rig::component::spine_ik_01::guide::Guide, gear::xsi::rig::component::tail_01::guide::Guide, gear::xsi::rig::component::wing_01::guide::Guide, and gear::xsi::rig::guide::RigGuide.

def gear::xsi::rig::guide::MainGuide::addLayout (   self  ) 

Add layout for new parameters.

REIMPLEMENT. This method should be reimplemented in each guide.

Parameters:
self 

Reimplemented in gear::xsi::rig::component::arm_2jnt_01::guide::Guide, gear::xsi::rig::component::chain_01::guide::Guide, gear::xsi::rig::component::chain_cns_01::guide::Guide, gear::xsi::rig::component::control_01::guide::Guide, gear::xsi::rig::component::foot_bk_01::guide::Guide, gear::xsi::rig::component::guide::ComponentGuide, gear::xsi::rig::component::leg_2jnt_01::guide::Guide, gear::xsi::rig::component::leg_3jnt_01::guide::Guide, gear::xsi::rig::component::meta_01::guide::Guide, gear::xsi::rig::component::neck_ik_01::guide::Guide, gear::xsi::rig::component::spine_ik_01::guide::Guide, gear::xsi::rig::component::tail_01::guide::Guide, gear::xsi::rig::component::wing_01::guide::Guide, and gear::xsi::rig::guide::RigGuide.

def gear::xsi::rig::guide::MainGuide::addLogic (   self  ) 

Add logic for new layout.

REIMPLEMENT. This method should be reimplemented in each guide.

Parameters:
self 

Reimplemented in gear::xsi::rig::component::arm_2jnt_01::guide::Guide, gear::xsi::rig::component::chain_01::guide::Guide, gear::xsi::rig::component::chain_cns_01::guide::Guide, gear::xsi::rig::component::control_01::guide::Guide, gear::xsi::rig::component::foot_bk_01::guide::Guide, gear::xsi::rig::component::guide::ComponentGuide, gear::xsi::rig::component::leg_2jnt_01::guide::Guide, gear::xsi::rig::component::leg_3jnt_01::guide::Guide, gear::xsi::rig::component::meta_01::guide::Guide, gear::xsi::rig::component::neck_ik_01::guide::Guide, gear::xsi::rig::component::spine_ik_01::guide::Guide, gear::xsi::rig::component::tail_01::guide::Guide, gear::xsi::rig::component::wing_01::guide::Guide, and gear::xsi::rig::guide::RigGuide.

def gear::xsi::rig::guide::MainGuide::addProperty (   self,
  parent,
  name 
)

Add a property (sn_PSet) with all the parameters from the parameter definition list.

Parameters:
self 
parent X3DObject - The parent of the property.
name String - Name of the new property. @ return Property - The newly created property.
def gear::xsi::rig::guide::MainGuide::setParamDefValue (   self,
  scriptName,
  value 
)

Set the value of parameter with matching scriptname.

Parameters:
self 
scriptName String - Scriptname of the parameter to edit.
value Variant - New value.
Returns:
Boolean - False if the parameter wasn't found.
def gear::xsi::rig::guide::MainGuide::setParamDefValuesFromProperty (   self,
  prop 
)

Set the parameter values from given property.

Parameters:
self 
prop Property - The property to parse.
def gear::xsi::rig::guide::MainGuide::setParamDefValuesFromXml (   self,
  xml_prop 
)

Set the parameter values from given xml defintion.

Parameters:
self 
xml_root xml_node - The xml definition to parse.
def gear::xsi::rig::guide::MainGuide::addParam (   self,
  scriptName,
  valueType,
  value,
  minimum = None,
  maximum = None,
  sugMinimum = None,
  sugMaximum = None,
  animatable = False,
  readOnly = False,
  keyable = False 
)

Add a paramDef to the list.


Note that animatable and keyable are false per default.

Parameters:
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.
Returns:
ParamDef - The newly created parameter definition.
def gear::xsi::rig::guide::MainGuide::addFCurveParam (   self,
  scriptName,
  keys,
  interpolation = c.siCubicInterpolation 
)

Add a paramDef to the list.


Note that animatable and keyable are false per default.

Parameters:
self 
scriptName String - Parameter scriptname.
Returns:
FCurveParamDef - The newly created parameter definition.
def gear::xsi::rig::guide::MainGuide::addToGroup (   self,
  objects,
  names = ["hidden"] 
)

Add the object to a group.

Parameters:
self 
objs Single or List of X3DObject - object to put in group
names Single or List of String - names of the groups to create
The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2-20100208