gear::xsi::ppg::LayoutCompound Class Reference

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

Inherits gear::xsi::ppg::LayoutComponent.

Inherited by gear::xsi::ppg::Group, gear::xsi::ppg::Row, and gear::xsi::ppg::Tab.

Public Member Functions
def	__init__
	Init method.
def	getItems
	Get the list of items of this LayoutCompound.
def	appendItems
	Append items to the item list of this LayoutCompound.
def	popItem
	Remove a LayoutItem from the item list of this LayoutCompound.
def	addGroup
	Add a Group to this LayoutCompound.
def	addRow
	Add a Row to this LayoutCompound.
def	addItem
	Add an Item to this LayoutCompound.
def	addEnumControl
	Add an EnumControl to this LayoutCompound.
def	addFCurve
	Add a FCurve to this LayoutCompound.
def	addFCurve2
	Add a FCurve to this LayoutCompound.
def	addButton
	Add a Button to this LayoutCompound.
def	addColor
	Add a Color to this LayoutCompound.
def	addSpacer
	Add a Spacer to this LayoutCompound.
def	addString
	Add a String to this LayoutCompound.
def	getValue
	Return the layout code as a string.
Data Fields
	items
	List of all the items included in this LayoutCompound.
	prefixMethod
	suffixMethod
	args

---

Detailed Description

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

---

Member Function Documentation

def gear::xsi::ppg::LayoutCompound::__init__

(

self

)

Init method.

Parameters:

self

Reimplemented from gear::xsi::ppg::LayoutComponent.

Reimplemented in gear::xsi::ppg::Row.

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::appendItems	(		self,
			items
	)

Append items to the item list of this LayoutCompound.

Parameters:

	self
	items	List of LayoutComponent.

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

Remove a LayoutItem from the item list of this LayoutCompound.

Parameters:

	self
	itemToPop	LayoutItem to remove.

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::addRow

(

self

)

Add a Row to this LayoutCompound.

Parameters:

self

Returns:

Row - The newly created Row.

def gear::xsi::ppg::LayoutCompound::addItem	(		self,
			scriptName,
			name = 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::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::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::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::getValue

(

self

)

Return the layout code as a string.

Code is in Python.

Parameters:

self

Returns:

String - The layout.

---

Field 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:

• modules/gear/xsi/ppg.py