renderSettings

Go to: Synopsis. Return value. Keywords. Flags. Python examples.

Synopsis

renderSettings([camera=string], [customTokenString=string], [firstImageName=boolean], [fullPath=boolean], [fullPathTemp=boolean], [genericFrameImageName=string], [imageGenericName=boolean], [lastImageName=boolean], [layer=string], [leaveUnmatchedTokens=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

renderSettings is NOT undoable, NOT queryable, and NOT editable.

Return value

Keywords

Flags

Long name (short name)	Argument types	Properties
firstImageName(fin)	boolean
Returns the first image name
lastImageName(lin)	boolean
Returns the last image name
imageGenericName(ign)	boolean
Returns the image generic name
genericFrameImageName(gin)	string
Returns the generic frame image name with the custom specified frame index token
fullPath(fp)	boolean
Returns the full path for the image using the current project. Use with firstImageName, lastImageName, or genericFrameImageName.
fullPathTemp(fpt)	boolean
Returns the full path for the preview render of the image using the current project. Use with firstImageName, lastImageName, or genericFrameImageName.
layer(lyr)	string
Specify a render layer name that you want to replace the current render layer
camera(cam)	string
Specify a camera that you want to replace the current renderable camera
customTokenString(cts)	string
Specify a custom key-value string to use to replace custom tokens in the file name. Use with firstImageName or lastImageName. Basic tokens (Scene, Layer, RenderLayer, Camera, Version, Extension) will be automatically expanded. Any other tokens must be specified here to be expanded. The format of the string is a space separated list of tokens-value pairs. For example, if the file name string is "myFile_<myToken>_<myOtherToken>_v" then the argument to this flag string should take the form "myToken=myTokenValue myOtherToken=myOtherTokenValue".
leaveUnmatchedTokens(lut)	boolean
Do not remove unmatched tokens from the name string. Use with firstImageName or lastImageName.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Get the name of the first and last image for the current layer
fl = cmds.renderSettings(firstImageName=True, lastImageName=True)
print( 'First image is '+fl[0] )
# This is the empty string if the scene is not set for animation
if fl[1] == '':
    print('Not rendering animation');
else:
    print( 'Last image is '+fl[1] )