Control Center
Scripting Interface Documentation
RenderData Class Reference

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) 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, QObject *)
 
 ~RenderData ()
 
String jobName () const
 
String sceneName () const
 
int fromFrame () const
 
void setfromFrame (int)
 
int toFrame () const
 
void settoFrame (int)
 
bool debug () const
 
void setdebug (bool p)
 
bool chunk () const
 
void setchunk (bool p)
 
int chunkSize () const
 
void setchunkSize (int p)
 
String version () const
 
void setversion (const String &name)
 
String camera () const
 
void setcamera (const String &name)
 
String resolution () const
 
void setresolution (const String &name)
 
bool fieldComposite () const
 
void setfieldComposite (bool p)
 
bool addPullDown () const
 
void setaddPullDown (bool p)
 
bool autoCombine () const
 
void setautoCombine (bool p)
 
bool secondFieldFirst () const
 
void setsecondFieldFirst (bool p)
 
int id () const
 
int priority () const
 
String state () const
 
String machine () const
 
String time () const
 
String user () const
 
String date () const
 
bool quicktimeAfterChunk () const
 
void setQuicktimeAfterChunk (bool b)
 

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
 
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
 
bool quicktimeAfterChunk
 

Friends

class ControlCentre
 

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 that 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,
QObject *   
)

◆ ~RenderData()

RenderData::~RenderData ( )

Member Function Documentation

◆ addPullDown()

bool RenderData::addPullDown ( ) const

◆ autoCombine()

bool RenderData::autoCombine ( ) const

◆ camera()

String RenderData::camera ( ) const

◆ chunk()

bool RenderData::chunk ( ) const

◆ chunkSize()

int RenderData::chunkSize ( ) const

◆ date()

String RenderData::date ( ) const

◆ debug()

bool RenderData::debug ( ) const

◆ fieldComposite()

bool RenderData::fieldComposite ( ) const

◆ fromFrame()

int RenderData::fromFrame ( ) const

◆ id()

int RenderData::id ( ) const

◆ jobName()

String RenderData::jobName ( ) const

◆ machine()

String RenderData::machine ( ) const

◆ priority()

int RenderData::priority ( ) const

◆ quicktimeAfterChunk()

bool RenderData::quicktimeAfterChunk ( ) const

◆ resolution()

String RenderData::resolution ( ) const

◆ sceneName()

String RenderData::sceneName ( ) const

◆ secondFieldFirst()

bool RenderData::secondFieldFirst ( ) const

◆ setaddPullDown()

void RenderData::setaddPullDown ( bool  p)

◆ setautoCombine()

void RenderData::setautoCombine ( bool  p)

◆ setcamera()

void RenderData::setcamera ( const String &  name)

◆ setchunk()

void RenderData::setchunk ( bool  p)

◆ setchunkSize()

void RenderData::setchunkSize ( int  p)

◆ setdebug()

void RenderData::setdebug ( bool  p)

◆ setfieldComposite()

void RenderData::setfieldComposite ( bool  p)

◆ setfromFrame()

void RenderData::setfromFrame ( int  )

◆ setQuicktimeAfterChunk()

void RenderData::setQuicktimeAfterChunk ( bool  b)

◆ setresolution()

void RenderData::setresolution ( const String &  name)

◆ setsecondFieldFirst()

void RenderData::setsecondFieldFirst ( bool  p)

◆ settoFrame()

void RenderData::settoFrame ( int  )

◆ setversion()

void RenderData::setversion ( const String &  name)

◆ state()

String RenderData::state ( ) const

◆ time()

String RenderData::time ( ) const

◆ toFrame()

int RenderData::toFrame ( ) const

◆ toString [1/2]

String RenderData::toString ( bool  verbose) const
slot

Print out details of a render job.

Parameters
verboseif 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

◆ user()

String RenderData::user ( ) const

◆ version()

String RenderData::version ( ) const

Friends And Related Function Documentation

◆ ControlCentre

friend class ControlCentre
friend

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

◆ 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

◆ 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