RibGenΒΆ

class RibGen

The Rib generator interface

Members

Methods:

scriptjob postrender createpostrenderjob ( ) Create the post render job
scriptjob prerender createprerenderjob ( ) Create the pre render job
{scriptjob} jobs createrenderjobs ( ) Create the render jobs
scriptjob ribgen createribgenjob ( {int} frames ) Create the rib generation job
nil dumpjobs ( ) Prompts the jobs to generate to the output
nil generatejobframedata ( scriptjob job , int frame ) Generate the job data for a given frame
nil generatejobscript ( scriptjob job ) Generate the job lua script for a given job
string filename getRibFile ( string ribtype , [ bool expandframe ] ) Get the actual rib file name for the given rib type
nil startribgen ( ) Initiate the rib generation process
nil stopribgen ( ) Terminate the rib generation process
nil submit ( ) Submit rendering jobs to the renderfarm interface
nil writebackup ( ) Write the document backup files for each render layer
nil writeframedata ( ) Write all frames data
nil writescripts ( ) Write all the necessary jobs lua scripts

Documentation

scriptjob postrender createpostrenderjob ( )

Create the post render job

Return:

  • postrender The post render job

scriptjob prerender createprerenderjob ( )

Create the pre render job

Return:

  • prerender The pre render job

{scriptjob} jobs createrenderjobs ( )

Create the render jobs

Return:

  • jobs The list of render jobs

scriptjob ribgen createribgenjob ( {int} frames )

Create the rib generation job

Arguments:

  • frames The list of frames to rib gen

Return:

  • ribgen The post render job

nil dumpjobs ( )

Prompts the jobs to generate to the output

nil generatejobframedata ( scriptjob job , int frame )

Generate the job data for a given frame

Arguments:

  • job The job to generate
  • frame The frame index to generate

nil generatejobscript ( scriptjob job )

Generate the job lua script for a given job

Arguments:

  • job The job to generate

string filename getRibFile ( string ribtype , [ bool expandframe ] )

Get the actual rib file name for the given rib type

Arguments:

  • ribtype The rib type
  • expandframe Expand the frame number

Return:

  • filename The rib file name for this rib type

nil startribgen ( )

Initiate the rib generation process

nil stopribgen ( )

Terminate the rib generation process

nil submit ( )

Submit rendering jobs to the renderfarm interface

nil writebackup ( )

Write the document backup files for each render layer

nil writeframedata ( )

Write all frames data

nil writescripts ( )

Write all the necessary jobs lua scripts