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

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

Inherits MFnDagNode.

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 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 sceneInterface (self)
 
def componentNames (self)
 
def canBeExpanded (self)
 Returns True if the scene shape can be expanded. More...
 
def canBeCollapsed (self)
 Returns True if the scene shape can be collapsed. More...
 
def createChild
 create the given child for the scene shape Returns a the function set for the child scene shape. More...
 
def expandOnce
 Expands the scene shape one level down if possible. More...
 
def expandAll
 Recursively expands all levels starting from the scene shape. More...
 
def collapse (self)
 Collapses all children up to this scene shape. More...
 
def convertAllToGeometry
 Recursively converts all objects in the scene interface to compatible maya geometry All scene shape nodes in the hierarchy are turned into an intermediate object. More...
 
def convertObjectToGeometry
 Converts the object (if any) in the scene interface into maya geometry. More...
 
def createLocatorAtTransform (self, path)
 
def createLocatorAtPoints (self, path, childPlugSuffixes)
 

Static Public Member Functions

def create
 Creates a new node under a transform of the specified name. More...
 
def createShape (parentNode)
 Create a scene shape under the given node. More...
 

Detailed Description

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

Constructor & Destructor Documentation

def IECoreMaya.FnSceneShape.__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.FnSceneShape.canBeCollapsed (   self)

Returns True if the scene shape can be collapsed.

We assume that if the objectOnly flag is off, the scene shape is already collapsed.

References IECoreMaya.FnSceneShape.__queryIndexForPath(), IECoreMaya.FnSceneShape.create(), IECoreMaya.FnSceneShape.createShape(), IECoreMaya.dagPathFromString(), IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreHoudini::SceneCacheNode< BaseType >.getPath(), IECoreHoudini::SceneCacheNode< OBJ_SubNet >.getPath(), IECoreHoudini::SceneCacheNode< OBJ_Geometry >.getPath(), and IECoreHoudini::SceneCacheNode< SOP_Node >.getPath().

def IECoreMaya.FnSceneShape.canBeExpanded (   self)

Returns True if the scene shape can be expanded.

We assume that if the objectOnly flag is on, it means the scene shape has already been expanded so return False. Can only be expanded if the scene interface for the scene shape has children.

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

def IECoreMaya.FnSceneShape.collapse (   self)

Collapses all children up to this scene shape.

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

def IECoreMaya.FnSceneShape.convertAllToGeometry (   self,
  preserveNamespace = False 
)

Recursively converts all objects in the scene interface to compatible maya geometry All scene shape nodes in the hierarchy are turned into an intermediate object.

References IECoreMaya.FnSceneShape.__connectShape(), IECoreMaya.FnSceneShape.__findOrCreateShape(), IECoreMaya.FnSceneShape.__mayaCompatibleShapeAndPlug(), IECoreMaya.FnSceneShape.__queryIndexForPath(), IECoreMaya.FnSceneShape.__readConvertParams(), IECoreMaya.FnSceneShape.__setConvertParams(), IECoreMaya::ToMayaObjectConverter.create(), IECoreMaya.FnDagNode.defaultShapeName(), IECoreMaya.FnSceneShape.expandAll(), IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreMaya.FnSceneShape.sceneInterface(), and IECoreMaya::ToMayaMeshConverter.setMeshInterpolationAttribute().

def IECoreMaya.FnSceneShape.convertObjectToGeometry (   self,
  transformNode = None 
)

Converts the object (if any) in the scene interface into maya geometry.

If a shape with the expected name but incompatible type is found under the transform, we rename it and create a new proper shape. The shape is connected to the scene shape object output only if it isn't already connected or locked. transformNode parameter can be used to specify the parent of the geometry. If None, uses the transform of the scene shape.

References IECoreMaya.FnSceneShape.__connectShapes(), IECoreMaya.FnSceneShape.__findOrCreateShapes(), IECoreMaya.FnSceneShape.__queryIndexForPath(), IECoreHoudini::SOP_SceneCacheSource::Parameters.fullPathName, IECoreHoudini::OBJ_SceneCacheTransform::Parameters.fullPathName, IECoreMaya::SceneShapeInterface.fullPathName(), IECoreMaya.FnParameterisedHolder.fullPathName(), IECoreHoudini::SceneCacheNode< SOP_Node >.getPath(), IECoreHoudini::SceneCacheNode< OBJ_Geometry >.getPath(), IECoreHoudini::SceneCacheNode< OBJ_SubNet >.getPath(), IECoreHoudini::SceneCacheNode< BaseType >.getPath(), and IECoreMaya.FnSceneShape.sceneInterface().

def IECoreMaya.FnSceneShape.create (   parentName,
  transformParent = None 
)
static

Creates a new node under a transform of the specified name.

Returns a function set instance operating on this new node.

Referenced by IECoreMaya.FnSceneShape.canBeCollapsed().

def IECoreMaya.FnSceneShape.createChild (   self,
  childName,
  sceneFile,
  sceneRoot,
  drawGeo = False,
  drawChildBounds = False,
  drawRootBound = True,
  drawTagsFilter = "",
  preserveNamespace = False 
)

create the given child for the scene shape Returns a the function set for the child scene shape.

If preserveNamespace is True, it creates the child with the same namespace as the one this sceneShape node has.

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

Referenced by IECoreMaya.FnSceneShape.expandOnce().

def IECoreMaya.FnSceneShape.createShape (   parentNode)
static

Create a scene shape under the given node.

Returns a function set instance operating on this shape.

Referenced by IECoreMaya.FnSceneShape.canBeCollapsed().

def IECoreMaya.FnSceneShape.expandAll (   self,
  preserveNamespace = False,
  tagName = None 
)

Recursively expands all levels starting from the scene shape.

Returns a list of function sets for all the child scene shapes. If preserveNamespace is True, it creates transforms and shapes with the same namespace as the one this sceneShape node has. If tagName is specfied, each scene in the hierarchy expands only if at least one child has the tag

Referenced by IECoreMaya.FnSceneShape.convertAllToGeometry().

def IECoreMaya.FnSceneShape.expandOnce (   self,
  preserveNamespace = False 
)

Expands the scene shape one level down if possible.

Returns a list of function sets for the child scene shapes. Missing child transforms and shapes will be created, missing connections and attribute values will be reset. If preserveNamespace is True, it creates transforms and shapes with the same namespace as the one this sceneShape node has.

References IECore::SceneCache.createChild(), IECore::LinkedScene.createChild(), IECoreMaya::LiveScene.createChild(), IECore::SceneInterface.createChild(), IECoreMaya.FnSceneShape.createChild(), and IECoreMaya.FnSceneShape.sceneInterface().

def IECoreMaya.FnSceneShape.selectComponentNames (   self,
  componentNames 
)

Selects the components specified by the passed names.

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

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

def IECoreMaya.FnSceneShape.selectedComponentNames (   self)

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

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


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