gear.xsi.ppg.LayoutCompound Class Reference

Base class for all LayoutComponent that can contains some others (like Tab, Group and Row) More...

Inheritance diagram for gear.xsi.ppg.LayoutCompound:

Public Member Functions
def	__init__
	Init method. More...
def	getItems
	Get the list of items of this LayoutCompound. More...
def	appendItems
	Append items to the item list of this LayoutCompound. More...
def	popItem
	Remove a LayoutItem from the item list of this LayoutCompound. More...
def	addGroup
	Add a Group to this LayoutCompound. More...
def	addRow
	Add a Row to this LayoutCompound. More...
def	addItem
	Add an Item to this LayoutCompound. More...
def	addEnumControl
	Add an EnumControl to this LayoutCompound. More...
def	addFCurve
	Add a FCurve to this LayoutCompound. More...
def	addFCurve2
	Add a FCurve to this LayoutCompound. More...
def	addButton
	Add a Button to this LayoutCompound. More...
def	addColor
	Add a Color to this LayoutCompound. More...
def	addSpacer
	Add a Spacer to this LayoutCompound. More...
def	addString
	Add a String to this LayoutCompound. More...
def	getValue
	Return the layout code as a string. More...
Public Member Functions inherited from gear.xsi.ppg.LayoutComponent
def	__init__
	Init method. More...
def	setCodeBefore
	Add custom code before the item. More...
def	setCodeAfter
	Add custom code after the item. More...
def	addCondition
	Simple condition to place before the item. More...
def	convertToAscii
	Make sure that all string in the list are in ascii and not unicode. More...
def	getAsString
	Add quotemark to string and return the list as a string. More...

Public Attributes
	items
	List of all the items included in this LayoutCompound. More...
	prefixMethod
	suffixMethod
	args
Public Attributes inherited from gear.xsi.ppg.LayoutComponent
	codeBefore
	codeAfter
	code to place before the item
	condition
	code to place after the item
	args
	simple condition to place before the item

Detailed Description

Base class for all LayoutComponent that can contains some others (like Tab, Group and Row)

Constructor & Destructor Documentation

def gear.xsi.ppg.LayoutCompound.__init__

(

self

)

Init method.

Parameters

self

Member Function Documentation

def gear.xsi.ppg.LayoutCompound.addButton	(		self,
			scriptName,
			name = None
	)

Add a Button to this LayoutCompound.

Parameters

self
scriptName	String - The parameter scriptname.
name	String - The display name of the button.

Returns

Item - the newly created Button item.

def gear.xsi.ppg.LayoutCompound.addColor	(		self,
			redParamName,
			name = None,
			alpha = False
	)

Add a Color to this LayoutCompound.

Parameters

self
redParamName	String - The red parameter scriptname.
name	String - The display name of the color.
alpha	Boolean - True to display a Alpha Channel.

Returns

Item - the newly created Color item.

def gear.xsi.ppg.LayoutCompound.addEnumControl	(		self,
			scriptName,
			items,
			name = None,
			siPPGControlType = c.siControlCombo
	)

Add an EnumControl to this LayoutCompound.

Parameters

self
scriptName	String - the parameter scriptname.
items	List - The item list of the enumcontrol.
name	String - the parameter display name.
siPPGControlType	String - The control type of this EnumControl.

Returns

Item - the newly created EnumControl item.

def gear.xsi.ppg.LayoutCompound.addFCurve	(		self,
			scriptName,
			height = 300
	)

Add a FCurve to this LayoutCompound.

Parameters

self
scriptName	String - The parameter scriptname.
height	Integer - The height to display the fcurve.

Returns

Item - the newly created FCurve item.

def gear.xsi.ppg.LayoutCompound.addFCurve2	(		self,
			scriptName,
			labelX,
			labelY,
			minX,
			maxX,
			minY,
			maxY,
			gridSpaceX,
			gridSpaceY
	)

Add a FCurve to this LayoutCompound.

With more option to avoid the use of setAttribute method.

Parameters

self
scriptName	String - The parameter scriptname.
labelX	String - The label at the bottom of the fcurve item.
labelY	String - The label at the left of the fcurve item.
minX	Double - The minimum X value to display the fcurve.
maxX	Double - The maximum X value to display the fcurve.
minY	Double - The minimum Y value to display the fcurve.
maxY	Double - The maximum Y value to display the fcurve.
gridSpaceX	Double - The gridSpace in X value to display the fcurve.
gridSpaceY	Double - The gridSpace in Y value to display the fcurve.

Returns

Item - the newly created FCurve item.

def gear.xsi.ppg.LayoutCompound.addGroup	(		self,
			name
	)

Add a Group to this LayoutCompound.

Parameters

self
name	String - Group Name.

Returns

Group - The newly created Group.

def gear.xsi.ppg.LayoutCompound.addItem	(		self,
			scriptName,
			name = None,
			uitype = None
	)

Add an Item to this LayoutCompound.

Parameters

self
scriptName	String - the parameter scriptname.
name	String - the parameter display name.

Returns

Item - the newly created Item.

def gear.xsi.ppg.LayoutCompound.addRow

(

self

)

Add a Row to this LayoutCompound.

Parameters

self

Returns

Row - The newly created Row.

def gear.xsi.ppg.LayoutCompound.addSpacer

(

self

)

Add a Spacer to this LayoutCompound.

Parameters

self

Returns

Item - the newly created Spacer item.

def gear.xsi.ppg.LayoutCompound.addString	(		self,
			scriptName,
			name = None,
			multiline = False,
			height = 120
	)

Add a String to this LayoutCompound.

Parameters

self
scriptName	String - The parameter scriptname.
name	String - The parameter display name.
multiline	Boolean - True to display multiline.
height	Integer - height of the widget.

Returns

Item - the newly created String item.

def gear.xsi.ppg.LayoutCompound.appendItems	(		self,
			items
	)

Append items to the item list of this LayoutCompound.

Parameters

self
items	List of LayoutComponent.

def gear.xsi.ppg.LayoutCompound.getItems

(

self

)

Get the list of items of this LayoutCompound.

Parameters

self

Returns

List of Layout Component.

def gear.xsi.ppg.LayoutCompound.getValue

(

self

)

Return the layout code as a string.

Code is in Python.

Parameters

self

Returns

String - The layout.

def gear.xsi.ppg.LayoutCompound.popItem	(		self,
			itemToPop
	)

Remove a LayoutItem from the item list of this LayoutCompound.

Parameters

self
itemToPop	LayoutItem to remove.

Member Data Documentation

gear.xsi.ppg.LayoutCompound.items

List of all the items included in this LayoutCompound.

---

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

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