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

A function set for operating on the various IECoreMaya::ParameterisedHolder types. More...

+ Inheritance diagram for IECoreMaya.FnParameterisedHolder:

Public Member Functions

def __init__ (self, object)
 Initialise the function set for the given object, which may either be an MObject or a node name in string or unicode form. More...
 
def setParameterised
 Sets the IECore.Parameterised object held by the node. More...
 
def getParameterised (self)
 Returns a tuple of the form (parameterised, className, classVersion, searchPathEnvVar). More...
 
def parameterModificationContext (self)
 Returns a context manager for use with the with statement. More...
 
def setNodeValues
 Sets the values of the plugs representing the parameterised object, using the current values of the parameters. More...
 
def setNodeValue
 Set the value for the plug representing parameter, using the current value of the parameter. More...
 
def setParameterisedValues (self)
 Transfers the values from the plugs of the node onto the parameters of the held Parameterised object. More...
 
def setParameterisedValue (self, parameter)
 Sets the value of parameter from the value held by the plug representing it. More...
 
def parameterPlug (self, parameter)
 Returns the OpenMaya.MPlug object responsible for representing the given parameter. More...
 
def parameterPlugPath (self, parameter)
 Returns a string containing a full pathname for the plug representing the given parameter. More...
 
def plugParameter (self, plug)
 Returns the IECore.Parameter object being represented by the given fullPathName of the maya plug or its OpenMaya.MPlug instance. More...
 
def fullPathName (self)
 Returns the full path name to this node. More...
 
def addSetParameterisedCallback (cls, callback)
 Add a callback which will be invoked whenever FnParameterisedHolder.setParameterised is called. More...
 
def removeSetParameterisedCallback (cls, callback)
 Remove a previously added callback. More...
 
def addSetClassVectorParameterClassesCallback (cls, callback)
 Adds a callback which will be invoked whenever FnParameterisedHolder.setClassVectorParameterClasses is called. More...
 
def removeSetClassVectorParameterClassesCallback (cls, callback)
 Removes a callback added previously with addSetClassVectorParameterClassesCallback()
 
def addSetClassParameterClassCallback (cls, callback)
 Adds a callback which will be invoked whenever FnParameterisedHolder.setClassParameterClass is called. More...
 
def removeSetClassParameterClassCallback (cls, callback)
 Removes a callback added previously with addSetClassParameterClassCallback()
 
def ls
 Lists the ieParameterisedHolderNodes in the current scene. More...
 

Detailed Description

A function set for operating on the various IECoreMaya::ParameterisedHolder types.

This allows setting and getting of plug and parameter values, and setting and getting of the Parameterised object being held.

Constructor & Destructor Documentation

def IECoreMaya.FnParameterisedHolder.__init__ (   self,
  object 
)

Initialise the function set for the given object, which may either be an MObject or a node name in string or unicode form.

Referenced by IECoreMaya.FnParameterisedHolderSet.__init__(), and IECoreMaya.FnParameterisedHolder.ls().

Member Function Documentation

def IECoreMaya.FnParameterisedHolder.addSetClassParameterClassCallback (   cls,
  callback 
)

Adds a callback which will be invoked whenever FnParameterisedHolder.setClassParameterClass is called.

The expected function signature is callback( FnParameterisedHolder, parameter )

Referenced by IECoreMaya.FnDagNode.defaultShapeName().

def IECoreMaya.FnParameterisedHolder.addSetClassVectorParameterClassesCallback (   cls,
  callback 
)

Adds a callback which will be invoked whenever FnParameterisedHolder.setClassVectorParameterClasses is called.

The expected function signature is callback( FnParameterisedHolder, parameter )

Referenced by IECoreMaya.ClassVectorParameterUI.registerToolsMenuCallback().

def IECoreMaya.FnParameterisedHolder.addSetParameterisedCallback (   cls,
  callback 
)

Add a callback which will be invoked whenever FnParameterisedHolder.setParameterised is called.

The expected function signature is callback( FnParameterisedHolder ).

def IECoreMaya.FnParameterisedHolder.fullPathName (   self)

Returns the full path name to this node.

References IECoreGL::HitRecord.name, IECoreGL::NameStateComponent.name(), IECoreHoudini::LiveScene.name(), IECoreMaya::LiveScene.name(), IECore::IFFFile::Tag.name(), IECore::Parameter.name(), IECoreMaya::ObjectData.name(), IECore::SceneCache.name(), IECoreRI::PTCParticleIO::PTCType.name, IECore::LinkedScene.name(), IECore::SceneInterface.name(), IECoreHoudini::FromHoudiniGeometryConverter::RemapInfo.name, IECoreHoudini.ActiveTake.name(), IECoreMaya::FromMayaObjectConverter.object(), and IECore::Writer.object().

