Package autodesk_toxik :: Module precompmodule :: Class RenderLayer

Class RenderLayer

   object --+    
            |    
PrecompObject --+
                |
               RenderLayer

Class representing a render layer, i.e. an assembly of layer passes rendered through a specific camera. In other words, a RenderLayer instance is bound to a specific RenderCamera instance.

Nested Classes
	BlendMode Class enumerating possible blend modes between render layers.

Instance Methods

__init__(self, renderLayer, camera)
Constructor from a precomp module RenderLayer instance and a RenderCamera instance.

convertBlendMode(self, blendMode)
Converts a blend mode returned by the precomp module RenderLayer.getBlendMode() method to a tuple (RenderLayer.

RenderCamera

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

Scene

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

str

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

str

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

int

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

str

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

str

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

int

getCompositingOrder(self)
Returns: An int that defines the absolute position (1-based) of the render layer in the layer stack.

tuple

getBlendMode(self)
Returns: The blend mode used to comp this render layer with the render layer beneath it.

int

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

int

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

float

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

int

getRenderNbChannels(self)
Returns: The default number of render channels used for this layer, as an integer.

int

getRenderDepth(self)
Returns: The default render bit depth used for this layer, as an integer.

str

getTemplateFilePath(self)
Returns: The absolute path (in unicode) to a ".txcomposition" file to use as a template to create the render layer comp, or None.

bool

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

[RenderPass]

getRenderPasses(self)
Returns: A list of render passes (RenderPass instances) in this render layer which are contributing to a render from a specific camera.

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, renderLayer, camera)
(Constructor)

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

Parameters:

renderLayer (RenderLayer)
camera (RenderCamera)

Overrides: object.__init__

convertBlendMode(self, blendMode)

Converts a blend mode returned by the precomp module RenderLayer.getBlendMode() method to a tuple (RenderLayer.BlendMode, blend mode name)

getRenderCamera(self)

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

getScene(self)

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

getName(self)

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

getAnchor(self)

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

getVersion(self)

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

getDescription(self)

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

getNote(self)

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

getCompositingOrder(self)

Returns: int: An int that defines the absolute position (1-based) of the render layer in the layer stack. A smaller display order means the render layer is toward the bottom of the stack (on the back plate).

getBlendMode(self)

Returns: tuple

The blend mode used to comp this render layer with the render layer beneath it. Returns one of the BlendMode class members.

*** The following is specific to the Composite precompmodule interface. ***

Return value is actually a tuple (toxikBlendModeValue, blendModeName).

getRenderWidth(self)

Returns: int: The render resolution width used by this layer, as an integer.

getRenderHeight(self)

Returns: int: The render resolution height used by this layer, as an integer.

getRenderPixelRatio(self)

Returns: float: The render pixel ratio used by this layer, as a float.

getRenderNbChannels(self)

Returns: int: The default number of render channels used for this layer, as an integer. Supported number of channels are 1, 3 and 4.

getRenderDepth(self)

Returns: int: The default render bit depth used for this layer, as an integer. Supported depth values are 8, 16 and 32.

getTemplateFilePath(self)

Returns: str: The absolute path (in unicode) to a ".txcomposition" file to use as a template to create the render layer comp, or None. Note that render layers produced by cameras of a camera set should provide the same template.

isSelectedForImport(self)

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

getRenderPasses(self)

Returns: [RenderPass]: A list of render passes (RenderPass instances) in this render layer which are contributing to a render from a specific camera.

Class RenderLayer

__init__(self, renderLayer, camera) (Constructor)

convertBlendMode(self, blendMode)

getRenderCamera(self)

getScene(self)

getName(self)

getAnchor(self)

getVersion(self)

getDescription(self)

getNote(self)

getCompositingOrder(self)

getBlendMode(self)

getRenderWidth(self)

getRenderHeight(self)

getRenderPixelRatio(self)

getRenderNbChannels(self)

getRenderDepth(self)

getTemplateFilePath(self)

isSelectedForImport(self)

getRenderPasses(self)

init(self, renderLayer, camera)
(Constructor)