Storyboard
List of all members
ExportManager Class Reference

This interface is used to export the storyboard project. More...

#include <exportManager.h>

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

Public Slots

Export Functions
bool exportToBitmap (String &exportDir, String &filePattern, String &bitmapFormat, int resX, int resY)
 Export storyboard to bitmap file.
 
bool exportToMovie (String &exportDir, String &filePattern, String &movieFormat, int resX, int resY)
 Export storyboard to movie file.
 
bool exportLayout (String &exportDir, String &filePattern, String &movieFormat, int resX, int resY)
 Export storyboard panels, taking into consideration the scene camera (layout )
 
bool exportToPDF (String &fileName)
 Export storyboard to pdf file.
 
bool exportToFCPXML (String &exportFilePath, String &filePattern, String &imageFormat)
 Export storyboard to Final Cut Pro XML format.
 
Selection
void setSelectedScenes (StringList &scenes)
 Sets a selection of scenes to be exported.
 
void setSelectedPanels (StringList &panels)
 Sets a selection of panels to be exported.
 
bool setUseCurrentScene (bool flag)
 Export the current scene.
 
bool setUseCurrentPanel (bool flag)
 Export the current panel.
 
bool setUseTrackedPanels (bool flag)
 Export the tracked panel(s)
 
bool setUseSelectedPanels (bool flag)
 Export the selected panel(s)
 
Bitmap/Layout specific settings
void setCameraScaling (bool flag)
 Allow Camera Scaling.
 
void setShowCamera (bool flag)
 Exports the camera frames black border.
 
void setShowCameraKeyFrames (bool flag)
 Prints each camera keyframe on the exported images.
 
void setTransparentBG (bool flag)
 Sets a transparent background. This is only useful when exporting to photoshop ( psd files ).
 
Bitmap specific settings
void setBitmapFitCameraPath (bool flag)
 Set Fit Camera Path.
 
void setBitmapRectifyStatic (bool flag)
 Set Rectify Static Camera.
 
void setZoomFactor (double zoom)
 Sets the magnification of the image. By default there is no magnification.
 
void setMaintainSize (bool flag)
 Maintain Size Through Scene. This ensures that all images exported are the same size.
 
void setShowReference (bool flag)
 Show the reference frame.
 
Layout specific settings
void setExportOneImagePerLayer (bool flag)
 Export one image for each layer.
 
void setApplyLayerMotionCamera (bool flag)
 By default, this is false.
 
void setShowCameraLabel (bool flag)
 Display the camera labels.
 
PDF specific settings
bool setPDFProfile (String &profile)
 Set the pdf profile to be used during the pdf export.
 
StringList getPDFProfiles ()
 Returns the names of known pdf profiles.
 
Movie specific settings
bool setOneMovieClipPer (String &perWhat)
 Specify the granularity of movie clip generation.
 
void setMovieConfig (String &config)
 Set the audio/video export settings ( for Quicktime export )
 
void setExportCaptions (bool flag)
 Export caption as comments in FCP XML.
 
void setExportMarkers (bool flag)
 Export markers at scene beginning.
 
void setExportScenesReferenceTrack (bool flag)
 Export scenes reference track.
 
void setShowScenePanelNamesOverlay (bool flag)
 Render scene/panel name overlay.
 
void setShowProjectSafetyOverlay (bool flag)
 Render project safety overlay.
 
void setShow43SafetyOverlay (bool flag)
 Render 4:3 safety overlay.
 
void setNotifyFlix (bool flag)
 Notify flix server when exporting to FCP XML.
 

Signals

Signals
void exportReady ()
 Signal emitted if export was successful.
 

Detailed Description

This interface is used to export the storyboard project.

The following examples are provided:

Exports the entire storyboard to pdf format, using the "Overview 4x3" pdf profile

var exp = new ExportManager;
exp.setPDFProfile("Overview 4x3");
exp.exportToPDF("/home/user/exportTest/untitled.pdf");

Exports the scenes 1 through 3 in sequence 1 to the TGA bitmap format, with a resolution of 150 wide by 100 tall, with a 50% zoom factor.

