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

Public Member Functions
QScriptValue	exportGIF (QScriptValue &params)
	Render the scene and export an animated GIF from its rendering. More...

Detailed Description

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

The example below writes the palette list to a file.

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.

exportGIF()

QScriptValue exportGIF

(

QScriptValue &

params

)

Render the scene and export an animated GIF from its rendering.

try
{
  var res = exporter.exportGIF({ fileName : "C:/myPath/myGif.gif",
                                 displayName : "",
                                 startFame : 1,
                                 stopFrame : 10,
                                 resX : 1024,
                                 resY : 554,
                                 dith : exporter.None,
                                 loop : true });
  
  if(res)
    MessageBox.information('The GIF export has succeeded);
  else
    MessageBox.information('The GIF export has failed);

  exporter.exportGIF({ fileName : "C:/myPath/animated2.gif", stopFrame : 5, dith : 0 });
}
catch (err)
{
  MessageBox.critical(err.message);     
}

Parameters

params

: An export parameters object with following properties: Property Type Description fileName String The complete file path to the generated animated GIF. displayName String (Optional) The display node name. The default display is used if the property isn't specified or if it is an empty string. startFrame int (Optional) The first frame to be exported. The first frame of the scene if the property isn't specified or if it is set to 0. stopFrame int (Optional) The last frame to be exported. The last frame of the scene if the property isn't specified or if it is set to 0. resX int (Optional) The horizontal pixel resolution. The x resolution of the scene if 0 or not specified. resY int (Optional) The vertical pixel resolution. The y resolution of the scene if 0 or not specified. dith int (Optional) The dithering to use. exporter.None if not specified. loop bool (Optional) Set the animation to loop. true by default.

Dithering	Value
exporter.None	0
exporter.Diffusion	1
exporter.Pattern	2

Returns

Returns true if a scene was exported as an animated GIF. Throw an error if there was an invalid dithering property.

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

fileName	: The output file name.
dstPath	: The output file location.
startFrame	: The start range of playback, default to playback toolbar start if -1.
lastFrame	: The end range of playback, default to playback toolbar stop if -1.
resX	: The horizontal resolution, default to preview resolution if -1.
resY	: The vertical 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.

Parameters

displayName	: The display name.
startFrame	: The start range of playback, default to playback toolbar start if -1.
lastFrame	: The end range of playback, default to playback toolbar stop if -1.
withSound	: Whether or not the movie will have sound.
resX	: The horizontal resolution, default to preview resolution if -1.
resY	: The vertical resolution default to preview resolution if -1.
dstPath	: The output file location.
displayModule	: The display module.
generateThumbnail	: Whether or not to generate a thumbnail for the QuickTime.
thumbnailFrame	: The frame to use for the thumbnail.

Returns

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.

Returns

Returns the path of the project export directory.