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...

#include <scriptimportexport.h>

Inheritance diagram for ExportData:

[legend]

Collaboration diagram for ExportData:

[legend]

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...

Private Attributes
String	_envName

String	_jobName

StringList	_sceneNames

String	_path

bool	_solo

bool	_audio

bool	_database

bool	_final

bool	_envGroup

bool	_jobGroup

bool	_sceneGroup

bool	_envLibrary

bool	_jobLibrary

bool	_sceneLibrary

bool	_envPalette

bool	_jobPalette

bool	_scenePalette

bool	_other

bool	_element

bool	_timing

bool	_annotation

bool	_stage

bool	_outsideDrawings

bool	_hard

bool	_hardLn

bool	_sym

bool	_copy

bool	_keepValidSym

bool	_ignoreValidSym

bool	_resolveSym

bool	_keepBrokenSym

bool	_ignoreBrokenSym

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	(	const String &	envName,
		const String &	jobName,
		const StringList &	sceneNames,
		const String &	path,
		QObject *
	)

ExportData::~ExportData ( )

Member Function Documentation

bool ExportData::annotation ( ) const

bool ExportData::audio ( ) const

bool ExportData::copy ( ) const

bool ExportData::database ( ) const

bool ExportData::element ( ) const

bool ExportData::envGroup ( ) const

bool ExportData::envLibrary ( ) const

String ExportData::envName ( ) const

bool ExportData::envPalette ( ) const

bool ExportData::final ( ) const

bool ExportData::hard ( ) const

bool ExportData::hardLn ( ) const

bool ExportData::ignoreBrokenSym ( ) const

bool ExportData::ignoreValidSym ( ) const

bool ExportData::jobGroup ( ) const

bool ExportData::jobLibrary ( ) const

String ExportData::jobName ( ) const

bool ExportData::jobPalette ( ) const

bool ExportData::keepBrokenSym ( ) const

bool ExportData::keepValidSym ( ) const

bool ExportData::other ( ) const

bool ExportData::outsideDrawings ( ) const

String ExportData::path ( ) const

bool ExportData::resolveSym ( ) const

bool ExportData::sceneGroup ( ) const

bool ExportData::sceneLibrary ( ) const

StringList ExportData::sceneNames ( ) const

bool ExportData::scenePalette ( ) const

void ExportData::setannotation ( bool annotation )

void ExportData::setaudio ( bool priority )

void ExportData::setCopy ( bool priority )

void ExportData::setdatabase ( bool priority )

void ExportData::setelement ( bool priority )

void ExportData::setenvGroup ( bool priority )

void ExportData::setenvLibrary ( bool priority )

void ExportData::setenvPalette ( bool priority )

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.

void ExportData::setExportDefaults ( )

slot

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

void ExportData::setfinal ( bool priority )

void ExportData::setHard ( bool priority )

void ExportData::setHardLn ( bool priority )

void ExportData::setIgnoreBrokenSym ( bool priority )

void ExportData::setIgnoreValidSym ( bool priority )

void ExportData::setjobGroup ( bool priority )

void ExportData::setjobLibrary ( bool priority )

void ExportData::setjobPalette ( bool priority )

void ExportData::setKeepBrokenSym ( bool priority )

void ExportData::setKeepValidSym ( bool priority )

void ExportData::setother ( bool priority )

void ExportData::setoutsideDrawings ( bool priority )

void ExportData::setResolveSym ( bool priority )

void ExportData::setsceneGroup ( bool priority )

void ExportData::setsceneLibrary ( bool priority )

void ExportData::setscenePalette ( bool priority )

void ExportData::setsolo ( bool priority )

void ExportData::setstage ( bool priority )

void ExportData::setSym ( bool priority )

void ExportData::settiming ( bool priority )

bool ExportData::solo ( ) const

bool ExportData::stage ( ) const

bool ExportData::sym ( ) const

bool ExportData::timing ( ) const

Member Data Documentation

bool ExportData::_annotation

private

bool ExportData::_audio

private

bool ExportData::_copy

private

bool ExportData::_database

private

bool ExportData::_element

private

bool ExportData::_envGroup

private

bool ExportData::_envLibrary

private

String ExportData::_envName

private

bool ExportData::_envPalette

private

bool ExportData::_final

private

bool ExportData::_hard

private

bool ExportData::_hardLn

private

bool ExportData::_ignoreBrokenSym

private

bool ExportData::_ignoreValidSym

private

bool ExportData::_jobGroup

private

bool ExportData::_jobLibrary

private

String ExportData::_jobName

private

bool ExportData::_jobPalette

private

bool ExportData::_keepBrokenSym

private

bool ExportData::_keepValidSym

private

bool ExportData::_other

private

bool ExportData::_outsideDrawings

private

String ExportData::_path

private

bool ExportData::_resolveSym

private

bool ExportData::_sceneGroup

private

bool ExportData::_sceneLibrary

private

StringList ExportData::_sceneNames

private

bool ExportData::_scenePalette

private

bool ExportData::_solo

private

bool ExportData::_stage

private

bool ExportData::_sym

private

bool ExportData::_timing

private

Property Documentation

bool ExportData::annotation

readwriteprivate

annotation

bool ExportData::audio

readwriteprivate

export the audio folder

bool ExportData::copy

readwriteprivate

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

bool ExportData::database

readwriteprivate

export the database folder

bool ExportData::element

readwriteprivate

export elements

bool ExportData::envGroup

readwriteprivate

export the groups at the environment level

bool ExportData::envLibrary

readwriteprivate

export the libraries at the environment level

String ExportData::envName

readprivate

bool ExportData::envPalette

readwriteprivate

export the palettes at the environment level

bool ExportData::final

readwriteprivate

export the final frame folder

bool ExportData::hard

readwriteprivate

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

bool ExportData::hardLn

readwriteprivate

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

bool ExportData::ignoreBrokenSym

readwriteprivate

"Advanced Options" not available for animate which sets copy

bool ExportData::ignoreValidSym

readwriteprivate

"Advanced Options" not available for animate which sets copy

bool ExportData::jobGroup

readwriteprivate

export the groups at the job level

bool ExportData::jobLibrary

readwriteprivate

export the libraries at the job level

String ExportData::jobName

readprivate

bool ExportData::jobPalette

readwriteprivate

export the palettes at the job level

bool ExportData::keepBrokenSym

readwriteprivate

"Advanced Options" not available for animate which sets copy

bool ExportData::keepValidSym

readwriteprivate

"Advanced Options" not available for animate which sets copy

bool ExportData::other

readwriteprivate

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

bool ExportData::outsideDrawings

readwriteprivate

export outside drawings

String ExportData::path

readprivate

bool ExportData::resolveSym

readwriteprivate

"Advanced Options" not available for animate which sets copy

bool ExportData::sceneGroup

readwriteprivate

export the groups at the scene level

bool ExportData::sceneLibrary

readwriteprivate

export the libraries at the scene level

StringList ExportData::sceneNames

readprivate

bool ExportData::scenePalette

readwriteprivate

export the palettes at the scene level

bool ExportData::solo

readwriteprivate

export in Animate format, if true, ignores other settings

bool ExportData::stage

readwriteprivate

export stage folder

bool ExportData::sym

readwriteprivate

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

bool ExportData::timing

readwriteprivate

export timings

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

dox_files/scriptimportexport.h

Public Slots

Public Member Functions

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation