Enumeration ExportJobInterfaceSignal

The ExportJobInterfaceSignal lists all the signals that may be sent by the ExportJobInterface.

These signals are emitted by the ExportJobInterface to monitor the progress of an export job call (DataSessionInterface.export3D, DataSessionInterface.export2D, DataSessionInterface.exportSVG), and when the export job procedure is over (successfully or not).

• ExportJobFinished : when the 3djuump Infinite backend has finished processing a file inside the export request, ExportJobInterface.computeDownloadURL may be called to get a download URL when ExportJobURLReady signal is fired if the export procedure has not been cancelled or failed.
• ExportJobCancelled : the retrieving of one file of the content by the ExportJobInterface has been cancelled.
• ExportJobProgress : this signal is regularly fired to monitor the progress / state of a file inside the export job (ExportJobInterface.getFileProgress / ExportJobInterface.getFileState).
• ExportJobURLReady : this signal is called after ExportJobInterface.computeDownloadURL has been called and ExportJobInterface.getDownloadURL can be safely called.
• ExportFileCountReady : this signal is called a short while after calling DataSessionInterface.export3D, DataSessionInterface.export2D or DataSessionInterface.exportSVG. This event tells that the backend has started processing the request, and will make some files available for download.

/** 
 * Sample to illustrate the use of a 3d export procedure.
 */
import { DataSessionInterface, WorkingSetInterface, ExportJobInterface, ExportJobInterfaceSignal, InfiniteError, InfiniteEvent, Export3DOutputFormat } from 'generated_files/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession: DataSessionInterface;
// the working set to export as 3d data
let lWorkingSetToExport : WorkingSetInterface;
// the export job to monitor
let lExportJob : ExportJobInterface | undefined = undefined;
// the file to download
// In this test, we will only download one file
let lFileOffset : number = -1;

// triggers a save file from the browser
const onDownloadReady = (pUrl : string) : void => {
    const downloadLink = document.createElement('a');
    downloadLink.target = '_blank';
    // set object URL as the anchors href
    downloadLink.href = pUrl;
    // append the anchor to document body
    document.body.appendChild(downloadLink);
    // fire a click event on the anchor
    downloadLink.click();
    // cleanup: remove element and revoke object URL
    downloadLink.remove();
};

const startExportProcedure = () : boolean =>
{
    // will will try to export as fbx
    lExportJob = lDataSession.export3D(
        [{ workingSet: lWorkingSetToExport }],
        {
            type: 'export3DOutputFormat',
            dataFormat: Export3DOutputFormat.EOF_FBX,
            // filename without extension
            filename: 'test'
        }
    );
    // sanity check
    if(lExportJob === undefined)
    {
        return false;
    }
    lExportJob.addEventListener(ExportJobInterfaceSignal.ExportJobFinished, (pEvent : InfiniteEvent) : void =>
    {
        // only get the URL if no error
        const lError : InfiniteError | undefined = lExportJob.getLastError();
        if(lError === undefined && (lFileOffset === -1))
        {
            lFileOffset = pEvent.attachments;
            if(lExportJob.isExportSuccess(lFileOffset))
            {
                // trigger the URL computing
                if(!lExportJob.computeDownloadURL(lFileOffset))
                {
                    console.log('Export job failed');
                }
            }
        }
    });
    // URL will be ready
    lExportJob.addEventListener(ExportJobInterfaceSignal.ExportJobURLReady, () : void =>
    {
        const lUrl : string | undefined = lExportJob.getDownloadURL(lFileOffset);
        // sanity check
        if(lUrl === undefined)
        {
            console.log('Export job failed');
            return;
        }
        // trigger the download from the browser
        onDownloadReady(lUrl);
    });
    return true;
};

startExportProcedure();

Copy

Please refer to ExportJobInterface for more information.

See

ExportJobInterface