pymel.core.nodetypes.CameraSet¶
digraph inheritancea40ba90cb7 { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "CameraSet" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.CameraSet",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `cameraSet`",height=0.25,shape=box,fontsize=8]; "DependNode" -> "CameraSet" [arrowsize=0.5,style="setlinewidth(0.5)"]; "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)"]; }
- class CameraSet(*args, **kwargs)¶
class counterpart of mel function cameraSet
This command manages camera set nodes. Camera sets allow the users to break a single camera shot into layers. Instead of drawing all objects with a single camera, you can isolate the camera to only focus on certain objects and layer another camera into the viewport that draws the other objects. The situation to use camera sets primarily occurs when building stereoscopic scenes. For example, a set of stereo parameters may make the background objects divergent beyond the tolerable range of the human perceptual system. However, you like the settings because the main focus is in the foreground and the depth is important to the visual look of the scene. You can use camera sets to break apart the shot into a foreground stereo camera and background stereo camera. The foreground stereo camera will retain the original parameters; however, it will only focus on the foreground elements. The background stereo camera will have a different set of stereo parameters and will only draw the background element. Camera sets can be viewed using the stereo viewer and are currently only designed to work with stereo camera rigs.
- appendLayer(camera, set)¶
Appends a layer to the associated cameraSet node. The given camera and object set are used in the layer. If MObject::kNullObj is passed as the set, then the whole scene will be rendered in the layer.
Parameters: - camera : PyNode
The camera or stereo rig for the layer
- set : PyNode
The set of objects used in the layer
Derived from api method maya.OpenMaya.MFnCameraSet.appendLayer
Undo is not currently supported for this method
- appendTo(val=True, **kwargs)¶
Append a new camera and/or object set to then end of the cameraSet layer list. This flag cannot be used in conjunction with insert flag. Additionally, it requires the camera and/or objectSet flag to be used.
Derived from mel command maya.cmds.cameraSet
- clear()¶
Clear all of the camera layers. Derived from api method maya.OpenMaya.MFnCameraSet.clear
Undo is not currently supported for this method
- deleteAll(val=True, **kwargs)¶
Delete all camera layers
Derived from mel command maya.cmds.cameraSet
- deleteLayer(index)¶
Deletes the layer denoted by the given index.
Parameters: - index : int
The index of the layer
Derived from api method maya.OpenMaya.MFnCameraSet.deleteLayer
Undo is not currently supported for this method
- getActive(**kwargs)¶
Gets / sets the active camera layer.
Derived from mel command maya.cmds.cameraSet
- getCamera(**kwargs)¶
Set/get the camera for a particular layer. When in query mode, You must specify the layer with the layer flag.
Derived from mel command maya.cmds.cameraSet
- getClearDepth(**kwargs)¶
Specifies if the drawing buffer should be cleared before beginning the draw for that layer.
Derived from mel command maya.cmds.cameraSet
- getLayer(**kwargs)¶
Specifies the layer index to be used when accessing layer information
Derived from mel command maya.cmds.cameraSet
- getLayerCamera(index)¶
Get the camera used for a particular layer.
Parameters: - index : int
The index of the layer
Return type: PyNode
Derived from api method maya.OpenMaya.MFnCameraSet.getLayerCamera
- getLayerClearDepthValue(index)¶
This method gets the clearDepth attribute value for the specified camera layer
Parameters: - index : int
The index of the layer
Return type: bool
Derived from api method maya.OpenMaya.MFnCameraSet.getLayerClearDepthValue
- getLayerOrder(index)¶
Get the processing order of a particular layer.
Parameters: - index : int
The index of the layer
Return type: int
Derived from api method maya.OpenMaya.MFnCameraSet.getLayerOrder
- getLayerSceneData(index)¶
Get the scene data used for a particular layer. The returned scene data could be MObject::kNullObj if no scene data has been set. The operation will still be deemed successful.
Parameters: - index : int
The index of the layer
Return type: PyNode
Derived from api method maya.OpenMaya.MFnCameraSet.getLayerSceneData
- getNumLayers()¶
Return the number of layers in the cameraSet.
Return type: int Derived from api method maya.OpenMaya.MFnCameraSet.getNumLayers
- getObjectSet(**kwargs)¶
Set/get the objectSet for a particular layer. When in query mode, you must specify the layer with the layer flag.
Derived from mel command maya.cmds.cameraSet
- getOrder(**kwargs)¶
Set the order in which a particular layer is processed. This flag must be used in conjunction with the layer flag. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command maya.cmds.cameraSet
- insertAt(val=True, **kwargs)¶
Inserts the specified camera and/or object set at the specified layer. This flag cannot be used in conjunction with the append flag. Additionally, this flag requires layer and camera (or objectSet) flag to be used.
Derived from mel command maya.cmds.cameraSet
- insertLayer(index, camera, set)¶
Inserts a layer at the given index to the associated cameraSet node using the given camera. The index value must be in the range from 0 to the number of layers currently defined. The given camera and object set are used in the layer. If MObject::kNullObj is passed as the set, then the whole scene will be rendered in the layer.
Parameters: - index : int
The index of the layer
- camera : PyNode
The camera for the layer
- set : PyNode
The set of objects used in the layer
Derived from api method maya.OpenMaya.MFnCameraSet.insertLayer
Undo is not currently supported for this method
- isLayerActive(index)¶
Get whether a particular layer is active.
Parameters: - index : int
The index of the layer
Return type: bool
Derived from api method maya.OpenMaya.MFnCameraSet.isLayerActive
- setActive(val=True, **kwargs)¶
Gets / sets the active camera layer.
Derived from mel command maya.cmds.cameraSet
- setCamera(val=True, **kwargs)¶
Set/get the camera for a particular layer. When in query mode, You must specify the layer with the layer flag.
Derived from mel command maya.cmds.cameraSet
- setClearDepth(val=True, **kwargs)¶
Specifies if the drawing buffer should be cleared before beginning the draw for that layer.
Derived from mel command maya.cmds.cameraSet
- setLayer(val=True, **kwargs)¶
Specifies the layer index to be used when accessing layer information
Derived from mel command maya.cmds.cameraSet
- setLayerActive(index, isActive)¶
Set a particular layer to be active.
Parameters: - index : int
The index of the layer
- isActive : bool
Whether the layer should be processed
Derived from api method maya.OpenMaya.MFnCameraSet.setLayerActive
- setLayerCamera(index, camera)¶
Set the camera to be used for a particular layer.
Parameters: - index : int
The index of the layer
- camera : PyNode
The camera for the layer
Derived from api method maya.OpenMaya.MFnCameraSet.setLayerCamera
- setLayerClearDepthValue(index, depth)¶
This method sets the clearDepth attribute for the specified camera layer.
Parameters: - index : int
The index of the layer
- depth : bool
The clear depth value
Derived from api method maya.OpenMaya.MFnCameraSet.setLayerClearDepthValue
- setLayerOrder(index, order)¶
Set the processing order of a particular layer.
Parameters: - index : int
The index of the layer
- order : int
The order number
Derived from api method maya.OpenMaya.MFnCameraSet.setLayerOrder
- setLayerSceneData(index, set)¶
Set the scene data to be used for a particular layer.
Parameters: - index : int
The index of the layer
- set : PyNode
The object set for the layer
Derived from api method maya.OpenMaya.MFnCameraSet.setLayerSceneData
- setObjectSet(val=True, **kwargs)¶
Set/get the objectSet for a particular layer. When in query mode, you must specify the layer with the layer flag.
Derived from mel command maya.cmds.cameraSet
- setOrder(val=True, **kwargs)¶
Set the order in which a particular layer is processed. This flag must be used in conjunction with the layer flag. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command maya.cmds.cameraSet