pymel.core.nodetypes.RenderLayer¶
digraph inheritance197718e998 { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "DependNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DependNode.html#pymel.core.nodetypes.DependNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" -> "DependNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProxyUnicode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.util.utilitytypes/pymel.util.utilitytypes.ProxyUnicode.html#pymel.util.utilitytypes.ProxyUnicode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.core.general/pymel.core.general.PyNode.html#pymel.core.general.PyNode",style="setlinewidth(0.5)",tooltip="Abstract class that is base for all pymel nodes classes.",height=0.25,shape=box,fontsize=8]; "ProxyUnicode" -> "PyNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RenderLayer" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.RenderLayer",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DependNode" -> "RenderLayer" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
- class RenderLayer(*args, **kwargs)¶
- addAdjustments(members)¶
- addMembers(members, noRecurse=True)¶
- adjustmentPlug(scenePlug)¶
Returns the render layer adjustment value plug for the specified plug. If there is no layer override on the plug, a copy of scenePlug is returned.
Parameters: - scenePlug : PyNode
The plug for which the adjustment is sought.
Return type: PyNode
Derived from api method maya.OpenMayaRender.MFnRenderLayer.adjustmentPlug
- classmethod currentLayer()¶
Returns the MObject for the current render layer. This MObject can be used in MFnRenderLayer .
Return type: PyNode Derived from api method maya.OpenMayaRender.MFnRenderLayer.currentLayer
- classmethod defaultRenderLayer()¶
Returns the MObject for the defaultRenderLayer. This MObject can be used in MFnRenderLayer .
Return type: PyNode Derived from api method maya.OpenMayaRender.MFnRenderLayer.defaultRenderLayer
- externalRenderPasses()¶
The function builds an array of unique render pass nodes ( MObject ) that are connected to the renderPass attribute. This function descends recursively into render pass sets to collect all connected render passes.
Return type: PyNode list Derived from api method maya.OpenMayaRender.MFnRenderLayer.externalRenderPasses
- classmethod findLayerByName(renderLayer)¶
This function returns an MObject to a render layer that matches the specified name. If no render layer is found with the given name, MObject::kNullObj is returned.
Parameters: - renderLayer : unicode
The name of the render layer.
Return type: PyNode
Derived from api method maya.OpenMayaRender.MFnRenderLayer.findLayerByName
- inCurrentRenderLayer(objectPath)¶
The function checks if the given object is present in the current render layer or not.
Parameters: - objectPath : PyNode
Path of the render layer object.
Return type: bool
Derived from api method maya.OpenMayaRender.MFnRenderLayer.inCurrentRenderLayer
- inLayer(transform)¶
Returns true if the given shape is in this layer. This method will check all container layers for transform containment. The MObject specified must be a shape node.
Parameters: - transform : PyNode
MObject of the shape we are testing against.
Return type: bool
Derived from api method maya.OpenMayaRender.MFnRenderLayer.inLayer
- isPlugAdjusted(scenePlug)¶
The function checks if the specified plug is adjusted or not; returns true if the plug is adjusted, else returns false.
Parameters: - scenePlug : PyNode
The plug which needs to be checked for adjustment.
Return type: bool
Derived from api method maya.OpenMayaRender.MFnRenderLayer.isPlugAdjusted
- layerChildren(recurse=False)¶
Returns the container layers for this layer. Container layers provide the ability for a given render layer to “contain” other render layers.
Parameters: - recurse : bool
If true then the list operation will be applied recursively to any contained render layers which themselves contain other render layers.
Return type: PyNode list
Derived from api method maya.OpenMayaRender.MFnRenderLayer.layerChildren
- listAdjustments()¶
- classmethod listAllRenderLayers()¶
Returns the list of render layers currently in the system.
Return type: PyNode list Derived from api method maya.OpenMayaRender.MFnRenderLayer.listAllRenderLayers
- listMembers(fullNames=True)¶
- passHasLight(renderPass, light)¶
Returns true if the specified light contributes to the given render pass, based on the pass contribution maps attached to this layer. This method does not verify whether the light or the renderPass are actually rendered by the layer.
Parameters: - renderPass : PyNode
a render pass node
- light : PyNode
a light shape node
Return type: bool
Derived from api method maya.OpenMayaRender.MFnRenderLayer.passHasLight
- passHasObject(renderPass, objectInstance)¶
Returns true if the specified object instance contributes to the given render pass, based on the pass contribution maps attached to the layer. This method does not verify whether the object instance or the renderPass are actually rendered by the layer.
Parameters: - renderPass : PyNode
a render pass node
- objectInstance : PyNode
DAG path of a shape instance
Return type: bool
Derived from api method maya.OpenMayaRender.MFnRenderLayer.passHasObject
- removeAdjustments(members)¶
- removeMembers(members)¶
- setCurrent()¶