Referenced by IECoreMaya.FnSceneShape.canBeCollapsed(), IECoreMaya.FnSceneShape.canBeExpanded(), IECoreMaya.FnSceneShape.collapse(), IECoreMaya.FnProceduralHolder.componentBoundPlugPath(), IECoreMaya.FnProceduralHolder.componentNames(), IECoreMaya.FnProceduralHolder.componentTransformPlugPath(), IECoreMaya.FnSceneShape.convertAllToGeometry(), IECoreMaya.FnSceneShape.convertObjectToGeometry(), IECoreMaya.FnProceduralHolder.convertToGeometry(), IECoreMaya.FnSceneShape.createChild(), IECoreMaya.FnDagNode.hiddenPathNames(), IECoreMaya.FnParameterisedHolder.parameterPlug(), IECoreMaya.FnParameterisedHolder.parameterPlugPath(), IECoreMaya.FnProceduralHolder.selectComponentNames(), IECoreMaya.FnSceneShape.selectComponentNames(), IECoreMaya.FnProceduralHolder.selectedComponentNames(), IECoreMaya.FnSceneShape.selectedComponentNames(), IECoreMaya.FnParameterisedHolder.setNodeValue(), IECoreMaya.FnParameterisedHolder.setNodeValues(), and IECoreMaya.FnParameterisedHolder.setParameterised().

def IECoreMaya.FnParameterisedHolder.getParameterised (   self)

Returns a tuple of the form (parameterised, className, classVersion, searchPathEnvVar).

The returned parameterised object is not guaranteed to be in sync with the plug values. Use setParameterisedValues function if you need that.

Referenced by IECoreMaya.FnProceduralHolder.getProcedural(), IECoreMaya.FnParameterisedHolder.ls(), IECoreMaya.FnParameterisedHolder.removeSetClassParameterClassCallback(), and IECoreMaya.FnParameterisedHolder.setParameterised().

def IECoreMaya.FnParameterisedHolder.ls (   cls,
  selection = False,
  fnSets = True,
  classType = None 
)

Lists the ieParameterisedHolderNodes in the current scene.

The keyword arguments operate as follows :

selection : Only list holders in the current selection. Defaults to False

fnSets : Returns a list of FnParameterisedHolder instances if True, otherwise returns node names. Defaults to True

classType : Python class: if specified, only lists holders holding this class

References IECoreMaya._ParameterModificationContext.__fnPH, IECoreMaya.FnParameterisedHolder.__init__(), IECoreMaya._ParameterModificationContext.__originalClasses, IECoreMaya._ParameterModificationContext.__originalValues, IECoreMaya.FnConverterHolder.convertAtFrame(), IECoreMaya.FnConverterHolder.converter(), IECore::Writer.create(), IECoreMaya::OpHolder< BaseType >.getParameterised(), IECoreMaya::ParameterisedHolderInterface.getParameterised(), IECoreMaya::ParameterisedHolder< BaseType >.getParameterised(), IECoreMaya.FnParameterisedHolder.getParameterised(), IECoreGL::HitRecord.name, IECoreGL::NameStateComponent.name(), IECoreHoudini::LiveScene.name(), IECoreMaya::LiveScene.name(), IECore::IFFFile::Tag.name(), IECore::Parameter.name(), IECoreMaya::ObjectData.name(), IECore::SceneCache.name(), IECoreRI::PTCParticleIO::PTCType.name, IECore::LinkedScene.name(), IECore::SceneInterface.name(), IECoreHoudini::FromHoudiniGeometryConverter::RemapInfo.name, IECoreHoudini.ActiveTake.name(), IECoreHoudini::OBJ_SceneCacheGeometry.typeName, IECoreHoudini::SOP_CortexConverter.typeName, IECoreHoudini::ROP_SceneCacheWriter.typeName, IECoreHoudini::SOP_SceneCacheTransform.typeName, IECoreMaya::CurveCombiner.typeName, IECoreMaya::GeometryCombiner.typeName, IECoreHoudini::SOP_SceneCacheSource.typeName, IECoreHoudini::OBJ_SceneCacheTransform.typeName, IECoreMaya::TransientParameterisedHolderNode.typeName, IECoreMaya::DrawableHolder.typeName, IECoreHoudini::GU_CortexPrimitive.typeName, IECoreGL::TypedStateComponent< T, TId >.typeName(), IECoreMaya::TransformationMatrixManipulator.typeName, IECoreMaya::ObjectData.typeName, IECoreMaya::ParameterisedHolder< BaseType >.typeName, IECoreMaya::Box3Manipulator.typeName, IECoreHoudini::GEO_CortexPrimitive.typeName, and IECore::RunTimeTyped.typeName().

