exporter Class Reference

The exporter JavaScript global object. Provides access to the project export directory. More...

Public Slots

void cleanExportDir ()
 removes all files from the project export directory. More...
 
String getExportDir ()
 returns the path of the project export directory. More...
 
bool exportToQuicktime (String &displayName, int startFrame, int lastFrame, bool withSound, int resX, int resY, String &dstPath, String &displayModule, bool generateThumbnail, int thumbnailFrame)
 returns true if a scene was exported to a QuickTime in the specified directory More...
 
void exportOGLToQuicktime (String &fileName, String &dstPath, int startFrame=-1, int lastFrame=-1, int resX=-1, int resY=-1)
 export OGL frames to a QuickTime movie. Without QuickTime it will try to fallback to other supported formats. More...
 

Detailed Description

The exporter JavaScript global object. Provides access to the project export directory.

var exportDir = exporter.getExportDir();
var exportFile = exportDir + "paletteList.txt";
var logFile = new File(exportFile);
// FileAccess is a 10.1 interface, 10.0 should use integers
// ReadOnly = 0x0001
// WriteOnly = 0x0002
// ReadWrite = 0x0003
// Append = 0x0004
// Truncate = 0x0008
// Translate = 0x0010
logFile.open(FileAccess.WriteOnly);
logFile.writeLine(scene.currentScene() + " palettes:");
logFile.writeLine("");
var numPalettes = PaletteManager.getNumPalettes();
for (i = 0; i < numPalettes; ++i)
{
var paletteName = PaletteManager.getPaletteName(i);
logFile.writeLine(paletteName);
}
MessageBox.information("Palette list exported to: " + exportFile);

Member Function Documentation

◆ cleanExportDir

void exporter::cleanExportDir ( )
slot

removes all files from the project export directory.

◆ exportOGLToQuicktime

void exporter::exportOGLToQuicktime ( String &  fileName,
String &  dstPath,
int  startFrame = -1,
int  lastFrame = -1,
int  resX = -1,
int  resY = -1 
)
slot

export OGL frames to a QuickTime movie. Without QuickTime it will try to fallback to other supported formats.

Parameters
fileNameoutput file name
dstPathoutput file location
startFramestart range of playback, default to playback toolbar start if -1
lastFrameend range of playback, default to playback toolbar stop if -1
resXhorizontal resolution, default to preview resolution if -1
resYvertical resolution default to preview resolution if -1

◆ exportToQuicktime

bool exporter::exportToQuicktime ( String &  displayName,
int  startFrame,
int  lastFrame,
bool  withSound,
int  resX,
int  resY,
String &  dstPath,
String &  displayModule,
bool  generateThumbnail,
int  thumbnailFrame 
)
slot

returns true if a scene was exported to a QuickTime in the specified directory

◆ getExportDir

String exporter::getExportDir ( )
slot

returns the path of the project export directory.