gear::xsi::rig::component::guide::ComponentGuide Class Reference

Main class for component guide creation. More...

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

Inherited by 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::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, and gear::xsi::rig::component::wing_01::guide::Guide.

Public Member Functions
def	__init__
	Init method.
def	postInit
	Define the objects name and categories.
def	initialHierarchy
	Initial hierachy.
def	addObjects
	Create the objects of the guide.
def	addParameters
	Create the parameter definitions of the guide.
def	addLayout
	Define the layout attached to the parameters.
def	addLogic
	Define the logic attached to the ppg.
def	setFromHierarchy
def	setFromXml
def	getAsXml
	Return the guide as an xml definition.
def	draw
	Draw the guide in the scene.
def	drawFromUI
	Launch a pick session to get the position of the guide, then draw the guide in the scene.
def	drawFromXml
def	pickPositions
	Launch a pick session to get the position of the guide.
def	drawRef
	Create a temporary null to display the picked position.
def	setIndex
	Update the component index to get the next valid one.
def	symmetrize
	Inverse the transform of each element of the guide.
def	rename
	Rename the component.
def	addRoot
	Add a root object to the guide.
def	addLoc
	Add a loc object to the guide.
def	addLocMulti
	Add multiple loc objects to the guide.
def	addBlade
	Add a blade object to the guide.
def	addDispCurve
	Add a display curve object to the guide.
def	getObjects
def	addMinMax
def	getSize
def	getName
	Return the fullname of given element of the component.
def	getFullName
	Return the fullname of the component.
def	getType
	Return the type of the component.
def	getObjectNames
Data Fields
	paramNames
	paramDefs
	values
	layout
	logic
	valid
	root
	id
	parentComponent
	parentLocalName
	tra
	atra
	pos
	apos
	prim
	blades
	size
	root_size
	pick_transform
	save_transform
	save_primitive
	save_blade
	minmax
	pCompType
	pCompName
	pCompSide
	pCompIndex
	pConnector
	pUIHost
	pSetGrp
	pCtlGrp
	model
	settings
	parent
Static Public Attributes
string	compType = "component"
string	compName = "component"
string	compSide = "C"
int	compIndex = 0
string	description = ""
list	connectors = []
list	compatible = []
string	ctl_grp = ""
Properties
	fullName = property(getFullName)
	type = property(getType)
	objectNames = property(getObjectNames)

---

Detailed Description

Main class for component guide creation.

This class handles all the parameters and objectDefs creation.
It also now how to parse its own hierachy of object to retrieve position and transform.
Finally it also now how to export itself as xml_node.

---

Member Function Documentation

def gear::xsi::rig::component::guide::ComponentGuide::__init__

(

self

)

Init method.

Parameters:

	self
	ref	an xml definition or a SI3DObject

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

def gear::xsi::rig::component::guide::ComponentGuide::postInit

(

self

)

Define the objects name and categories.

REIMPLEMENT. This method should be reimplemented in each component.

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::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, and gear::xsi::rig::component::wing_01::guide::Guide.

def gear::xsi::rig::component::guide::ComponentGuide::initialHierarchy

(

self

)

Initial hierachy.

It's no more than the basic set of parameters and layout needed for the setting property.

Parameters:

self

def gear::xsi::rig::component::guide::ComponentGuide::addObjects

(

self

)

Create the objects of the guide.

REIMPLEMENT. This method should be reimplemented in each component.

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::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, and gear::xsi::rig::component::wing_01::guide::Guide.

def gear::xsi::rig::component::guide::ComponentGuide::addParameters

(

self

)

Create the parameter definitions of the guide.

REIMPLEMENT. This method should be reimplemented in each component.

Parameters:

self

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

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::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, and gear::xsi::rig::component::wing_01::guide::Guide.

def gear::xsi::rig::component::guide::ComponentGuide::addLayout

(

self

)

Define the layout attached to the parameters.

REIMPLEMENT. This method should be reimplemented in each component.

Parameters:

self

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

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::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, and gear::xsi::rig::component::wing_01::guide::Guide.

def gear::xsi::rig::component::guide::ComponentGuide::addLogic

(

self

)

Define the logic attached to the ppg.

REIMPLEMENT. This method should be reimplemented in each component.

Parameters:

self

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

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::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, and gear::xsi::rig::component::wing_01::guide::Guide.

def gear::xsi::rig::component::guide::ComponentGuide::getAsXml

(

self

)

Return the guide as an xml definition.

param self

