Parameter:
Type |
Name |
Description |
int16 |
structureIDBasics |
MagicID/Version of the class |
int16 |
variablesIDBasics |
MagicID/Version of the class |
int16 |
structureIDSend |
MagicID/Version of the class |
int16 |
variablesIDSend |
MagicID/Version of the class |
byte |
rrJobOS |
OS of the texture paths inside this rrJob class. 1: Windows, 2: Linux, 3: OSX |
byte |
sceneOS |
OS the scene was created on (Texture paths inside the file). 1: Windows, 2: Linux, 3: OSX |
renderApp |
Render application and Renderer information. See Class _RenderAppBasic |
|
rrString |
sceneName |
|
rrString |
sceneDatabaseDir |
|
rrString |
camera |
|
rrString |
layer |
|
rrString |
channel |
|
rrString |
requiredLicenses |
|
rrString |
imageDir |
|
rrString |
imageFileName |
|
rrString |
imageFileNameVariables |
Some render jobs render multiple layers/passes at once. The render application requires these parts of the file name as variables. E.g. <layer> |
rrString |
imageExtension |
|
char |
imagePreNumberLetter |
|
byte |
imageFramePadding |
|
int16 |
imageWidth |
|
int16 |
imageHeight |
|
bool |
imageSingleOutputFile |
|
byte |
imageMulti |
Number of tiles for a frame. |
rrString |
imageFormatOverride |
If used, then the image format is not the same as set in the scene. RR should override the image format at render time. |
rrString |
imageStereoL |
|
rrString |
imageStereoR |
|
rrString |
localTexturesFile |
|
Uint64 |
ID |
|
byte |
preID |
This variable is used for jobs before submission only! Please see function IDpre() if you want to get the variable once the job was send. A value between 0 and 255. Each job gets the Pre ID attached as small letter to the main ID. It is the the small letter at the end of the ID. |
byte |
maxWaitForPreID |
maximum number of waitForPreIDs. See functions section. |
bool |
uiIsChecked |
|
rrString |
shotgunID |
ShotgunID of the Scene/Sequence. Usually retrieved at submission by an onsubmission script. |
double |
seqStart |
|
double |
seqEnd |
|
double |
seqStep |
|
double |
seqFileOffset |
|
rrString |
seqFrameSet |
- not used - |
bool |
seqIsFloatFrames |
- not used - |
rrString |
additionalCommandlineParam |
|
Functions:
Return type |
Name |
Description |
unsigned int 64 |
IDmain() |
A job ID contains a main ID and a preID. The preID is shown as small letter at the end of the string ID {D5Ca}. If multiple jobs are send at the same time (e.g. same .xml file), they all have the same main ID and increasing pre IDs. |
byte |
IDpre() |
see IDmain() |
int |
waitForPreID(int index) |
This is only used for jobs at submission. Get the waitForPreID of this job. A job has up to 20 waitforIDs. When the job is received by the server, the server checks for other jobs send from the machine in the last 15 minutes. The server then gets the latest job with the same PreID as a WaitForPreID of this job, then this jobs waits for the other job. Index ranges from 0 to maxWaitForPreID. Maximum is 20. |
rrString |
waitForPreID_set(int index, quint8 value ) |
Set the waitForPreID of this job. A job has up to 20 waitforIDs. You have to update maxWaitForPreID as well. |
int |
channelCount() |
Returns the number of render channels. |
rrString |
channelFileName(int index) |
Get the filename of the render channel. Index range is 0-100. |
rrString |
channelExtension(int index) |
Get the extension of the render channel. Index range is 0-100. |
|
channel_clear() |
Removes all render channels from the job. |
|
channel_add(rrString filename, extensio ) |
Adds a new render channel to the end of the list. |
|
channel_set(int index, rrString filename, rrString extension ) |
Sets the render channel. Index range is 0-100. |
|
channelFileName_set(int index, rrString value ) |
Set the filename of the render channel. Index range is 0-100. |
|
channelExtension_set(int index, rrString value ) |
Set the extension of the render channel. Index range is 0-100. |
QString |
IDstr() |
Short ID of the job as human readable/rememberable string E.g. {D5Ca} |
QString |
IDstrFull() |
The ID string is a short version of the job ID. It could happen that two jobs have the same short ID. IDstrFull() does not have this issue. |
QString |
sceneDisplayName() |
Removes all extensions and variables from the scene file name and keeps only a few folders in front of the file name. |
QString |
custom_Str(const QString &name) |
Get a custom data item of the job. Each data item has a name and a value. You can save up to 5000 letters. If unicode letters are found in value, then the string takes twice its length in bytes. Reserved names are "UserInfo" and "EnvFile". |
|
customSet_Str(const QString &name,const QString &value) |
Set custom data item. An empty value is not saved. If a data item with name exists, it is overwritten or deleted (if value is empty). |
QString |
custom_UserInfo() |
Same as custom_Str("UserInfo"). UserInfo is displayed in rrControl |
|
customSet_UserInfo(const QString &info) |
Same as customSet_Str("UserInfo"). UserInfo is displayed in rrControl |
int |
customGet_maxIDs() |
The number of custom data items |
QString |
custom_StrByID(const int &id) |
Get custom data item via its id |
|
customSet_StrByID(const int &id,const QString &value) |
Set custom data item via its id |
QString |
custom_NameByID(const int &id) |
Get name of the data item via id |
QString |
custom_AllAsString() |
Returns a string with all custom data items set |
|
custom_ClearAll() |
Deletes all custom data items |
|
check_SplitImageFileInto_DirFileExt(bool percentPadding) |
Splits the imageFileName into imageDir and imageExtension if those two are empty. If ImageDir or imageExtension have a value, then this variable is not changed. The same applies for splitting channelFileNames into file and extension. If imageSingleOutputFile is set, then no imageExtension will be set as there is no frame number in between. If an image padding is recognized, then imageFramePadding is set as well. Supported frame number formats are: %04d (only if percentPadding is set) #### [####] .125. If the file extension indicates a video or audio file, then imageSingleOutputFile is set to True. Note: This function is always executed in rrSubmitter. But you can call it yourself to check the values afterwards. |