gear::xsi::rig::component::MainComponent Class Reference

Public Member Functions
def	__init__
	Init Method.
def	step_00
	Step 00.
def	step_01
	Step 01.
def	step_02
	Step 02.
def	step_03
	Step 03.
def	step_04
	Step 04.
def	step_05
	NOT YET AVAILABLE.
def	initialHierarchy
	Build the initial hierarchy of the component.
def	addObjects
	Add all the objects needed to create the component.
def	addToGroup
	Add the object in a collection for later group creation.
def	addToCtlGroup
def	addShadow
def	getNormalFromPos
def	getBiNormalFromPos
def	addCtl
def	getHost
	Get the host for the properties.
def	addParameters
	Add parameters to the anim and setup properties to control the component.
def	addLayout
	Define the layout of the anim and setup properties.
def	addLogic
	Define the logic of the anim and setup properties.
def	setUI
def	addAnimParam
	Add a parameter to the animation property.
def	addSetupParam
	Add a parameter to the setup property.
def	addSetupFCurveParam
	Add a parameter to the setup property.
def	addOperators
	Apply operators, constraint, expressions to the hierarchy.
def	addConnection
	Add more connection definition to the set.
def	setRelation
	Set the relation beetween object from guide to rig.
def	getRelation
	Return the relational object from guide to rig.
def	initConnector
def	connect
	Connect the component to the rest of the rig using the defined connection.
def	connect_standard
	standard connection definition.
def	connect_standardWithIkRef
	standard connection definition with ik and upv references.
def	postConnect
	Post connection actions.
def	finalize
def	getName
	Return the name for component element.
def	getFullName
	return the fullname of the component
def	getType
	return the type of the component
Data Fields
	rig
	guide
	options
	model
	settings
	name
	side
	index
	size
	color_fk
	color_ik
	negate
	n_sign
	n_factor
	groups
	controlers
	inv_params
	anim_layout
	anim_logic
	setup_layout
	setup_logic
	ui
	connections
	relatives
	stepMethods
	root
	shd_org
	uihost
	anim_prop
	setup_prop
	parent
	parent_comp
Static Public Attributes
list	steps = ["Objects", "Properties", "Operators", "Connect", "Finalize"]
tuple	local_params = ("posx", "posy", "posz", "rotx", "roty", "rotz", "rotorder", "sclx", "scly", "sclz")
tuple	t_params = ("posx", "posy", "posz")
tuple	r_params = ("rotx", "roty", "rotz", "rotorder")
tuple	s_params = ("sclx", "scly", "sclz")
tuple	tr_params = ("posx", "posy", "posz", "rotx", "roty", "rotz", "rotorder")
tuple	rs_params = ("rotx", "roty", "rotz", "rotorder", "sclx", "scly", "sclz")
tuple	x_axis = XSIMath.CreateVector3(1,0,0)
tuple	y_axis = XSIMath.CreateVector3(0,1,0)
tuple	z_axis = XSIMath.CreateVector3(0,0,1)
Properties
	fullName = property(getFullName)
	type = property(getType)

Member Function Documentation

def gear::xsi::rig::component::MainComponent::__init__	(	self,
		rig,
		guide
	)

Init Method.

Parameters:

	self
	rig	Rig - The parent Rig of this component.
	guide	ComponentGuide - The guide for this component.

def gear::xsi::rig::component::MainComponent::step_00 ( self )

Step 00.

Initial Hierarchy, create objects and set the connection relation.

Parameters:

self

def gear::xsi::rig::component::MainComponent::step_01 ( self )

Step 01.

Get the properties host, create parameters and set layout and logic.

Parameters:

self

def gear::xsi::rig::component::MainComponent::step_02 ( self )

Step 02.

Apply all the operators.

Parameters:

self

def gear::xsi::rig::component::MainComponent::step_03 ( self )

Step 03.

Connect the component to the rest of the rig.

Parameters:

self

def gear::xsi::rig::component::MainComponent::step_04 ( self )

Step 04.

Finalize the component.

Parameters:

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

Parameters:

self

Reimplemented in gear::xsi::rig::component::chain_cns_01::Component, gear::xsi::rig::component::control_01::Component, and gear::xsi::rig::component::neck_ik_01::Component.

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.

Parameters:

self

def gear::xsi::rig::component::MainComponent::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::component::MainComponent::getHost ( self )

Get the host for the properties.

Parameters:

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.

Parameters:

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.

Parameters:

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.

Parameters:

self

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.

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:: Parameter - The newly created parameter.

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.

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:: Parameter - The newly created parameter.

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.

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:: Parameter - The newly created parameter.

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.

Parameters:

self

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

Parameters:

self

Reimplemented in gear::xsi::rig::component::chain_cns_01::Component, and gear::xsi::rig::component::foot_bk_01::Component.

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.

Parameters:

self

def gear::xsi::rig::component::MainComponent::getRelation	(	self,
		name
	)

Return the relational object from guide to rig.

Parameters:

	self
	local	name of the guide object.

def gear::xsi::rig::component::MainComponent::connect ( self )

Connect the component to the rest of the rig using the defined connection.

Parameters:

def gear::xsi::rig::component::MainComponent::connect_standard ( self )

standard connection definition.

This is a simple parenting of the root.

Parameters:

self

Reimplemented in gear::xsi::rig::component::arm_2jnt_01::Component, gear::xsi::rig::component::leg_2jnt_01::Component, gear::xsi::rig::component::leg_3jnt_01::Component, gear::xsi::rig::component::neck_ik_01::Component, and gear::xsi::rig::component::wing_01::Component.

def gear::xsi::rig::component::MainComponent::connect_standardWithIkRef ( self )

standard connection definition with ik and upv references.

Parameters:

self

Reimplemented in gear::xsi::rig::component::neck_ik_01::Component.

def gear::xsi::rig::component::MainComponent::postConnect ( self )

Post connection actions.

REIMPLEMENT. This method should be reimplemented in each component.

Parameters:

self

Reimplemented in gear::xsi::rig::component::control_01::Component.

def gear::xsi::rig::component::MainComponent::getName	(	self,
		name = `""`,
		side = `None`
	)

Return the name for component element.

Parameters:

	self
	name	String - Name.

def gear::xsi::rig::component::MainComponent::getFullName ( self )

return the fullname of the component

Parameters:

self

def gear::xsi::rig::component::MainComponent::getType ( self )

return the type of the component

Parameters:

self

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

modules/gear/xsi/rig/component/__init__.py

gear::xsi::rig::component::MainComponent Class Reference

Public Member Functions

Data Fields

Static Public Attributes

Properties

Member Function Documentation