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

A function set for operating on the IECoreMaya::ProceduralHolder type. More...

+ Inheritance diagram for IECoreMaya.FnProceduralHolder:

Public Member Functions

def __init__ (self, object)
 Initialise the function set for the given procedural object, which may either be an MObject or a node name in string or unicode form. More...
 
def setProcedural
 Convenience method to call setParameterised with the environment variable for the searchpaths set to "IECORE_PROCEDURAL_PATHS". More...
 
def getProcedural (self)
 Convenience method to return the ParameterisedProcedural class held inside this node. More...
 
def componentNames (self)
 Returns a set of the names of the components within the procedural. More...
 
def selectedComponentNames (self)
 Returns a set of the names of any currently selected components. More...
 
def selectComponentNames (self, componentNames)
 Selects the components specified by the passed names. More...
 
def scene (self)
 Returns the IECoreGL.Scene displayed by this node. More...
 
def convertToGeometry
 Creates a hierarchy of maya nodes representing the output of the procedural at the current frame. More...
 
def componentTransformPlugPath (self, componentName)
 Returns a path to a plug which outputs the transform for the specified component. More...
 
def componentBoundPlugPath (self, componentName)
 Returns a path to a plug which outputs the bounding box of the specified component. More...
 
def createLocatorAtTransform (self, path)
 
def createLocatorAtPoints (self, path, childPlugSuffixes)
 
- Public Member Functions inherited from IECoreMaya.FnParameterisedHolder
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...
 

Static Public Member Functions

def create
 Creates a new node under a transform of the specified name and holding the specified procedural class type. More...
 

Detailed Description

A function set for operating on the IECoreMaya::ProceduralHolder type.

Constructor & Destructor Documentation

def IECoreMaya.FnProceduralHolder.__init__ (   self,
  object 
)

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

Member Function Documentation

def IECoreMaya.FnProceduralHolder.componentBoundPlugPath (   self,
  componentName 
)

Returns a path to a plug which outputs the bounding box of the specified component.

The plug will have "componentBoundMin", "componentBoundMax" and "componentBoundCenter" children with the appropriate values.

References IECoreMaya.FnProceduralHolder.__collapseGroups(), IECoreMaya.FnProceduralHolder.__componentIndex(), IECoreMaya.FnProceduralHolder.__removeChildlessGroups(), IECoreMaya.FnProceduralHolder.componentBoundPlugPath(), IECoreMaya.FnProceduralHolder.componentTransformPlugPath(), IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), and IECoreMaya.FnParameterisedHolder.fullPathName().

Referenced by IECoreMaya.FnProceduralHolder.componentBoundPlugPath().

def IECoreMaya.FnProceduralHolder.componentNames (   self)

Returns a set of the names of the components within the procedural.

These names are specified by the procedural by setting the "name" attribute in the renderer

References IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreNuke::DrawableHolder.scene(), IECoreNuke::ProceduralHolder.scene(), IECoreMaya::DrawableHolder.scene(), IECoreMaya::ProceduralHolder.scene(), IECore::SceneCache.scene(), IECoreGL::Renderer.scene(), IECore::LinkedScene.scene(), IECoreMaya::LiveScene.scene(), IECore::SceneInterface.scene(), and IECoreMaya.FnProceduralHolder.scene().

Referenced by IECoreMaya.FnSceneShape.selectComponentNames(), and IECoreMaya.FnSceneShape.selectedComponentNames().

def IECoreMaya.FnProceduralHolder.componentTransformPlugPath (   self,
  componentName 
)

Returns a path to a plug which outputs the transform for the specified component.

The plug will have "componentTranslate", "componentRotate" and "componentScale" children with the appropriate values.

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

Referenced by IECoreMaya.FnProceduralHolder.componentBoundPlugPath().

def IECoreMaya.FnProceduralHolder.convertToGeometry (   self,
  parent = None 
)

Creates a hierarchy of maya nodes representing the output of the procedural at the current frame.

If parent is specified then the geometry will be parented under it, otherwise it will share the parent of the procedural. Returns the path to the top level transform of the new geometry.

References IECoreMaya.FnProceduralHolder.__collapseGroups(), IECoreMaya.FnProceduralHolder.__removeChildlessGroups(), IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreMaya::ProceduralHolder.getProcedural(), IECoreMaya.FnProceduralHolder.getProcedural(), and IECoreMaya.FnProceduralHolder.selectedComponentNames().

def IECoreMaya.FnProceduralHolder.create (   parentName,
  className,
  classVersion = -1 
)
static

Creates a new node under a transform of the specified name and holding the specified procedural class type.

Returns a function set instance operating on this new node.

def IECoreMaya.FnProceduralHolder.getProcedural (   self)
def IECoreMaya.FnProceduralHolder.scene (   self)

Returns the IECoreGL.Scene displayed by this node.

Referenced by IECoreMaya.FnProceduralHolder.componentNames().

def IECoreMaya.FnProceduralHolder.selectComponentNames (   self,
  componentNames 
)

Selects the components specified by the passed names.

If replace is True then the current selection is deselected first.

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

def IECoreMaya.FnProceduralHolder.selectedComponentNames (   self)

Returns a set of the names of any currently selected components.

These names are specified by the procedural by setting the "name" attribute in the renderer.

References IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreMaya::FromMayaObjectConverter.object(), and IECore::Writer.object().

Referenced by IECoreMaya.FnProceduralHolder.convertToGeometry().

def IECoreMaya.FnProceduralHolder.setProcedural (   self,
  className,
  classVersion = None,
  undoable = True 
)

Convenience method to call setParameterised with the environment variable for the searchpaths set to "IECORE_PROCEDURAL_PATHS".

References IECoreMaya::ParameterisedHolderInterface.setParameterised(), IECoreMaya::OpHolder< BaseType >.setParameterised(), IECoreMaya::ParameterisedHolder< BaseType >.setParameterised(), and IECoreMaya.FnParameterisedHolder.setParameterised().


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