GroupParam

Inherits Param

Synopsis

A group param is a container for other parameters. See detailed description.

Functions

def addParam (param)
def getIsOpened ()
def setAsTab ()
def setOpened (opened)

Detailed Description

A group param does not hold any relevant value. Rather this is a purely graphical element that is used to gather multiple parameters under a group. On the graphical interface a GroupParam looks like this:

When a Param is under a group, the getParent() will return the group as parent.

Member functions description

NatronEngine.GroupParam.addParam(param)

Parameters: param – Param

Adds param into the group.

Warning

Note that this function cannot be called on groups that are not user parameters (i.e: created either by script or by the “Manage user parameters” user interface)

Warning

Once called, you should call refreshUserParamsGUI() to update the user interface.

NatronEngine.GroupParam.getIsOpened()

Return type: bool

Returns whether the group is currently expanded (True) or folded (False).

NatronEngine.GroupParam.setAsTab()

Set this group as a tab. When set as a tab, it will be inserted into a special TabWidget of the Effect. For instance, on the following screenshot, to and from are 2 groups on which setAsTab() has been called.

NatronEngine.GroupParam.setOpened(opened)

Parameters: opened – bool

Set this group to be expanded (opened = True) or folded (opened = False)