bsExportFilter

Module: bsExportFilter

Interface for the declaration of export filters. The export filters describe the implemented file formats which are available to the main application. The main application could offer to the user a list of available file formats for export.

Integer nExportFilterSingleFile

flag option - single file.

Integer nExportFilterMultifile

flag option - multiple files.

bsExportFilter.declareFilter(sFilterId, sFilterName, sFilterExtension, nVersionMajor, nVersionMinor, nFlags)

Declares an export filter. It is important that sFilterId is unique so that the corresponding method can be called inside the export function. The combination of the major and minor version numbers describe the version number of the file format. For example major version “1” and minor version “5” is interpreted as version “1.5”.

Arguments:

• sFilterId : Unique identifier of the export filter

• sFilterName : Name of the export filter. For display purposes.

• sFilterExtension : File name extension. E.g. “cli”.

• nVersionMajor : Major version number of the file format.

• nVersionMinor : Minor version number of the file format.

• nFlags : options: {nExportFilterSingleFile,nExportFilterMultifile}

bsExportFilter.declareFilterEx(formatObj)

Declares an export filter. The argument object has to contains all attributes shown in the example below except the entries ‘sSchema’ and ‘custom’ which are optional.

var formatObj = {
  "sFilterId" : "CLI-BFD4ACD4-0E2E-4A1D-8B24-095D3AA011D0",
  "sFilterName" : "Common Layer Interface",
  "sFilterExtension" : "cli",
  "nVersionMajor" : 2,
  "nVersionMinor" : 0,
  "isMultifile" : false,
  "sSchema" : "com.autodesk.powderbed-1.0.0",
  "custom" : {}
};

The format object is allowed to contain any additional custom information. ATU will ignore custom values but they will be available to the host application which is reading out the export filter attributes from an ebpa module.

The combination of the major and minor version numbers describe the version number of the file format. For example major version “1” and minor version “5” is interpreted as version “1.5”.

Arguments:

• formatObj.sFilterId : It is important that sFilterId is unique so that it does not conflict with export filter IDs of any other ATU user’s export filters.

• formatObj.sFilterName : Human readable name of the file format.

• formatObj.sFilterExtension : File name extension.

• formatObj.nVersionMajor : Major version number of the file format.

• formatObj.nVersionMinor : Minor version number of the file format.

• formatObj.isMultifile : If “true”: The export filter is expected to create multiple files. Therefore “exportToDirectory” will be called to execute the export filter.

• formatObj.sSchema : Schema where the exporter is based on.

• formatObj.custom : Optional entry containing custom attributes.