gear::xsi::rig::Rig Class Reference

The main rig class. More...

Public Member Functions

def __init__
 Init Method.
def buildFromSelection
 Build the rig from selected guides.
def buildFromFile
 Build the rig from xml definition file.
def build
def initialHierarchy
 Build the initial hierarchy of the rig Create the rig model, the main properties, and a couple of base organisation nulls Get the global size of the rig.
def processComponents
def finalize
 Build the initial hierarchy of the rig.
def addToGroup
 Add the object in a collection for later group creation.
def findChild
 Return the object in the rig matching the guide object.
def findComponent
def findUIHost

Data Fields

 guide
 components
 Dictionary of component.
 componentsIndex
 groups
 Dictionary of Groups.
 plog
 options
 guides
 model
 global_ctl
 info_prop
 info_layout
 info_mainTab
 ui
 setup_mainTab
 anim_mainTab
 pRigScale
 pOGLLevel
 pResolutions
 shd_org
 steps

Detailed Description

The main rig class.


Member Function Documentation

def gear::xsi::rig::Rig::__init__ (   self  ) 

Init Method.

Parameters:
self 
def gear::xsi::rig::Rig::buildFromSelection (   self  ) 

Build the rig from selected guides.

Parameters:
self 
def gear::xsi::rig::Rig::buildFromFile (   self,
  path = None 
)

Build the rig from xml definition file.

Parameters:
self 
path String - Path to an xml definition.
def gear::xsi::rig::Rig::initialHierarchy (   self  ) 

Build the initial hierarchy of the rig Create the rig model, the main properties, and a couple of base organisation nulls Get the global size of the rig.

Parameters:
self 
def gear::xsi::rig::Rig::finalize (   self  ) 

Build the initial hierarchy of the rig.

Parameters:
self 
def gear::xsi::rig::Rig::addToGroup (   self,
  objects,
  names = ["hidden"] 
)

Add the object in a collection for later group creation.

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.
def gear::xsi::rig::Rig::findChild (   self,
  guideName 
)

Return the object in the rig matching the guide object.

Parameters:
self 
guideName String - Name of the guide object

Field Documentation

Dictionary of component.


Keys are the component fullname (ie. 'arm_L0')

Dictionary of Groups.


The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2-20100208