Cortex
10.0.0-a4
|
A ParameterUI for ClassVectorParameters. More...
Public Member Functions | |
def | __init__ (self, node, parameter, kw) |
def | replace (self, node, parameter) |
def | getCollapsed (self) |
Gets the collapsed state for the frame holding the child parameter uis. More... | |
def | setCollapsed (self, collapsed, propagateToChildren=0, kw) |
Sets the collapsed state for the frame holding the child parameter uis. More... | |
def | registerClassMenuCallback (cls, callback) |
Registers a callback which is able to modify the popup menu used to edit an individual class entry within the vector of classes. More... | |
def | registerAddClassMenuCallback (cls, callback) |
Registers a callback which is able to modify the popup menu used to add class entries into the vector of classes. More... | |
def | registerToolsMenuCallback (cls, callback) |
Registers a callback which is able to modify the tools popup menu Callbacks should have the following signature : More... | |
![]() | |
def | __init__ (self, parameterisedHolderNode, parameter, topLevelUI, kw) |
The parameterisedHolderNode is an MObject specifying the node holding the specified IECore.Parameter. More... | |
def | replace (self, node, parameter) |
Derived classes should override this method. More... | |
def | node (self) |
Returns the Maya node associated with this UI in the form of an OpenMaya.MObject. | |
def | nodeName (self) |
Returns an umambiguous full path for the Maya node associated with this UI. More... | |
def | plug (self) |
Returns the Maya plug associated with this UI in the form an OpenMaya.MPlug. | |
def | plugName (self) |
Returns an unambiguous full path to the plug this ui represents. More... | |
def | layout (self) |
def | label (self) |
Computes a nice label for the ui. More... | |
def | description (self) |
Computes a wrapped annotation/tooltip for the ui. | |
def | addDragCallback (self, ctrl, kw) |
def | registerPopupMenuCallback (cls, callback) |
Registers a callback which is able to modify the popup menus associated with ParameterUIs. More... | |
![]() | |
def | __init__ (self, topLevelUI) |
Derived classes must create a ui element which is the parent of the rest of their ui, and call this init function passing it as the topLevelUI parameter. More... | |
def | parent (self) |
Returns the UIElement which forms the parent for this one. More... | |
Additional Inherited Members | |
![]() | |
def | registerUI |
def | create (parameterisedHolderNode, parameter, kw) |
Returns a new ParameterUI instance suitable for representing the specified parameter on the specified parameterisedHolderNode. More... | |
![]() | |
def | instances |
Returns a list of all the active instances derived from the specified type. More... | |
![]() | |
parameter | |
![]() | |
int | textColumnWidthIndex = 145 |
int | singleWidgetWidthIndex = 70 |
int | sliderWidgetWidthIndex = 2 |
dictionary | handlers = {} |
A ParameterUI for ClassVectorParameters.
Supports the following Parameter userData entries :
BoolData ["UI"]["collapsible"] Specifies if the UI may be collapsed or not - defaults to True.
The icon used for a child UI can be overridden by setting the icon name, minus extension in either the child classes blindData, or its top level compound parameters userData() as follows:
StringData <class.blindData()|class.parameters().userData()>["UI"]["icon"]
If a parameter of a class has one of the following userData elements set to True, a minimal version of the control for that parameter will be placed in the header row for the class entry, either before, or after the icon/name.
BoolData ["UI"]["classVectorParameterPreHeader"] BoolData ["UI"]["classVectorParameterHeader"]
See if there is a better way to deal with problematic UI elements (eg: spline) that crash when a redraw is called and constituent plugs no longer exist. This can happen when removing classes, or changing parameter types, as an AE redraw may happen before the related UI has been deleted. It seems for some parameter types, maya doesn't check to see if all the required plugs are there during a redraw, and consequently falls over. This behavior is currently compensated for by pre-updating the UI before removing a class or changing its version.
def IECoreMaya.ClassVectorParameterUI.getCollapsed | ( | self | ) |
Gets the collapsed state for the frame holding the child parameter uis.
Referenced by IECoreMaya.FnDagNode.defaultShapeName(), IECoreMaya._CollapsibleMotif.frameLayout(), and IECoreMaya.ClassVectorParameterUI.registerToolsMenuCallback().
def IECoreMaya.ClassVectorParameterUI.registerAddClassMenuCallback | ( | cls, | |
callback | |||
) |
Registers a callback which is able to modify the popup menu used to add class entries into the vector of classes.
Callbacks should have the following signature :
callback( menuDefinition, classVectorParameter, holderNode )
def IECoreMaya.ClassVectorParameterUI.registerClassMenuCallback | ( | cls, | |
callback | |||
) |
Registers a callback which is able to modify the popup menu used to edit an individual class entry within the vector of classes.
Callbacks should have the following signature :
callback( menuDefinition, classVectorParameter, childParameter, holderNode )
Referenced by IECoreMaya.PresetsUI.selectParameters().
def IECoreMaya.ClassVectorParameterUI.registerToolsMenuCallback | ( | cls, | |
callback | |||
) |
Registers a callback which is able to modify the tools popup menu Callbacks should have the following signature :
callback( menuDefinition, classVectorParameter, holderNode )
References IECoreMaya.GenericParameterUI.__attributeChanged(), IECoreMaya.ChildUI.__attributeChanged(), IECoreMaya.PresetsOnlyParameterUI.__attributeChanged(), IECoreMaya.NumericVectorParameterUI.__attributeChanged(), IECoreMaya.StringVectorParameterUI.__attributeChanged(), IECoreMaya.GenericParameterUI.__attributeChangedCallbackId, IECoreMaya.ChildUI.__attributeChangedCallbackId, IECoreMaya.PresetsOnlyParameterUI.__attributeChangedCallbackId, IECoreMaya.NumericVectorParameterUI.__attributeChangedCallbackId, IECoreMaya.StringVectorParameterUI.__attributeChangedCallbackId, IECoreMaya.ChildUI.__buildOptionalHeaderUI(), IECoreMaya.ChildUI.__buildOptionalPreHeaderUI(), IECoreMaya.ChildUI.__changeLabel(), IECoreMaya.ChildUI.__class(), IECoreMaya.ChildUI.__classIconName(), IECoreMaya.ChildUI.__compoundParameterUI, IECoreMaya.ChildUI.__drawHeaderParameterControl(), IECoreMaya.ChildUI.__drawHeaderParameterControls(), IECoreMaya.UIElement.__init__(), IECoreMaya.CompoundParameterUI.__kw, IECoreMaya.ClassVectorParameterUI.__kw, IECoreMaya.StringParameterUI.__label, IECoreMaya.PathParameterUI.__label, IECoreMaya.NoteParameterUI.__label, IECoreMaya.ChildUI.__label, IECoreMaya.ChildUI.__labelPlugPath(), IECoreMaya.ChildUI.__layerMenu(), IECoreMaya.ChildUI.__moveLayer(), IECoreMaya.ChildUI.__parameter, IECoreMaya.ParameterSelector.Parameter.__parameter, IECoreMaya.ParameterSelector.ParameterGroup.__parameter, IECoreMaya.CompoundParameterUI.__parameterIsCollapsible(), IECoreMaya.ClassVectorParameterUI.__parameterIsCollapsible(), IECoreMaya.ChildUI.__parameterVisibilityIcon, IECoreMaya.ChildUI.__presetParameters, IECoreMaya.ChildUI.__presetsMenu(), IECoreMaya.ChildUI.__presetUIs, IECoreMaya.ChildUI.__setPreset(), IECoreMaya.ChildUI.__toggleParameterVisibility(), IECoreMaya.ChildUI.__updatePresetLabel(), IECoreMaya.ChildUI.__vectorParent(), IECoreMaya.ChildUI.__versionMenuDefinition(), IECoreMaya.UIElement._createCallback(), IECoreMaya.UIElement._topLevelUI(), IECoreMaya.FnParameterisedHolder.addSetClassVectorParameterClassesCallback(), IECore.curry(), IECore.ClassLoader.defaultLoader(), IECoreMaya.CompoundParameterUI.getCollapsed(), IECoreMaya.ClassVectorParameterUI.getCollapsed(), IECoreMaya.ParameterUI.node(), IECoreMaya.UIElement.parent(), IECore::Group.parent(), IECoreMaya.CompoundParameterUI.setCollapsed(), IECoreMaya.ClassParameterUI.setCollapsed(), IECoreMaya.ClassVectorParameterUI.setCollapsed(), and IECore::RunTimeTyped.staticTypeId().
Referenced by IECoreMaya.PresetsUI.selectParameters().
def IECoreMaya.ClassVectorParameterUI.setCollapsed | ( | self, | |
collapsed, | |||
propagateToChildren = 0 , |
|||
kw | |||
) |
Sets the collapsed state for the frame holding the child parameter uis.
In the case that this ui itself is not collapsible, it will still propagate
propagateToChildren | How many levels of hierarchy to propagate the new state to. If a Bool is passed, rather than an int, then 'all' or 'none' is assumed, for backwards compatibility |
References IECoreMaya.ClassVectorParameterUI.__addClassMenuCallbacks, IECoreMaya.ClassVectorParameterUI.__buttonRow, IECoreMaya.CompoundParameterUI.__childUIs, IECoreMaya.ClassVectorParameterUI.__childUIs, IECoreMaya.ClassVectorParameterUI.__formLayout, IECoreMaya.CompoundParameterUI.__kw, IECoreMaya.ClassVectorParameterUI.__kw, IECoreMaya.CompoundParameterUI.__parameterIsCollapsible(), IECoreMaya.ClassVectorParameterUI.__parameterIsCollapsible(), IECoreMaya.CompoundParameterUI.__propagateCollapsed(), IECoreMaya.ClassVectorParameterUI.__propagateCollapsed(), IECoreMaya.ClassVectorParameterUI.__toolsMenuCallbacks, IECoreMaya.ClassVectorParameterUI.__updateChildUIs(), IECoreMaya.ClassVectorParameterUI._setClass(), IECoreMaya.CompoundParameterUI._storeCollapsedState(), IECoreMaya.ClassVectorParameterUI._storeCollapsedState(), IECore.curry(), IECore.ClassLoader.defaultLoader(), IECoreMaya.UIElement.instances(), IECore::BoundedKDTree< BoundIterator >.node(), IECore::KDTree< PointIterator >.node(), IECoreMaya.ParameterUI.node(), and IECoreMaya.ParameterUI.parameter.
Referenced by IECoreMaya.FnDagNode.defaultShapeName(), IECoreMaya._CollapsibleMotif.frameLayout(), and IECoreMaya.ClassVectorParameterUI.registerToolsMenuCallback().