RibGen

class guerilla.RibGen

Bases: object

The Rib generator interface

createpostrenderjob()

Create the post render job

Returns:The post render job Return type:scriptjob

createprerenderjob()

Create the pre render job

Returns:The pre render job Return type:scriptjob

createrenderjobs()

Create the render jobs

Returns:The list of render jobs Return type:{scriptjob}

createribgenjob(frames)

Create the rib generation job

Parameters:frames ({int}) – The list of frames to rib gen Returns:The post render job Return type:scriptjob

dumpjobs()

Prompts the jobs to generate to the output

generatejobframedata(job, frame)

Generate the job data for a given frame

Parameters:

• job (scriptjob) – The job to generate
• frame (int) – The frame index to generate

generatejobscript(job)

Generate the job lua script for a given job

Parameters:job (scriptjob) – The job to generate

getRibFile(ribtype, expandframe=None)

Get the actual rib file name for the given rib type

Parameters:

• ribtype (str) – The rib type
• expandframe (bool) – Expand the frame number

Returns:

The rib file name for this rib type

Return type:

str

startribgen()

Initiate the rib generation process

stopribgen()

Terminate the rib generation process

submit()

Submit rendering jobs to the renderfarm interface

writebackup()

Write the document backup files for each render layer

writeframedata()

Write all frames data

writescripts()

Write all the necessary jobs lua scripts