Scene Class Reference

The Scene defines the scene parameters. The Scene object can be instantiated in the scripting environment. A list of scenes can be retrieved by calling ControlCentre.scenes( job ). A new scene may be added by the following ( Note only ControlCentre modifies the database ) More...

#include <scriptojbects.h>

Inheritance diagram for Scene:

Collaboration diagram for Scene:

Public Slots
String	toString (bool verbose) const
	Print out scene paramaters. More...

Public Member Functions
	Scene (const String &jobName, const String &name, QObject *)
	~Scene ()
String	name () const
String	jobName () const
String	fileSystem () const
String	approvalStage () const
int	priority () const
int	frames () const
int	pencilTest () const
int	paperSize () const
double	scanSize () const
String	tdName () const
String	atdName () const
int	currentVer () const
String	path () const
bool	checkoutLock () const
String	checkoutUser () const
int	checkoutDate () const
void	setFileSystem (const String &fileSystem)
void	setTdname (const String &name)
void	setPriority (int priority)
void	setFrames (int frames)
void	setAtdname (const String &name)
void	setApprovalStage (const String &approvalStage)
void	setCheckoutLock (bool l)
void	setCheckoutUser (String &u)
void	setCheckoutDate (int d)
void	setPath (const String &name)

Properties
String	name
	name of scene More...
String	jobName
	name of job that contains scene More...
String	fileSystem
	filesystem where it resides More...
String	approvalStage
int	priority
	between 1 and 10 More...
int	frames
	length of scene on last version save More...
int	pencilTest
int	paperSize
double	scanSize
String	tdName
	technical director ( user name ) More...
String	atdName
	assistant technical director ( user name ) More...
int	currentVer
	scene version that is marked current More...
String	path
	real path to scene More...
bool	checkoutLock
	is the scene checked-out More...
String	checkoutUser
	user who has scene checked-out More...
int	checkoutDate
	the date the scene was checked-out More...

Private Member Functions
void	setName (const String &n)
void	setPencilTest (int p)
void	setPaperSize (int p)
void	setScanSize (double p)
void	setCurrentVer (int p)

Private Attributes
String	_jobName
String	_name
String	_fileSystem
String	_path
String	_approvalStage
int	_priority
int	_frames
int	_pencilTest
int	_paperSize
double	_scanSize
String	_tdName
String	_atdName
int	_currentVer
int	_checkoutDate
bool	_checkoutLock
String	_checkoutUser

Friends
class	ControlCentre

Detailed Description

The Scene defines the scene parameters. The Scene object can be instantiated in the scripting environment. A list of scenes can be retrieved by calling ControlCentre.scenes( job ). A new scene may be added by the following ( Note only ControlCentre modifies the database )

var scene = new Scene(job.name, "TestScene");
 scene.fileSystem = "/USADATA";
ControlCentre.addScene(scene, AddPositionType.ADD_AT_TOP);

Constructor & Destructor Documentation

Scene::Scene	(	const String &	jobName,
		const String &	name,
		QObject *
	)

Scene::~Scene

(

)

Member Function Documentation

String Scene::approvalStage

(

)

const

String Scene::atdName

(

)

const

int Scene::checkoutDate

(

)

const

bool Scene::checkoutLock

(

)

const

String Scene::checkoutUser

(

)

const

int Scene::currentVer

(

)

const

String Scene::fileSystem

(

)

const

int Scene::frames

(

)

const

String Scene::jobName

(

)

const

String Scene::name

(

)

const

int Scene::paperSize

(

)

const

String Scene::path

(

)

const

int Scene::pencilTest

(

)

const

int Scene::priority

(

)

const

double Scene::scanSize

(

)

const

void Scene::setApprovalStage

(

const String &

approvalStage

)

void Scene::setAtdname

(

const String &

name

)

void Scene::setCheckoutDate

(

int

d

)

void Scene::setCheckoutLock

(

bool

l

)

void Scene::setCheckoutUser

(

String &

u

)

void Scene::setCurrentVer ( int  p )

private

void Scene::setFileSystem

(

const String &

fileSystem

)

void Scene::setFrames

(

int

frames

)

void Scene::setName ( const String &  n )

private

void Scene::setPaperSize ( int  p )

private

void Scene::setPath

(

const String &

name

)

void Scene::setPencilTest ( int  p )

private

void Scene::setPriority

(

int

priority

)

void Scene::setScanSize ( double  p )

private

void Scene::setTdname

(

const String &

name

)

String Scene::tdName

(

)

const

String Scene::toString ( bool  verbose ) const

slot

Print out scene paramaters.

Parameters

verbose

if false, print out only name, fileSystem,priority,length and current version

Friends And Related Function Documentation

friend class ControlCentre

friend

Member Data Documentation

String Scene::_approvalStage

private

String Scene::_atdName

private

int Scene::_checkoutDate

private

bool Scene::_checkoutLock

private

String Scene::_checkoutUser

private

int Scene::_currentVer

private

String Scene::_fileSystem

private

int Scene::_frames

private

String Scene::_jobName

private

String Scene::_name

private

int Scene::_paperSize

private

String Scene::_path

private

int Scene::_pencilTest

private

int Scene::_priority

private

double Scene::_scanSize

private

String Scene::_tdName

private

Property Documentation

String Scene::approvalStage

readprivate

String Scene::atdName

readprivate

assistant technical director ( user name )

int Scene::checkoutDate

readprivate

the date the scene was checked-out

bool Scene::checkoutLock

readprivate

is the scene checked-out

String Scene::checkoutUser

readprivate

user who has scene checked-out

int Scene::currentVer

readprivate

scene version that is marked current

String Scene::fileSystem

readwriteprivate

filesystem where it resides

int Scene::frames

readprivate

length of scene on last version save

String Scene::jobName

readprivate

name of job that contains scene

String Scene::name

readprivate

name of scene

int Scene::paperSize

readprivate

String Scene::path

readprivate

real path to scene

int Scene::pencilTest

readprivate

int Scene::priority

readprivate

between 1 and 10

double Scene::scanSize

readprivate

String Scene::tdName

readprivate

technical director ( user name )

---

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

• dox_files/scriptojbects.h