ExportData Class Reference

ExportData defines the parameters for a database Export command. 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)
 Defines a export data object. More...
 

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 
)

Defines a export data object.

Parameters
envNamename of env
jobNamename of job
sceneNameslist of scene names
pathpath to final archive

Member Function Documentation

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

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