DbScript
Public Slots | Public Member Functions | Properties | Private Member Functions | Private Attributes | Friends | List of all members
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...

#include <scriptrendervector.h>

Inheritance diagram for RenderData:
Inheritance graph
[legend]
Collaboration diagram for RenderData:
Collaboration graph
[legend]

Public Slots

String toString (bool verbose) 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
 

Private Member Functions

void setid (int)
 
void setpriority (int)
 
void setstate (const String &name)
 
void setdate (const String &name)
 
void setmachine (const String &name)
 
void setuser (const String &name)
 
void settime (const String &name)
 

Private Attributes

String _jobName
 
String _sceneName
 
int _fromFrame
 
int _toFrame
 
bool _debug
 
bool _chunk
 
int _chunkSize
 
String _version
 
String _camera
 
String _resolution
 
bool _fieldComposite
 
bool _addPullDown
 
bool _autoCombine
 
bool _secondFieldFirst
 
int _id
 
String _state
 
int _priority
 
String _date
 
String _machine
 
String _user
 
String _time
 
bool _quicktime
 

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 ( const String &  jobName,
const String &  sceneName,
QObject *   
)
RenderData::~RenderData ( )

Member Function Documentation

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

Friends And Related Function Documentation

friend class ControlCentre
friend

Member Data Documentation

bool RenderData::_addPullDown
private
bool RenderData::_autoCombine
private
String RenderData::_camera
private
bool RenderData::_chunk
private
int RenderData::_chunkSize
private
String RenderData::_date
private
bool RenderData::_debug
private
bool RenderData::_fieldComposite
private
int RenderData::_fromFrame
private
int RenderData::_id
private
String RenderData::_jobName
private
String RenderData::_machine
private
int RenderData::_priority
private
bool RenderData::_quicktime
private
String RenderData::_resolution
private
String RenderData::_sceneName
private
bool RenderData::_secondFieldFirst
private
String RenderData::_state
private
String RenderData::_time
private
int RenderData::_toFrame
private
String RenderData::_user
private
String RenderData::_version
private

Property Documentation

bool RenderData::addPullDown
readwriteprivate
bool RenderData::autoCombine
readwriteprivate
String RenderData::camera
readwriteprivate

which camera in the scene

bool RenderData::chunk
readwriteprivate
int RenderData::chunkSize
readwriteprivate
String RenderData::date
readprivate
bool RenderData::debug
readwriteprivate
bool RenderData::fieldComposite
readwriteprivate
int RenderData::fromFrame
readwriteprivate
int RenderData::id
readprivate

job id in queue

String RenderData::jobName
readprivate
String RenderData::machine
readprivate
int RenderData::priority
readprivate

priority in queue

bool RenderData::quicktimeAfterChunk
readwriteprivate
String RenderData::resolution
readwriteprivate

which resolution to render at

String RenderData::sceneName
readprivate
bool RenderData::secondFieldFirst
readwriteprivate
String RenderData::state
readprivate

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

String RenderData::time
readprivate
int RenderData::toFrame
readwriteprivate
String RenderData::user
readprivate
String RenderData::version
readwriteprivate

which scene version


The documentation for this class was generated from the following file: