RenderData Class Reference

RenderData defines the parameters for a job sent to the rendering queue. More...

Public Slots
String	toString (bool verbose) const
	Print out details of a render job. More...
String	toString () const
	Print out details of a render job. More...

Public Member Functions
	RenderData (const String &jobName, const String &sceneName)
	Defines a render job. More...

Properties
String	jobName
String	sceneName
int	fromFrame
int	toFrame
bool	debug
bool	chunk
int	chunkSize
String	version
	which scene version More...
String	camera
	which camera in the scene More...
String	resolution
	which resolution to render at More...
bool	fieldComposite
bool	addPullDown
bool	autoCombine
bool	secondFieldFirst
bool	dependent
int	id
	job id in queue More...
String	state
	state in queue ( Pending, Processing, Completed or Error ) More...
int	priority
	priority in queue More...
String	date
String	machine
String	user
String	time
String	preRenderScriptFilename
String	preRenderInlineScript
String	postRenderScriptFilename
String	postRenderInlineScript
bool	quicktimeAfterChunk

Detailed Description

RenderData defines the parameters for a job sent to the rendering queue.

The RenderData object can be instantiated in the scripting environment. Use this in ControlCentre.renderScene( renderData)

var renderData = new RenderData( job.name, scene.name);
renderData.fomFrame = 5;
renderData.toFrame = 5;
renderData.version = "1";
renderData.resolution = "HDTV";
ControlCentre.renderScene( renderData );

Note

A call to ControlCentre.getRenderJobs( environment ) will list all render jobs in that environment currently in the render queue.

Constructor & Destructor Documentation

RenderData()

RenderData::RenderData	(	const String &	jobName,
		const String &	sceneName
	)

Defines a render job.

Parameters

jobName	name of job
sceneName	name of scene

Member Function Documentation

toString [1/2]

String RenderData::toString ( bool  verbose ) const

slot

Print out details of a render job.

Parameters

verbose

if false, prints out id, jobname, scene name, version, from and to frames, resolution and state only

toString [2/2]

String RenderData::toString ( ) const

slot

Print out details of a render job.

print out all data related to render job

Property Documentation

addPullDown

bool RenderData::addPullDown

readwrite

autoCombine

bool RenderData::autoCombine

readwrite

camera

String RenderData::camera

readwrite

which camera in the scene

chunk

bool RenderData::chunk

readwrite

chunkSize

int RenderData::chunkSize

readwrite

date

String RenderData::date

read

debug

bool RenderData::debug

readwrite

dependent

bool RenderData::dependent

readwrite

fieldComposite

bool RenderData::fieldComposite

readwrite

fromFrame

int RenderData::fromFrame

readwrite

id

int RenderData::id

read

job id in queue

jobName

String RenderData::jobName

read

machine

String RenderData::machine

read

postRenderInlineScript

String RenderData::postRenderInlineScript

readwrite

postRenderScriptFilename

String RenderData::postRenderScriptFilename

readwrite

preRenderInlineScript

String RenderData::preRenderInlineScript

readwrite

preRenderScriptFilename

String RenderData::preRenderScriptFilename

readwrite

priority

int RenderData::priority

read

priority in queue

quicktimeAfterChunk

bool RenderData::quicktimeAfterChunk

readwrite

resolution

String RenderData::resolution

readwrite

which resolution to render at

sceneName

String RenderData::sceneName

read

secondFieldFirst

bool RenderData::secondFieldFirst

readwrite

state

String RenderData::state

read

state in queue ( Pending, Processing, Completed or Error )

time

String RenderData::time

read

toFrame

int RenderData::toFrame

readwrite

user

String RenderData::user

read

version

String RenderData::version

readwrite

which scene version