3.2. AbstractShapeDataExporter¶

Inherited by: ShapeDataExporter

3.2.1. Synopsis¶

3.2.1.1. Functions¶

def register ()
def unregister ()

3.2.1.2. Virtual functions¶

def do_export (project, layers, shape_file_path, views)
def error_string ()

3.2.1.3. Static functions¶

def registered_exporters ()

3.2.1.4. Properties¶

property exports_interlaced [read-only] of bool
property exports_multiple_shapes [read-only] of bool
property exports_multiple_views [read-only] of bool
property exports_open_splines [read-only] of bool
property registered [read-only] of bool

3.2.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 (str) – 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 (str) – additional extension.
number_of_data_streams (uint) – number of result files. If it equals to 1 then the Copy to Clipboard button will be enabled.
export_multiple_shapes (bool) – whether the exporter supports multiple shapes.
export_multiple_views (bool) – whether the exporter supports multiple views.
export_open_splines (bool) – whether the exporter supports open splines.
export_interlaced (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 (Project) – mocha project instance.
layers (list of Layer) – list of layers to export.
shape_file_path (str) – 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).

Returns

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: str

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