rrGlobal Enumerations

executeJobType Class

class rrGlobal.executeJobType

ID	Name	Description
0	none	default job
1	once	Execute this job once.
2	onceEachClient	Execute this job on each client.
3	perFrame	Execute this job once per frame.

logLvL Class

class rrGlobal.logLvL

a number can be used instead of the enumeration. The IDs will not change with any RR update.

ID	Name	Description
0	critical	Critical messages will force the RR application to restart or terminate themselves.
1	error	Error messages are important for the execution of RR and should never fail. All RR error messages are collected in a seperate error log RR / sub / log / _ERROR.txt for the rrAdminand /or rrSupport to fix issues.
2	warning	Warning messages will have a ‘WRN - ‘ in front to identify them faster in logfiles.
3	info	default messages (At the moment there is no difference with progress besides for the message box)
4	progress	default messages (At the moment there is no difference with info besides for the message box)
10	debug	Debug messages are ignored by default. They are shown if You have called debugEnable() The RR application is not running in debug mode.

pluginReturn Class

class rrGlobal.pluginReturn

ID	Name	Description
0	unknownError	The default value if nothing was set.
1	successful	Successful execution.
2	fileNotFound	File to read was not found.
3	fileFailedToOpen	Failed to open the file.
4	unsupportedFormat	This plugin does not support this file format. In such a case the next plugin that can open this file extension is executed.
5	RRDataVersionConflict	Plugin is not compatible with the current version of Royal Render.
6	CError	Unhandled C Error.
7	memError	Memory allocation failed.
8	pluginFileMissing	Plugin is missing
9	pluginLoadError	Unable to load Plugin
10	successfulIgnoreNoJobs	The execution was successful, but the plugin has not created a job. And this should not be seen as an error.
11	otherError	Any other error.
12	wrongFileSize	Wrong filesize
13	noImageDimensions	no image dimensions set.
14	dataError	Data Error.
15	imageDimensionsToLarge	Image dimensions larger than buffer.
16	requireFullLoad	Require full load.
17	noPluginforFileType	No plugin for this file type.
18	pythonError	Python Error.
19	fileSizeToSmall	The file size is smaller than it should be. Indicates that the file was not completely written.
20	debugCompile	Debug compile mismatch.
21	isPlaceHolderFile	Image is a placeholder file.
22	fileFailedToSave	Failed to save file.
23	successfulRetryLoad	The execution was not an error. But the main app should execute this plugin again.
24	fileBuffertoSmall	Memory buffer to small.
25	noImageOutput	No image output set in scene file.
26	absolutePathsRequired	The scene parser was not able to create a job as some scene settings do not use an absolute path. And this plugin was not able to resolve the relative path OR it will not be possible to render the scene with relative paths.
27	loadEndOfFileOnly	Load end of file only.
28	successfulPython	Python execution was successful

_ClientCommand Class

class rrGlobal._ClientCommand