var exp = new ExportManager;
var project = new StoryboardManager;
var selIds = new Array(0);
selIds.push( project.sceneId("1", "1") );
selIds.push( project.sceneId("1", "2") );
selIds.push( project.sceneId("1", "3") );
exp.setSelectedScenes(selIds);
exp.setZoomFactor(0.5);
exp.exportToBitmap("/home/user/exportTest", "untitled", "tga", 150, 100);

Exports scenes 1 through 4 to Quicktime, with a resolution of 400 wide by 300 tall. One movie will be produced for each scene.

var exp = new ExportStoryboard;
var proj = new ProjectStoryboard;
var selIds = new Array(0);
selIds.push( project.sceneId("", "1") );
selIds.push( project.sceneId("", "2") );
selIds.push( project.sceneId("", "3") );
selIds.push( project.sceneId("", "4") );
exp.setSelectedScenes(selIds);
exp.setOneMovieClipPer("scene");
exp.exportToMovie("/home/user/exportTest", "untitled", "mov", 400, 300);

Member Function Documentation

bool ExportManager::exportLayout ( String &  exportDir,
String &  filePattern,
String &  movieFormat,
int  resX,
int  resY 
)
slot

Export storyboard panels, taking into consideration the scene camera (layout )

Supported bitmap formats are jpg, psd or tga.

Parameters
exportDir: target directory for export
filePattern: name used for export file
movieFormat: allowable format strings are "jpg", "psd" and "tga"
resX: width of exported image
resY: height of exported image
void ExportManager::exportReady ( )
signal

Signal emitted if export was successful.

bool ExportManager::exportToBitmap ( String &  exportDir,
String &  filePattern,
String &  bitmapFormat,
int  resX,
int  resY 
)
slot

Export storyboard to bitmap file.

Supported bitmap formats are jpg, psd or tga.

Parameters
exportDir: target directory for export
filePattern: name used for export file
bitmapFormat: allowable format strings are "jpg", "psd" and "tga"
resX: width of exported image
resY: height of exported image
bool ExportManager::exportToFCPXML ( String &  exportFilePath,
String &  filePattern,
String &  imageFormat 
)
slot

Export storyboard to Final Cut Pro XML format.

Supported bitmap formats are jpg, psd or tga.

Parameters
exportFilePath: target xml file path for export
filePattern: name used for export file (images)
imageFormat: allowable format strings are "jpg", "psd" and "tga"
bool ExportManager::exportToMovie ( String &  exportDir,
String &  filePattern,
String &  movieFormat,
int  resX,
int  resY 
)
slot

Export storyboard to movie file.

Supported movie formats are jpg, mov, swf or tga.

Parameters
exportDir: target directory for export
filePattern: name used for export file
movieFormat: allowable format strings are "jpg", "mov" and "tga"
resX: width of exported image
resY: height of exported image
bool ExportManager::exportToPDF ( String &  fileName)
slot

Export storyboard to pdf file.

Parameters
fileName: name used for export file
StringList ExportManager::getPDFProfiles ( )
slot

Returns the names of known pdf profiles.

var listOfProfiles = exp.getPDFProfiles();
for ( var i = 0; i < listOfProfiles.length; i++ )
System.println( listOfProfiles[i] );
void ExportManager::setApplyLayerMotionCamera ( bool  flag)
slot

By default, this is false.

Parameters
flag: true or false
void ExportManager::setBitmapFitCameraPath ( bool  flag)
slot

Set Fit Camera Path.

This ensures that the camera paths and control points appear inside the image. By default, this is true.

Parameters
flag: true or false
void ExportManager::setBitmapRectifyStatic ( bool  flag)
slot

Set Rectify Static Camera.

If enabled, if there is a rotation in the camera, the camera frame will appear as straight, and the image will be rotated instead. If disabled the camera frame appears as rotated and the image is straight. By default, this is false.

Parameters
flag: true or false
void ExportManager::setCameraScaling ( bool  flag)
slot

Allow Camera Scaling.

This ensures that when a very wide zoom camera movement is included in the panel, the exported image will be bigger in relation to the camera scaling used. By default, this is true.

