Package autodesk_toxik :: Module precompmodule :: Class RenderPass

Class RenderPass

   object --+    
            |    
PrecompObject --+
                |
               RenderPass

Class representing a render pass, i.e. the pass of a specific layer rendered through a specific camera. In other words, a RenderPass instance is bound to a specific RenderLayer instance, and consequently, by definition of the RenderLayer class, to a specific RenderCamera instance.

Instance Methods

__init__(self, renderPass, renderLayer)
Constructor from a precomp module RenderPass instance and a RenderLayer instance.

RenderLayer

getRenderLayer(self)
Returns: The RenderLayer instance this RenderPass belongs to.

RenderCamera

getRenderCamera(self)
Returns: The RenderCamera instance this RenderPass belongs to.

Scene

getScene(self)
Returns: The Scene instance this RenderPass belongs to.

str

getName(self)
Returns: The render pass display name, as a unicode string.

str

getAnchor(self)
Returns: The render pass anchor, as a unicode string.

int

getVersion(self)
Returns: The version number of the render pass, as an integer.

str

getDescription(self)
Returns: The render pass description, possibly empty, as a unicode string.

str

getNote(self)
Returns: A note about the render pass, possibly empty, as a unicode string.

str

getFileSequencePath(self)
Returns: The absolute path (unicode) of the file sequence for this render pass.

str

getFrameIndexToken(self)
Returns: The special token (unicode string) used to replace the frame index in the path returned by getFileSequencePath().

bool

isSingleFrame(self)
Returns: A bool indicating whether the render of this pass is a single file that doesn't have a frame index in its name.

tuple

getFrameRange(self)
Returns: A tuple specifying the start and end frames of the rendered file sequence for this pass, as integers (taking frame renumbering into account if applicable).

int

getFrameIndexPadding(self)
Returns: An integer specifying the frame index padding used in file names rendered from this pass.

bool

isFileSequenceMultiChannel(self)
Returns: A bool indicating whether the rendered files for this pass contain multiple channels (other than the standard RGBA channels).

str

getFileChannelViewName(self)
Returns: The name of the channel view in which the render pass channels are stored, when rendered to a multi-channel file, as a unicode string.

int

getRenderWidth(self)
Returns: The render resolution width used for this pass, as an integer.

int

getRenderHeight(self)
Returns: The render resolution height used for this pass, as an integer.

float

getRenderPixelRatio(self)
Returns: The render pixel ratio used for this pass, as a float.

int

getRenderNbChannels(self)
Returns: The number of channels in the rendered images, as an integer.

int

getRenderDepth(self)
Returns: The bit depth of the rendered images, as an integer.

bool

isRenderPremultiplied(self)
Returns: A bool indicating whether the render pass images are premultiplied.

tuple

getRenderPremultiplyBgColor(self)
Returns: The RGB float triplet used to premultiply the render pass images.

bool

isSelectedForImport(self)
Returns: A bool indicating whether this render pass should be imported by default.

Inherited from PrecompObject: getAppId, getPrecompModule, invokePrecompMethod

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(self, renderPass, renderLayer)
(Constructor)

Constructor from a precomp module RenderPass instance and a RenderLayer instance.

Parameters:

renderPass (RenderPass)
renderLayer (RenderLayer)

Overrides: object.__init__

getRenderLayer(self)

Returns: RenderLayer: The RenderLayer instance this RenderPass belongs to.

getRenderCamera(self)

Returns: RenderCamera: The RenderCamera instance this RenderPass belongs to.

getScene(self)

Returns: Scene: The Scene instance this RenderPass belongs to.

getName(self)

Returns: str: The render pass display name, as a unicode string. The render pass name should be unique within the scene.

getAnchor(self)

Returns: str: The render pass anchor, as a unicode string. The render pass anchor should be unique within the scene.

getVersion(self)

Returns: int: The version number of the render pass, as an integer.

getDescription(self)

Returns: str: The render pass description, possibly empty, as a unicode string.

getNote(self)

Returns: str: A note about the render pass, possibly empty, as a unicode string.

getFileSequencePath(self)

Returns: str: The absolute path (unicode) of the file sequence for this render pass. If the sequence is not single frame, the returned file name will have a special token in it to indicate where the frame index is located; see getFrameIndexToken().

getFrameIndexToken(self)

Returns: str: The special token (unicode string) used to replace the frame index in the path returned by getFileSequencePath().

isSingleFrame(self)

Returns: bool: A bool indicating whether the render of this pass is a single file that doesn't have a frame index in its name.

getFrameRange(self)

Returns: tuple: A tuple specifying the start and end frames of the rendered file sequence for this pass, as integers (taking frame renumbering into account if applicable). The end frame is inclusive.

getFrameIndexPadding(self)

Returns: int: An integer specifying the frame index padding used in file names rendered from this pass.

isFileSequenceMultiChannel(self)

Returns: bool: A bool indicating whether the rendered files for this pass contain multiple channels (other than the standard RGBA channels).

getFileChannelViewName(self)

Returns: str: The name of the channel view in which the render pass channels are stored, when rendered to a multi-channel file, as a unicode string. The channel view name, followed by a dot, prefixes the image channel name in the file channel name. For example, if the channel view name was 'DirectIrradiance.Left' the name of the red channel in the file would be 'DirectIrradiance.Left.R'.

getRenderWidth(self)

Returns: int: The render resolution width used for this pass, as an integer.

getRenderHeight(self)

Returns: int: The render resolution height used for this pass, as an integer.

getRenderPixelRatio(self)

Returns: float: The render pixel ratio used for this pass, as a float.

getRenderNbChannels(self)

Returns: int: The number of channels in the rendered images, as an integer. Supported number of channels are 1, 3 and 4.

getRenderDepth(self)

Returns: int: The bit depth of the rendered images, as an integer. Supported depth values are 8, 16 and 32.

isRenderPremultiplied(self)

Returns: bool: A bool indicating whether the render pass images are premultiplied.

getRenderPremultiplyBgColor(self)

Returns: tuple: The RGB float triplet used to premultiply the render pass images.

isSelectedForImport(self)

Returns: bool: A bool indicating whether this render pass should be imported by default.

Class RenderPass

__init__(self, renderPass, renderLayer) (Constructor)

getRenderLayer(self)

getRenderCamera(self)

getScene(self)

getName(self)

getAnchor(self)

getVersion(self)

getDescription(self)

getNote(self)

getFileSequencePath(self)

getFrameIndexToken(self)

isSingleFrame(self)

getFrameRange(self)

getFrameIndexPadding(self)

isFileSequenceMultiChannel(self)

getFileChannelViewName(self)

getRenderWidth(self)

getRenderHeight(self)

getRenderPixelRatio(self)

getRenderNbChannels(self)

getRenderDepth(self)

isRenderPremultiplied(self)

getRenderPremultiplyBgColor(self)

isSelectedForImport(self)

init(self, renderPass, renderLayer)
(Constructor)