ID	Name	Description
0	cNone	None
1	cAbortUNKNOWN	Abort
2	cEnable	Enable
3	cDisable	Disable
4	cAllowLittle	Allow little jobs
5	cForbitLittle	Forbit little jobs
6	cUseWorking	Respect working hours
7	cIgnoreWorking	Ignore working hours
8	cRestartClientExe	Restart client executable
9	cWOL	Wake up On Lan
10	cRestartMachine	Restart machine
11	cRestartMachineForce	Force restart machine
12	cShutdownMachine	Shutdown machine
13	cShutdownMachineForce	Force shutdown machine
14	cWait15	Wait
15	cAbortDisable	Abort & Disable
16	cIgnoreCPU	Ignore current CPU usage
17	cReserveCPUInteractive	Reserve CPU for interactive user
18	cUseCPUInteractive	No ‘Reserve CPU for interactive user’
19	cShutdownClientAndService	Shutdown client and Service
20	cReloadClientConfig	Reload client config
21	cReloadUserConfig	Reload user config
22	cReloadGlobalConfig	Reload global config
23	cReloadAllConfig	Reload all config
24	cConfigSearchForApplications	Search for render applications
25	cUpdateServiceCfg	Update service config
26	cInstallPlugins	(re-)Install Artist Workstation (rrSubmit Plugins, …)
27	cInstallService	(re-)Install rrService
28	cShutdownClient	Shutdown rrClient
29	cAbortOnReset	Abort on Reset
30	cConfigSearchForApplicationsDelete_deprecated	Deprecated - Clear & renew render apps
31	cTimeSync	Sync time with rrServer
32	cShowProcessTree	Show process tree
33	cAbortAfterFrame	Abort after frame
34	cAbortAfterFrameDisable	Abort after Frame & Disable
35	cInstallAll	(re-)Install All (rrService, Plugins, Startmenu, …)
36	cDoSpeedTest	Speedtest
37	cDevDebug	Dev Debug
38	cAbortNDeassign	Abort & Deassign All
39	cAbortReservedClient	Abort - Reserved Client
40	cAbortWorkinghours	Abort - Working Hours
41	cAbortHighPriority	Abort - High Priority Job
42	cAbortrrControl	Abort - rrControl
43	cAbortAverage	Abort - Averaging
44	cAbortLicenseBlock	Abort - Free License
45	cAbortLocalMachine	Abort - Local Artist
46	cAbortSystemMem	Abort - System memory low
47	cAbortFreeze	Abort - renderer frozen
48	cAbortHighCPU	Abort - high artist CPU usage
49	cAbortFrameTime	Abort - max frame time exceeded
50	cAbortJobDelete	Abort - Job Deleted
51	cAbortJobDisabled	Abort - Job Disabled
52	cResetIdleTime	Reset idle time
53	cCommandLine	Custom Commandline
	Required to set the param string of _rrTCP.clientSendCommand(). The client will create the batch file RR_LocalData/_command.bat. It executes the command and writes the output into RR_LocalData/_command.txt. If you want to keep your log output, you should redirect it to a file via your commandline. For example: myCommand 1>/log_path/MyCommand_<LocalHost>.txt 2>/log_path/MyCommand_<LocalHost>_error.txt myCommand 1>/log_path/MyCommand_<LocalHost>.txt 2>&1 You can use all variables (like <LocalHost>) from render configs, as long as they are not job specific. The command buffer can only take up to 500 letters.”,
54	cAbortLogError	Abort - Error found in render log
55	cRestartMachineForce6Hours	Force restart machine (6 hours)
56	cUnInstallAll	Un-Install All (rrService, Plugins, Startmenu, …)
57	cAbortAfterFrameShutdown	Abort after Frame & Shutdown
58	cRestartMachineAfterRender	Restart machine after render segment finished
59	cShutdownMachineAfterRender	Shutdown machine after render segment finished
60	cCommandLineArtist	Custom Commandline for artist
61	cRestartClientExeAfterRender	Restart client executable after render segment finished
62	cAcceptMyJobsWH	Accept logged user’s jobs during Working Hours
63	cRefuseMyJobsWH	No exception for logged user’s jobs during Working Hours

genUIType Class

class rrGlobal.genUIType

ID	Name	Description
1	button	A default button. After the dialog is closed, you can check if the button was pressed.
2	closeButton	Same as button, but it closes the dialog as well.
3	lineEdit	A line editor.
4	checkBox	A check box
5	spin	A spin box to enter numbers
6	browseFile	A generic browse file dialog.
7	browseDir	A generic browse directory dialog.
8	label	A text label
9	dropdown	A Dropdown list/ Combo Box.
10	layoutH	Horizontal Layout. Layouts are used to group multiple objects. (blue boxes in example screenshot)
11	layoutV	Vertical Layout. Layouts are used to group multiple objects. (blue boxes in example screenshot)
12	spacerH	Horizontal Spacer. A spacer is used to move everything else in a layout aside. (blue springs in example screenshot)
13	spacerV	Vertical Spacer. A spacer is used to move everything else in a layout aside. (blue springs in example screenshot)