gear::xsi::rig::guide::RigGuide Class Reference

Rig guide class. More...

Inherits gear::xsi::rig::guide::MainGuide.

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	setFromSelection
	set the guide hierarchy from selection.
def	setFromHierarchy
	set the guide from given hierarchy.
def	findComponentRecursive
def	setFromFile
def	setFromXml
	set the guide hierarchy from given xml definition.
def	addOptionsValues
	Gather or change some options values according to some others.
def	importFromXml
	Import guide from xml.
def	exportToXml
	Export a guide to xml.
def	initialHierarchy
	Create the initial rig gudie hierarchy (model, options.
def	drawNewComponent
	Add a new component to the guide.
def	draw
def	update
def	duplicate
	Duplicate the guide hierarchy.
def	isValidModel
	Check if given model is a guide model.
def	getComponentGuide
Data Fields
	paramNames
	paramDefs
	values
	layout
	logic
	valid
	controlers
	components
	componentsIndex
	parents
	plog
	pRigName
	pMode
	pIsolateResult
	pPopUp
	pStep
	pSetHidden
	pSetDeformers
	pSetUnselect
	pSetGeometries
	pRColorfkr
	pRColorikr
	pCColorfkr
	pCColorikr
	pLColorfkr
	pLColorikr
	pInspectSettings
	pShadowRig
	pNegate
	pAddGeo
	pGeoPath
	pSkinPath
	pProdName
	pSynopticList
	pSynopticSelect
	pSynoptic
	pComments
	model
	options
	controlers_org
	hidden_grp
	unselectable_grp
	controlers_grp

---

Detailed Description

Rig guide class.

This is the class for complete rig guide definition.
It contains the component guide in correct hierarchy order and the options to generate the rig.
Provide the methods to add more component, import/export guide.

---

Member Function Documentation

def gear::xsi::rig::guide::RigGuide::addParameters

(

self

)

Add more parameter to the parameter definition list.

Parameters:

self

Reimplemented from gear::xsi::rig::guide::MainGuide.

def gear::xsi::rig::guide::RigGuide::addLayout

(

self

)

Add layout for new parameters.

Parameters:

self

Reimplemented from gear::xsi::rig::guide::MainGuide.

def gear::xsi::rig::guide::RigGuide::addLogic

(

self

)

Add logic for new layout.

Parameters:

self

Reimplemented from gear::xsi::rig::guide::MainGuide.

def gear::xsi::rig::guide::RigGuide::setFromSelection

(

self

)

set the guide hierarchy from selection.

Parameters:

self

def gear::xsi::rig::guide::RigGuide::setFromHierarchy	(		self,
			root,
			branch = True
	)

set the guide from given hierarchy.

Parameters:

	self
	root	X3DObject - The root of the hierarchy to parse.
	branch	Boolean - True to parse children components

def gear::xsi::rig::guide::RigGuide::setFromXml	(		self,
			xml_guide
	)

set the guide hierarchy from given xml definition.

Parameters:

	self
	xml_doc	xml_node - Xml definition of the guide.

def gear::xsi::rig::guide::RigGuide::addOptionsValues

(

self

)

Gather or change some options values according to some others.

Parameters:

self

def gear::xsi::rig::guide::RigGuide::importFromXml	(		self,
			path
	)

Import guide from xml.

Parameters:

	self
	path	String.

def gear::xsi::rig::guide::RigGuide::exportToXml	(		self,
			model,
			path
	)

Export a guide to xml.

Parameters:

	self
	model	Model - Model of the guide to export.
	path	String.

def gear::xsi::rig::guide::RigGuide::initialHierarchy

(

self

)

Create the initial rig gudie hierarchy (model, options.

..)

Parameters:

self

def gear::xsi::rig::guide::RigGuide::drawNewComponent	(		self,
			parent,
			comp_type
	)

Add a new component to the guide.

Parameters:

	self
	parent	X3DObject - Parent of this new component guide.
	compType	String - Type of component to add.

def gear::xsi::rig::guide::RigGuide::duplicate	(		self,
			root,
			symmetrize = False
	)

Duplicate the guide hierarchy.

Parameters:

	self
	root	X3DObject
	symmetrize	Boolean

Returns:

X3DObject - The root of the newly created hierarchy.

def gear::xsi::rig::guide::RigGuide::isValidModel	(		self,
			model
	)

Check if given model is a guide model.

Parameters:

	self
	model	Model - Model to check.

Returns:

Boolean - True if the model is valid.

---

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

• modules/gear/xsi/rig/guide.py