gear.xsi.rig.guide.MainGuide Class Reference

GUIDE. More...

Inheritance diagram for gear.xsi.rig.guide.MainGuide:

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

Public Attributes
	paramNames
	paramDefs
	List of parameter name cause it's actually important to keep them sorted. More...
	values
	Dictionary of parameter definition. More...
	layout
	Dictionary of options values. More...
	logic
	PPGLayout object. More...
	valid
	PPGLogic object. More...

Detailed Description

GUIDE.

The main guide class.
Provide the methods to add parameters, set parameter values, create property...

Member Function Documentation

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.addLayout

(

self

)

Add layout for new parameters.

REIMPLEMENT. This method should be reimplemented in each guide.

Parameters

self

def gear.xsi.rig.guide.MainGuide.addLogic

(

self

)

Add logic for new layout.

REIMPLEMENT. This method should be reimplemented in each guide.

Parameters

self

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.addParameters

(

self

)

Add more parameter to the parameter definition list.

REIMPLEMENT. This method should be reimplemented in each guide.

Parameters

self

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.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

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.

Member Data Documentation

gear.xsi.rig.guide.MainGuide.layout

Dictionary of options values.

gear.xsi.rig.guide.MainGuide.logic

PPGLayout object.

gear.xsi.rig.guide.MainGuide.paramDefs

List of parameter name cause it's actually important to keep them sorted.

gear.xsi.rig.guide.MainGuide.valid

PPGLogic object.

gear.xsi.rig.guide.MainGuide.values

Dictionary of parameter definition.

---

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

• C:/datawork/__TECH__/GITHUB_REPOS/GEAR_mc/pythonlibs/gear/xsi/rig/guide.py