ExportData Class Reference

ExportData defines the parameters for a database Export command. The ExportData is an object which is instantiated in the scripting environment. In order to execute an Export action, call ControlCentre.exportScene( exportData). More...

Public Slots
void	setExportDefaults ()
	Set the export defaults, which are database, element, timing and stage. More...
void	setExportAll ()
	Set all export options to true ( audio, database, final, envGroup, jobGroup, sceneGroup, envLibrary,jobLibrary, sceneLibrary, envPalette, jobPalette, scenePalette, other, element, timing, stage and outsideDrawings. More...

Public Member Functions
	ExportData (const String &envName, const String &jobName, const StringList &sceneNames, const String &path, QObject *)
	~ExportData ()
String	envName () const
String	jobName () const
StringList	sceneNames () const
String	path () const
bool	solo () const
void	setsolo (bool priority)
bool	audio () const
void	setaudio (bool priority)
bool	database () const
void	setdatabase (bool priority)
bool	final () const
void	setfinal (bool priority)
bool	envGroup () const
void	setenvGroup (bool priority)
bool	jobGroup () const
void	setjobGroup (bool priority)
bool	sceneGroup () const
void	setsceneGroup (bool priority)
bool	envLibrary () const
void	setenvLibrary (bool priority)
bool	jobLibrary () const
void	setjobLibrary (bool priority)
bool	sceneLibrary () const
void	setsceneLibrary (bool priority)
bool	envPalette () const
void	setenvPalette (bool priority)
bool	jobPalette () const
void	setjobPalette (bool priority)
bool	scenePalette () const
void	setscenePalette (bool priority)
bool	other () const
void	setother (bool priority)
bool	element () const
void	setelement (bool priority)
bool	timing () const
void	settiming (bool priority)
bool	annotation () const
void	setannotation (bool annotation)
bool	stage () const
void	setstage (bool priority)
bool	outsideDrawings () const
void	setoutsideDrawings (bool priority)
bool	hard () const
void	setHard (bool priority)
bool	hardLn () const
void	setHardLn (bool priority)
bool	sym () const
void	setSym (bool priority)
bool	copy () const
void	setCopy (bool priority)
bool	keepValidSym () const
void	setKeepValidSym (bool priority)
bool	ignoreValidSym () const
void	setIgnoreValidSym (bool priority)
bool	resolveSym () const
void	setResolveSym (bool priority)
bool	keepBrokenSym () const
void	setKeepBrokenSym (bool priority)
bool	ignoreBrokenSym () const
void	setIgnoreBrokenSym (bool priority)

Properties
String	envName
String	jobName
String	path
StringList	sceneNames
bool	solo
	export in Animate format, if true, ignores other settings More...
bool	audio
	export the audio folder More...
bool	database
	export the database folder More...
bool	final
	export the final frame folder More...
bool	envGroup
	export the groups at the environment level More...
bool	jobGroup
	export the groups at the job level More...
bool	sceneGroup
	export the groups at the scene level More...
bool	envLibrary
	export the libraries at the environment level More...
bool	jobLibrary
	export the libraries at the job level More...
bool	sceneLibrary
	export the libraries at the scene level More...
bool	envPalette
	export the palettes at the environment level More...
bool	jobPalette
	export the palettes at the job level More...
bool	scenePalette
	export the palettes at the scene level More...
bool	other
	export other ( non-standard ) folders that are at scene level More...
bool	element
	export elements More...
bool	timing
	export timings More...
bool	annotation
	annotation More...
bool	stage
	export stage folder More...
bool	outsideDrawings
	export outside drawings More...
bool	hard
	"Advanced Options" not available for animate which sets copy to true More...
bool	hardLn
	"Advanced Options" not available for animate which sets copy to true More...
bool	sym
	"Advanced Options" not available for animate which sets copy to true More...
bool	copy
	"Advanced Options" not available for animate which sets copy to true More...
bool	keepValidSym
	"Advanced Options" not available for animate which sets copy More...
bool	ignoreValidSym
	"Advanced Options" not available for animate which sets copy More...
bool	resolveSym
	"Advanced Options" not available for animate which sets copy More...
bool	keepBrokenSym
	"Advanced Options" not available for animate which sets copy More...
bool	ignoreBrokenSym
	"Advanced Options" not available for animate which sets copy More...

Detailed Description

ExportData defines the parameters for a database Export command. The ExportData is an object which is instantiated in the scripting environment. In order to execute an Export action, call ControlCentre.exportScene( exportData).

var scenes = []; // Create a list of the scenes to be exported from this job.
scenes.push("scene1");
scenes.push("scene2");

var job = new Job("myEnvName", "myJobName");
var exportData = new ExportData( job.envName, job.name, scenes, "/home/user/testExport");

exportData.setExportDefaults(); // Sets the normal export defaults

// A common alternative would be to call exportData.setExportAll(); which sets everything to true

ControlCentre.exportScene( exportData );

Constructor & Destructor Documentation

ExportData()

ExportData::ExportData	(	const String &	envName,
		const String &	jobName,
		const StringList &	sceneNames,
		const String &	path,
		QObject *
	)

~ExportData()

ExportData::~ExportData

(

)

Member Function Documentation

annotation()

bool ExportData::annotation

(

)

const

audio()

bool ExportData::audio

(

)

const

copy()

bool ExportData::copy

(

)

const

database()

bool ExportData::database

(

)

const

element()

bool ExportData::element

(

)

const

envGroup()

bool ExportData::envGroup

(

)

const

envLibrary()

bool ExportData::envLibrary

(

)

const

envName()

String ExportData::envName

(

)

const

envPalette()

bool ExportData::envPalette

(

)

const

final()

bool ExportData::final

(

)

const

hard()

bool ExportData::hard

(

)

const

hardLn()

bool ExportData::hardLn

(

)

const

ignoreBrokenSym()

bool ExportData::ignoreBrokenSym

(

)

const

ignoreValidSym()

bool ExportData::ignoreValidSym

(

)

const

jobGroup()

bool ExportData::jobGroup

(

)

const

jobLibrary()

bool ExportData::jobLibrary

(

)

const

jobName()

String ExportData::jobName

(

)

const

jobPalette()

bool ExportData::jobPalette

(

)

const

keepBrokenSym()

bool ExportData::keepBrokenSym

(

)

const

keepValidSym()

bool ExportData::keepValidSym

(

)

const

other()

bool ExportData::other

(

)

const

outsideDrawings()

bool ExportData::outsideDrawings

(

)

const

path()

String ExportData::path

(

)

const

resolveSym()

bool ExportData::resolveSym

(

)

const

sceneGroup()

bool ExportData::sceneGroup

(

)

const

sceneLibrary()

bool ExportData::sceneLibrary

(

)

const

sceneNames()

StringList ExportData::sceneNames

(

)

const

scenePalette()

bool ExportData::scenePalette

(

)

const

setannotation()

void ExportData::setannotation

(

bool

annotation

)

setaudio()

void ExportData::setaudio

(

bool

priority

)

setCopy()

void ExportData::setCopy

(

bool

priority

)

setdatabase()

void ExportData::setdatabase

(

bool

priority

)

setelement()

void ExportData::setelement

(

bool

priority

)

setenvGroup()

void ExportData::setenvGroup

(

bool

priority

)

setenvLibrary()

void ExportData::setenvLibrary

(

bool

priority

)

setenvPalette()

void ExportData::setenvPalette

(

bool

priority

)

setExportAll

void ExportData::setExportAll ( )

slot

Set all export options to true ( audio, database, final, envGroup, jobGroup, sceneGroup, envLibrary,jobLibrary, sceneLibrary, envPalette, jobPalette, scenePalette, other, element, timing, stage and outsideDrawings.

setExportDefaults

void ExportData::setExportDefaults ( )

slot

Set the export defaults, which are database, element, timing and stage.

setfinal()

void ExportData::setfinal

(

bool

priority

)

setHard()

void ExportData::setHard

(

bool

priority

)

setHardLn()

void ExportData::setHardLn

(

bool

priority

)

setIgnoreBrokenSym()

void ExportData::setIgnoreBrokenSym

(

bool

priority

)

setIgnoreValidSym()

void ExportData::setIgnoreValidSym

(

bool

priority

)

setjobGroup()

void ExportData::setjobGroup

(

bool

priority

)

setjobLibrary()

void ExportData::setjobLibrary

(

bool

priority

)

setjobPalette()

void ExportData::setjobPalette

(

bool

priority

)

setKeepBrokenSym()

void ExportData::setKeepBrokenSym

(

bool

priority

)

setKeepValidSym()

void ExportData::setKeepValidSym

(

bool

priority

)

setother()

void ExportData::setother

(

bool

priority

)

setoutsideDrawings()

void ExportData::setoutsideDrawings

(

bool

priority

)

setResolveSym()

void ExportData::setResolveSym

(

bool

priority

)

setsceneGroup()

void ExportData::setsceneGroup

(

bool

priority

)

setsceneLibrary()

void ExportData::setsceneLibrary

(

bool

priority

)

setscenePalette()

void ExportData::setscenePalette

(

bool

priority

)

setsolo()

void ExportData::setsolo

(

bool

priority

)

setstage()

void ExportData::setstage

(

bool

priority

)

setSym()

void ExportData::setSym

(

bool

priority

)

settiming()

void ExportData::settiming

(

bool

priority

)

solo()

bool ExportData::solo

(

)

const

stage()

bool ExportData::stage

(

)

const

sym()

bool ExportData::sym

(

)

const

timing()

bool ExportData::timing

(

)

const

Property Documentation

annotation

bool ExportData::annotation

readwrite

annotation

audio

bool ExportData::audio

readwrite

export the audio folder

copy

bool ExportData::copy

readwrite

"Advanced Options" not available for animate which sets copy to true

database

bool ExportData::database

readwrite

export the database folder

element

bool ExportData::element

readwrite

export elements

envGroup

bool ExportData::envGroup

readwrite

export the groups at the environment level

envLibrary

bool ExportData::envLibrary

readwrite

export the libraries at the environment level

envName

String ExportData::envName

read

envPalette

bool ExportData::envPalette

readwrite

export the palettes at the environment level

final

bool ExportData::final

readwrite

export the final frame folder

hard

bool ExportData::hard

readwrite

"Advanced Options" not available for animate which sets copy to true

hardLn

bool ExportData::hardLn

readwrite

"Advanced Options" not available for animate which sets copy to true

ignoreBrokenSym

bool ExportData::ignoreBrokenSym

readwrite

"Advanced Options" not available for animate which sets copy

ignoreValidSym

bool ExportData::ignoreValidSym

readwrite

"Advanced Options" not available for animate which sets copy

jobGroup

bool ExportData::jobGroup

readwrite

export the groups at the job level

jobLibrary

bool ExportData::jobLibrary

readwrite

export the libraries at the job level

jobName

String ExportData::jobName

read

jobPalette

bool ExportData::jobPalette

readwrite

export the palettes at the job level

keepBrokenSym

bool ExportData::keepBrokenSym

readwrite

"Advanced Options" not available for animate which sets copy

keepValidSym

bool ExportData::keepValidSym

readwrite

"Advanced Options" not available for animate which sets copy

other

bool ExportData::other

readwrite

export other ( non-standard ) folders that are at scene level

outsideDrawings

bool ExportData::outsideDrawings

readwrite

export outside drawings

path

String ExportData::path

read

resolveSym

bool ExportData::resolveSym

readwrite

"Advanced Options" not available for animate which sets copy

sceneGroup

bool ExportData::sceneGroup

readwrite

export the groups at the scene level

sceneLibrary

bool ExportData::sceneLibrary

readwrite

export the libraries at the scene level

sceneNames

StringList ExportData::sceneNames

read

scenePalette

bool ExportData::scenePalette

readwrite

export the palettes at the scene level

solo

bool ExportData::solo

readwrite

export in Animate format, if true, ignores other settings

stage

bool ExportData::stage

readwrite

export stage folder

sym

bool ExportData::sym

readwrite

"Advanced Options" not available for animate which sets copy to true

timing

bool ExportData::timing

readwrite

export timings