Module cmdrangeFrontEnd

source code

A convenience class for building Qube command range (pyCmdrange) jobs.  

Jobs of this type are typically used for iterating over a range of frame numbers, and have an agenda
comprised of integers, floats, or in the case of a chunkSize > 1, a string like "1-10".

The command line is scanned for several QB_* tokens; these tokens are replace at runtime with the
current frame number(s), step-frame values, etc.

The jobtype has an optional 'padding' value for padding the numeric values (all except QB_FRAME_RANGE)

The tokens for this jobtype are:

    QB_FRAME_NUMBER     - the current frame number, also the first frame number in the current frame chunk if chunkSize > 1
    QB_FRAME_START      - the first frame number in the chunk
    QB_FRAME_END        - the last frame number in the chunk
    QB_FRAME_STEP       - the "step" or "by" value, eg, "render on 2's"
    QB_FRAME_RANGE      - the frame range for the chunk, NOT the entire job

Examples:

    Command: render -s QB_FRAME_START -e QB_FRAME_END -b QB_FRAME_STEP 

    Render a sequence from frame 1 -> 100, no chunks (chunkSize=1), padding set to 3

        When rendering frame 12:

            QB_FRAME_NUMBER 12
            QB_FRAME_START  12
            QB_FRAME_END    12
            QB_FRAME_STEP   1
            QB_FRAME_RANGE  12

        Command evaluates to: render -s 012 -e 012 -b 1
    

    Render a sequence from frame 1 -> 100, in 25-frame chunks, padding set to 1

        The second chunk will be "26-50".  At runtime, the QB_* tokens evaluate as:

            QB_FRAME_NUMBER 26
            QB_FRAME_START  26
            QB_FRAME_END    50
            QB_FRAME_STEP   1
            QB_FRAME_RANGE  26-50

        Command evaluates to: render -s 26 -e 50 -b 1