Parameters
flag: true or false
void ExportManager::setExportCaptions ( bool  flag)
slot

Export caption as comments in FCP XML.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setExportMarkers ( bool  flag)
slot

Export markers at scene beginning.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setExportOneImagePerLayer ( bool  flag)
slot

Export one image for each layer.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setExportScenesReferenceTrack ( bool  flag)
slot

Export scenes reference track.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setMaintainSize ( bool  flag)
slot

Maintain Size Through Scene. This ensures that all images exported are the same size.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setMovieConfig ( String &  config)
slot

Set the audio/video export settings ( for Quicktime export )

This is provided as a work-around to specify explicit quicktime settings. The easiest way to access a given Quicktime settings string to to save the given setting in the exportMovie dialog, and consult the EXPORT_DLG_MOVIE_VIDEO_CONFIG preference in your user preferences.

Parameters
config: a string specifying the video settings
void ExportManager::setNotifyFlix ( bool  flag)
slot

Notify flix server when exporting to FCP XML.

By default, this is false.

Parameters
flag: true or false
bool ExportManager::setOneMovieClipPer ( String &  perWhat)
slot

Specify the granularity of movie clip generation.

Allowable values are "project", "sequence", "scene", "shot".

By default, this is "project".

Parameters
perWhat: a string specifying project, sequence, scene or shot
bool ExportManager::setPDFProfile ( String &  profile)
slot

Set the pdf profile to be used during the pdf export.

By default, this is the profile that is selected in the Export PDF Dialog.

Parameters
profile: profile used during pdf export
void ExportManager::setSelectedPanels ( StringList &  panels)
slot

Sets a selection of panels to be exported.

See the SelectStoryboard interface to retrieve a panel Id selection. (The selection interface is not applicable in batch mode.) See the ProjectStoryboard inteface to create a list of panelIds by querying the project.

If no range is specified, then the entire project is exported.

Parameters
panels: list of panel Ids to be exported
void ExportManager::setSelectedScenes ( StringList &  scenes)
slot

Sets a selection of scenes to be exported.

See the SelectStoryboard interface to retrieve a scene Id selection. (The selection interface is not applicable in batch mode.) See the ProjectStoryboard inteface to create a list of sceneIds by querying the project.

If no range is specified, then the entire project is exported.

Parameters
scenes: list of scene Ids to be exported
void ExportManager::setShow43SafetyOverlay ( bool  flag)
slot

Render 4:3 safety overlay.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setShowCamera ( bool  flag)
slot

Exports the camera frames black border.

By default, this is true.

Parameters
flag: true or false
void ExportManager::setShowCameraKeyFrames ( bool  flag)
slot

Prints each camera keyframe on the exported images.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setShowCameraLabel ( bool  flag)
slot

Display the camera labels.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setShowProjectSafetyOverlay ( bool  flag)
slot

Render project safety overlay.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setShowReference ( bool  flag)
slot

Show the reference frame.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setShowScenePanelNamesOverlay ( bool  flag)
slot

Render scene/panel name overlay.

By default, this is false.

Parameters
flag: true or false
void ExportManager::setTransparentBG ( bool  flag)
slot

Sets a transparent background. This is only useful when exporting to photoshop ( psd files ).

By default, this is true.

Parameters
flag: true or false
bool ExportManager::setUseCurrentPanel ( bool  flag)
slot

Export the current panel.

Not applicable in batch mode.

Parameters
flag: true or false
bool ExportManager::setUseCurrentScene ( bool  flag)
slot

Export the current scene.

Not applicable in batch mode.

Parameters
flag: true or false
bool ExportManager::setUseSelectedPanels ( bool  flag)
slot

Export the selected panel(s)

Not applicable in batch mode.

Parameters
flag: true or false
bool ExportManager::setUseTrackedPanels ( bool  flag)
slot

Export the tracked panel(s)

Not applicable in batch mode.

Parameters
flag: true or false
void ExportManager::setZoomFactor ( double  zoom)
slot

Sets the magnification of the image. By default there is no magnification.

Parameters
zoom: zoom factor

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