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

This class provides a UI for loading and saving presets for nodes derived from the ParameterisedHolder class. More...

Public Member Functions

def __init__
 
def save (self)
 Call to save a preset. More...
 
def copy (self, callback)
 Call to copy a preset. More...
 
def load (self)
 Call to load a preset. More...
 
def selectParameters (self, callback)
 Call to select parameters within the current rootParameter. More...
 

Detailed Description

This class provides a UI for loading and saving presets for nodes derived from the ParameterisedHolder class.

Currently, it creates BasicPresets in one of the locations set in the relevant search paths for the Parameterised objects. Categories, and titles aren't yet implemented.

Todo:
Currently, the LoadUI, has to instantiate every preset in the search path, and call 'applicableTo'. This is potentially a huge bottle neck, so, well see what happens when we use it in earnest...

Member Function Documentation

def IECoreMaya.PresetsUI.copy (   self,
  callback 
)

Call to copy a preset.

Parameters
callback,f(preset ), A callable, that will be called with the Preset instance after the user has selected a number of prameters

References IECoreMaya.ParameterUI.__node, IECoreMaya.PresetsUI.__node, and IECoreMaya.PresetsUI.__rootParameter.

def IECoreMaya.PresetsUI.load (   self)

Call to load a preset.

References IECoreMaya.ParameterUI.__node, IECoreMaya.PresetsUI.__node, and IECoreMaya.PresetsUI.__rootParameter.

def IECoreMaya.PresetsUI.save (   self)

Call to save a preset.

References IECoreMaya.ParameterUI.__node, IECoreMaya.PresetsUI.__node, and IECoreMaya.PresetsUI.__rootParameter.

def IECoreMaya.PresetsUI.selectParameters (   self,
  callback 
)

Call to select parameters within the current rootParameter.

Parameters
callback,f(node, rootParameter, parameters ), A Callable, that will be called with the node, and chosed parameters after the user has made their selection. This can be usefull for a variety of cases where it's needed for the user to select parameters within a hierarchy.

References IECoreMaya.ParameterSelector.ParameterGroup.__autoCollapseDepth, IECoreMaya.SplineParameterUI.__button, IECoreMaya.SelectUI.__button, IECoreMaya.FileDialog.__callback, IECoreMaya.SelectUI.__callback, IECoreMaya.CopyUI.__callback, IECoreMaya.ParameterSelector.Parameter.__checkbox, IECoreMaya.ParameterSelector.ParameterGroup.__checkbox, IECoreMaya.ParameterSelector.ParameterGroup.__children, IECoreMaya.LoadUI.__classLoader, IECoreMaya.ParameterSelector.ParameterGroup.__column, IECoreMaya.NumericVectorParameterUI.__column, IECoreMaya.StringVectorParameterUI.__column, IECoreMaya.ParameterSelector.__controls, IECoreMaya.CopyUI.__copyCallback(), IECoreMaya.ParameterSelector.Parameter.__depth, IECoreMaya.ParameterSelector.ParameterGroup.__depth, IECoreMaya.SaveUI.__description, IECoreMaya.SelectUI.__doAction(), IECoreMaya.LoadUI.__doLoad(), IECoreMaya.SaveUI.__doSave(), IECoreMaya.SaveUI.__envVar, IECoreMaya.LoadUI.__envVar, IECoreMaya.LoadUI.__fnP, IECoreMaya.LoadUI.__form, IECoreMaya.ParameterSelector.ParameterGroup.__frame, IECoreMaya.LoadUI.__getPresets(), IECoreMaya.LoadUI.__infoColumn, IECoreMaya.FileBrowser.__layout, IECoreMaya._PathField.__layout, IECoreMaya._FileList.__layout, IECoreMaya._DefaultFileListSort.__layout, IECoreMaya.PresetInfo.__layout, IECoreMaya._FileList.__list, IECoreMaya.PresetSelector.__list, IECoreMaya.LoadUI.__loadButton, IECoreMaya.LoadUI.__loadedPresets, IECoreMaya.LoadUI.__loadedPrestes, IECoreMaya.SaveUI.__location, IECoreMaya.ParameterSelector.__mainColumn, IECoreMaya.SearchPathMenu.__menu, IECoreMaya.UITemplate.__name, IECoreMaya.SaveUI.__name, IECoreMaya.ParameterUI.__node, IECoreMaya.PresetsUI.__node, IECoreMaya.ChildUI.__parameter, IECoreMaya.ParameterSelector.Parameter.__parameter, IECoreMaya.ParameterSelector.ParameterGroup.__parameter, IECoreMaya.PresetInfo.__parameterHolders, IECoreMaya.LoadUI.__parameterised, IECoreMaya.PresetInfo.__parent, IECoreMaya.PresetsUI.__rootParameter, IECoreMaya.ParameterSelector.ParameterGroup.__row, IECoreMaya.SaveUI.__saveButton, IECoreMaya.FileBrowser.__selectionChanged(), IECoreMaya.LoadUI.__selectionChanged(), IECoreMaya.LoadUI.__selector, IECoreMaya.FileDialog.__window, IECoreMaya.LoadUI.__window, IECoreMaya.UIElement._createCallback(), IECoreMaya.ParamSelectUI._fnP, IECoreMaya.ParamSelectUI._form, IECoreMaya.ParamSelectUI._rootParameter, IECoreMaya.ParamSelectUI._scroll, IECoreMaya.ParamSelectUI._selector, IECoreMaya.ParamSelectUI._window, IECore.curry(), IECoreNuke::ClassParameterHandler.getState(), IECoreNuke::ClassVectorParameterHandler.getState(), IECoreNuke::CompoundParameterHandler.getState(), IECoreGL::Group.getState(), IECoreNuke::ParameterHandler.getState(), IECoreMaya.ParameterSelector.Parameter.getState(), IECoreMaya.ParameterSelector.ParameterGroup.getState(), IECoreMaya.ClassVectorParameterUI.registerClassMenuCallback(), IECoreMaya.ParameterUI.registerPopupMenuCallback(), IECoreMaya.ClassVectorParameterUI.registerToolsMenuCallback(), and IECoreMaya.ParameterSelector.ParameterGroup.syncState().


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