def gear::xsi::rig::component::guide::ComponentGuide::draw	(		self,
			parent
	)

Draw the guide in the scene.

param self param parent X3DObject - Parent object.

def gear::xsi::rig::component::guide::ComponentGuide::drawFromUI	(		self,
			parent
	)

Launch a pick session to get the position of the guide, then draw the guide in the scene.

param self param parent X3DObject - Parent object.

def gear::xsi::rig::component::guide::ComponentGuide::pickPositions

(

self

)

Launch a pick session to get the position of the guide.

param self return Boolean - False if pick session was aborded at anytime.

def gear::xsi::rig::component::guide::ComponentGuide::drawRef	(		self,
			t
	)

Create a temporary null to display the picked position.

param self param t SITransformation - The transformation of the reference object. return Null - The newly created reference null.

def gear::xsi::rig::component::guide::ComponentGuide::setIndex	(		self,
			model
	)

Update the component index to get the next valid one.

Parameters:

	self
	parent	X3DObject - The parent object of the guide.

def gear::xsi::rig::component::guide::ComponentGuide::symmetrize

(

self

)

Inverse the transform of each element of the guide.

Parameters:

self

def gear::xsi::rig::component::guide::ComponentGuide::rename	(		self,
			prop
	)

Rename the component.

Rename use the value of the setting property.

Parameters:

@param

prop Property - The setting property of the component to remame.

def gear::xsi::rig::component::guide::ComponentGuide::addRoot

(

self

)

Add a root object to the guide.

This mehod can initialize the object or draw it.
Root object is a simple null with a specific display and a setting property.

Parameters:

self

return X3DObject - The created root null.

def gear::xsi::rig::component::guide::ComponentGuide::addLoc	(		self,
			name,
			parent,
			position = None
	)

Add a loc object to the guide.

This mehod can initialize the object or draw it.
Loc object is a simple null to define a position or a tranformation in the guide.

Parameters:

	self
	name	String - Local name of the element.
	parent	X3DObject - The parent of the element.
	position	SIVector3 - The default position of the element. Pick sesssion is launch if none. return X3DObject - The created loc null.

def gear::xsi::rig::component::guide::ComponentGuide::addLocMulti	(		self,
			name,
			parent
	)

Add multiple loc objects to the guide.

This mehod can initialize the object or draw it.
Loc object is a simple null to define a position or a tranformation in the guide.

Parameters:

	self
	name	String - Local name of the element.
	parent	X3DObject - The parent of the element.
	minimum	Int - The minimum number of loc.
	maximum	Int - The maximum number of loc. return List of X3DObject - The created loc nulls in a list.

def gear::xsi::rig::component::guide::ComponentGuide::addBlade	(		self,
			name,
			parentPos,
			parentDir
	)

Add a blade object to the guide.

This mehod can initialize the object or draw it.
Blade object is a 3points curve to define a plan in the guide.

Parameters:

	self
	name	String - Local name of the element.
	parentPos	X3DObject - The parent of the element.
	parentDir	X3DObject - The direction constraint of the element. return X3DObject - The created blade curve.

def gear::xsi::rig::component::guide::ComponentGuide::addDispCurve	(		self,
			name,
			centers = [],
			degree = 1
	)

Add a display curve object to the guide.

This mehod can initialize the object or draw it.
Display curve object is a simple curve to show the connection between different guide element.

Parameters:

	self
	name	String - Local name of the element.
	centers	List of X3DObject - List of parent of the curve, return X3DObject - The created display curve.

def gear::xsi::rig::component::guide::ComponentGuide::getObjects	(		self,
			model
	)

Parameters:

self

model

Returns:

Dictionary of X3DObject

def gear::xsi::rig::component::guide::ComponentGuide::addMinMax	(		self,
			name,
			minimum = 1,
			maximum = -1
	)

Parameters:

self

def gear::xsi::rig::component::guide::ComponentGuide::getSize

(

self

)

Parameters:

self

Returns:

Double

def gear::xsi::rig::component::guide::ComponentGuide::getName	(		self,
			name
	)

Return the fullname of given element of the component.

Parameters:

	self
	name	String - Localname of the element.

def gear::xsi::rig::component::guide::ComponentGuide::getFullName

(

self

)

Return the fullname of the component.

Parameters:

self

def gear::xsi::rig::component::guide::ComponentGuide::getType

(

self

)

Return the type of the component.

Parameters:

self

def gear::xsi::rig::component::guide::ComponentGuide::getObjectNames

(

self

)

Parameters:

self

---

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

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