Abstract interface for exporters. More...
Public Member Functions | |
| virtual bool | test_file_type (const char *extension, const IWriter *writer) const =0 |
| Indicates whether the exporter can handle the file type. More... |
|
| virtual IExport_result * | export_scene (ITransaction *transaction, const char *extension, IWriter *writer, const char *rootgroup, const char *caminst, const char *options, const IMap *exporter_options, IImpexp_state *state) const =0 |
| Exports a scene via a writer. More... |
|
| virtual IExport_result * | export_elements (ITransaction *transaction, const char *extension, IWriter *writer, const IArray *elements, const IMap *exporter_options, IImpexp_state *state) const =0 |
| Exports a set of named elements via a writer. More... |
|
Additional Inherited Members | |
 Public Types inherited from mi::base::Interface_declare< 0x543b5252, 0x7c50, 0x4998, 0xa9, 0xf3, 0x97, 0xa9, 0x4e, 0x11, 0xfd, 0x3a, IImpexp_base >
| |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IImpexp_base > |
Self |
| Own type. More... |
|
| typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
| Declares the interface ID (IID) of this interface. More... |
|
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0x543b5252, 0x7c50, 0x4998, 0xa9, 0xf3, 0x97, 0xa9, 0x4e, 0x11, 0xfd, 0x3a, IImpexp_base >
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
Abstract interface for exporters.
|
pure virtual |
Exports a set of named elements via a writer.
Writes the named elements to the writer in a format determined by the exporter and the given extension. Note that in contrast to export_scene() references are not followed recursively.
The exporter can expect that the elements array contains no duplicates and that elements that are referenced come before elements that reference them. It is possible that these two conditions on the elements array are violated, but the exporter may then have undefined behavior, for example, produce invalid files.
In addition to exporter specific options, every exporter has to implement the following standard option:
"strip_prefix" of type mi::IString: If present, this prefix is to be stripped from all names of database elements if they have the same prefix. Default: the empty string.It is strongly recommended that names for exporter specific options use a prefix related to the exporter to avoid name conflicts, e.g., the file name extension.
In the case of the .mi file format, the exported file will contain no render statement.
| transaction | The transaction to be used. |
| extension | The file name extension (which might influence the file format). |
| writer | The writer to write the byte stream to. |
| state | The current exporter state. |
| elements | The array of elements to be exported. |
| exporter_options | The options that control the way the exporter works (optional). |
|
pure virtual |
Exports a scene via a writer.
Writes the scene identified by the root group, the camera instance, and the options to the writer in a format determined by the exporter and the given extension.
Any elements referenced by the three argument elements are written as well, recursively, in an order that allows re-importing (e.g., in .mi files, a referenced element must precede the reference). The scene graph cannot contain cyclic references and an exporter does not need to take any precautions to detect cycles.
In addition to exporter specific options, every exporter has to implement the following standard option:
"strip_prefix" of type mi::IString: This prefix is to be stripped from the names of all exported elements if they have the same prefix. Default: the empty string.It is strongly recommended that names for exporter specific options use a prefix related to the exporter to avoid name conflicts, e.g., the file name extension.
In the case of the .mi file format, the exported file will contain a render statement.
| transaction | The transaction to be used. |
| extension | The file name extension (which might influence the file format). |
| writer | The writer to write the byte stream to. |
| state | The current exporter state. |
| rootgroup | The root group of the scene to be exported. |
| caminst | The camera instance of the scene to be exported (optional). |
| options | The options of the scene to be exported (optional). |
| exporter_options | The options that control the way the exporter works (optional). |
|
pure virtual |
Indicates whether the exporter can handle the file type.
Returns true if the exporter can handle the file type determined by the file name extension and if the writer has sufficient capabilities for export (such as random access or availability of a file handle if that is required for this exporter). The extension is defined as the part of the filename after and including the first dot, for example, ".mi". In the case of missing capabilities the exporter shall return false immediately.