3.3. AbstractShapeDataExporter

Inherited by: ShapeDataExporter

3.3.1. Synopsis

3.3.1.1. Functions

3.3.1.2. Virtual functions

3.3.1.3. Static functions

3.3.1.4. Properties

3.3.2. Detailed Description

Abstract shape exporter class. Inherit the class to create own exporter formats. Method do_export must be overloaded.
class mocha.exporters.AbstractShapeDataExporter(name, extension[, number_of_data_streams=1[, export_multiple_shapes=false[, export_multiple_views=false[, export_open_splines=false[, export_interlaced=false]]]]])
Parameters:
  • name (unicode) – name of the exporter which will be displayed in the Export Shape Data dialog drop-down list. Should contain a file mask in brackets e.g. Foo (*.bar)
  • extension (unicode) – additional extension.
  • number_of_data_streams (PySide2.QtCore.uint) – number of result files. If it equals to 1 then the Copy to Clipboard button will be enabled.
  • export_multiple_shapes (PySide2.QtCore.bool) – whether the exporter supports multiple shapes.
  • export_multiple_views (PySide2.QtCore.bool) – whether the exporter supports multiple views.
  • export_open_splines (PySide2.QtCore.bool) – whether the exporter supports open splines.
  • export_interlaced (PySide2.QtCore.bool) – whether the exporter supports interlaced footage.

Create an exporter instance. The instance ownership is delegated to Python. To register the exporter inside mocha exporters system, call register() method. Before deleting the object unregisters itself.

AbstractShapeDataExporter.do_export(project, layers, shape_file_path, views)
Return type:

Dictionary with keys of type QString and values of type QByteArray.
Parameters:
  • project (mocha.project.Project) – mocha project instance.
  • layers (list of Layer) – list of layers to export.
  • shape_file_path (unicode) – absolute file path to save which has been chosen by a user in a file dialog.
  • views (list of View) – list of views to export (if the exporter supports multi-view exporting).
Return type:

dict of {file_name: QByteArray}

Performs main exporter operations. Must return a map (dict) of absolute file path and appropriate contents. The exporter should not create those files.

AbstractShapeDataExporter.error_string()
Return type:unicode
AbstractShapeDataExporter.register()

Registers the exporter instance inside mocha exporters system.

static AbstractShapeDataExporter.registered_exporters()
Return type:Dictionary with keys of type QString and values of type ShapeDataExporter.
Return type:dict of {str: ShapeDataExporter}

Returns a dict of registered exporters including custom user exporters.

AbstractShapeDataExporter.unregister()

Unregisters the exporter instance inside mocha exporters system.

AbstractShapeDataExporter.exports_multiple_shapes
Type:bool
Access:read-only

Whether the exporter supports multiple shapes.

AbstractShapeDataExporter.exports_multiple_views
Type:bool
Access:read-only

Whether the exporter supports multiple views.

AbstractShapeDataExporter.exports_open_splines
Type:bool
Access:read-only

Whether the exporter supports open splines.

AbstractShapeDataExporter.exports_interlaced
Type:bool
Access:read-only

Whether the exporter supports interlaced footage.

AbstractShapeDataExporter.registered
Type:bool
Access:read-only

Whether the exporter registered.