ID 218439 - RenderManager/RenderCore: StartRender(): Corrections for docstring

Follow

Problem Summary:
There are some fixes needed in the StartRender docstring:
 
  • nodeList argument only accepts a list of NodegraphAPI.Node instances
  • portList argument  only accepts a list of NodegraphAPI.Port instances
 
Steps to reproduce:
1) Open the aovs_prman.katana example project
2) Run the following in a Python tab and note the various errors that occur in each call to StartRender, despite being specified as valid in the docstring:
node = NodegraphAPI.GetNode('Render_prman')# nodeList does not support a list of strRenderManager.StartRender("diskRender", nodeList=["Render_prman"])# portList does not support a list of str RenderManager.StartRender("diskRender", node=node, portList=["P_pass"])# portList does not support a list of integersRenderManager.StartRender("diskRender", node=node, portList=[1])
 
Also note that the following will work, despite not being specified in the docstring
node = NodegraphAPI.GetNode('Render_prman')port = node.getOutputPort("P_pass")RenderManager.StartRender("diskRender", node=node, portList=[port])

 
Sets up and renders the scene from the passed nodes.
 
@type renderMethodName: C{str}
@type node: C{NodegraphAPI.Node}
@type port: C{NodegraphAPI.Port}
@type nodeList: C{list} of C{NodegraphAPI.Node} or C{str}
@type nodeList: C{list} of C{NodegraphAPI.Node}
@type portList: C{list} of C{int} or C{str}
@type portList: C{list} of C{NodegraphAPI.Port}
@type serialDiskRenderNodeList: C{list} of C{str}
@type views: C{list} of views
@type settings: C{RenderingSettings}
@param renderMethodName: The type of render to perform.
@param node: The node to render from.
@param port: The Port to render from.
@param nodeList: A list of nodes or node names to render from.
@param nodeList: A list of nodes to render from.
@param portList: A list of port indices or names to render from that correspond
to the matching nodes from C{nodeList}.
@param portList: A list of ports to render from that correspond
to the matching nodes from C{nodeList}.
@param serialDiskRenderNodeList: A list of nodes that should be disk rendered
as dependencies of render nodes.
@param views: A list of views.
@param settings: The C{RenderingSettings} instance to use.
@return: The list of render outputs.

    We're sorry to hear that

    Please tell us why