def IECoreMaya.FnParameterisedHolder.parameterModificationContext (   self)

Returns a context manager for use with the with statement.

This can be used to scope edits to Parameter values (including the classes held by ClassParameters and ClassVectorParameters) in such a way that they are automatically transferred onto the maya attributes and furthermore in an undoable fashion.

def IECoreMaya.FnParameterisedHolder.parameterPlug (   self,
  parameter 
)

Returns the OpenMaya.MPlug object responsible for representing the given parameter.

References IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), and IECoreMaya.FnParameterisedHolder.fullPathName().

Referenced by IECoreMaya.FnParameterisedHolder.setNodeValue().

def IECoreMaya.FnParameterisedHolder.parameterPlugPath (   self,
  parameter 
)

Returns a string containing a full pathname for the plug representing the given parameter.

References IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), and IECoreMaya.FnParameterisedHolder.fullPathName().

def IECoreMaya.FnParameterisedHolder.plugParameter (   self,
  plug 
)

Returns the IECore.Parameter object being represented by the given fullPathName of the maya plug or its OpenMaya.MPlug instance.

def IECoreMaya.FnParameterisedHolder.removeSetParameterisedCallback (   cls,
  callback 
)

Remove a previously added callback.

def IECoreMaya.FnParameterisedHolder.setNodeValue (   self,
  parameter,
  undoable = True 
)

Set the value for the plug representing parameter, using the current value of the parameter.

If the undoable parameter is True then this method is undoable using the standard maya undo mechanism.

References IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreMaya::ParameterisedHolderInterface.parameterPlug(), IECoreMaya::ParameterisedHolder< BaseType >.parameterPlug(), and IECoreMaya.FnParameterisedHolder.parameterPlug().

def IECoreMaya.FnParameterisedHolder.setNodeValues (   self,
  undoable = True 
)

Sets the values of the plugs representing the parameterised object, using the current values of the parameters.

If the undoable parameter is True then this method is undoable using the standard maya undo mechanism.

Note
If this is applied to a node in a reference, then reference edits will be produced for every parameter plug, even if the values are not changing. You may prefer to set parameter values within a parameterModificationContext() instead as this automatically transfers the values to maya, while also avoiding the reference edit problem.

References IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), and IECoreMaya.FnParameterisedHolder.fullPathName().

def IECoreMaya.FnParameterisedHolder.setParameterised (   self,
  classNameOrParameterised,
  classVersion = None,
  envVarName = None,
  undoable = True 
)

Sets the IECore.Parameterised object held by the node.

This function can be called in two ways :

setParameterised( Parameterised p ) Directly sets the held object to the Parameterised instance p. Note that this form doesn't provide enough information for the node to be reinstantiated after saving and reloading of the maya scene - see the form below for that. Also note that this form is not undoable, and that the undoable parameter will therefore be ignored.

setParameterised( string className, int classVersion, string searchPathEnvVar, bool undoable ) Sets the held object by specifying a class that will be loaded using the IECore.ClassLoader. searchPathEnvVar specifies an environment variable which holds a colon separated search path for the ClassLoader. This form allows the held class to be reinstantiated across scene save/load, and is also undoable if requested using the undoable parameter. If classVersion is omitted, None, or negative, then the highest available version will be used.

References IECoreMaya.FnParameterisedHolder._classParameterStates(), IECoreMaya.FnParameterisedHolder._despatchSetParameterisedCallbacks(), IECore.ClassLoader.defaultLoader(), IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreMaya::OpHolder< BaseType >.getParameterised(), IECoreMaya::ParameterisedHolderInterface.getParameterised(), IECoreMaya::ParameterisedHolder< BaseType >.getParameterised(), IECoreMaya.FnParameterisedHolder.getParameterised(), IECoreMaya::ParameterisedHolderInterface.setParameterisedValues(), IECoreMaya::ParameterisedHolder< BaseType >.setParameterisedValues(), and IECoreMaya.FnParameterisedHolder.setParameterisedValues().

Referenced by IECoreMaya.FnProceduralHolder.setProcedural().

def IECoreMaya.FnParameterisedHolder.setParameterisedValue (   self,
  parameter 
)

Sets the value of parameter from the value held by the plug representing it.

def IECoreMaya.FnParameterisedHolder.setParameterisedValues (   self)

Transfers the values from the plugs of the node onto the parameters of the held Parameterised object.

Referenced by IECoreMaya.FnParameterisedHolder.setParameterised().


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