Cortex  10.0.0-a4
Public Member Functions | List of all members
IECoreMaya.StringParameterUI Class Reference

A UI for StringParameters. More...

+ Inheritance diagram for IECoreMaya.StringParameterUI:

Public Member Functions

def __init__ (self, node, parameter, kw)
 
def replace (self, node, parameter)
 
- Public Member Functions inherited from IECoreMaya.ParameterUI
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...
 
- Public Member Functions inherited from IECoreMaya.UIElement
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

- Static Public Member Functions inherited from IECoreMaya.ParameterUI
def registerUI
 
def create (parameterisedHolderNode, parameter, kw)
 Returns a new ParameterUI instance suitable for representing the specified parameter on the specified parameterisedHolderNode. More...
 
- Static Public Member Functions inherited from IECoreMaya.UIElement
def instances
 Returns a list of all the active instances derived from the specified type. More...
 
- Public Attributes inherited from IECoreMaya.ParameterUI
 parameter
 
- Static Public Attributes inherited from IECoreMaya.ParameterUI
int textColumnWidthIndex = 145
 
int singleWidgetWidthIndex = 70
 
int sliderWidgetWidthIndex = 2
 
dictionary handlers = {}
 

Detailed Description

A UI for StringParameters.

Supports the following parameter user data :

BoolData ["UI"]["acceptsProceduralObjectName"] False When true, menu items will be created to set the parameter value to the name of an object in a procedural.

BoolData ["UI"]["acceptsProceduralObjectNames"] False When true, menu items will be created to add and remove selected procedural components names.

BoolData ["UI"]["acceptsCoordinateSystemName"] False When true, menu items will be created to set the parameter value to the name of a coordinate system in a procedural.

BoolData ["UI"]["acceptsNodeName"] False When true, menu items will be created to set the value to the name of a node in the scene.

BoolData ["UI"]["acceptsNodeNames"] False When true, menu items will be created to set the value to the names of a number of nodes in the scene.

StringVectorData ["UI"]["acceptedNodeTypes"] [] A list of node types to be considered by the "acceptsNodeName" and "acceptsNodeNames" features.

StringData ["UI"]["acceptedNodeNameFormat"] "partial" Specifies either "partial" or "full", to define whether the shortest unique node name will be used for the features above, or whether the full path will be used. Specify "parent" or "parentPartial" or "parentFull" to get the direct transform parent node path. "parent" behaves the same as "parentPartial".


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