SketchUp SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions
SketchUpDeprecatedModelExporterInterface Struct Referenceabstract

Old style exporters must implement this interface. Note that this interface is being deprecated. New exporters must implement SketchUpModelExporterInterface. More...

#include <modelexporterplugin.h>

Inheritance diagram for SketchUpDeprecatedModelExporterInterface:
SketchUpModelExporterInterface

Public Member Functions

virtual bool DeprecatedConvertFromSkp (void *document, const std::string &output, SketchUpPluginProgressCallback *progress)=0
 Performs the conversion from an active SketchUp model to the target output file using options set during the ShowOptionsDialog method. More...
 
- Public Member Functions inherited from SketchUpModelExporterInterface
virtual std::string GetIdentifier () const =0
 Returns a unique ASCII (non-localized) identifier for the exporter. For example, all SketchUp supplied exporters use the following convention for the id name: com.sketchup.exporters.extension. This id is used to identify the current default exporter and saved between invocations of SketchUp. More...
 
virtual int GetFileExtensionCount () const =0
 The number of extensions supported by the exporter. Must be > 0. More...
 
virtual std::string GetFileExtension (int index) const =0
 Each extension, assumed to be ASCII and case independent with no leading dot. More...
 
virtual std::string GetDescription (int index) const =0
 Return a brief description of the exporter for the file drop down box which may be extension specific. For example you may return "AutoCAD DWG Files" corresponding to the dwg extension and "AutoCAD DXF Files" corresponding to the dxf extension. Each extension and description pair will be entered into the exporter drop down list as a separate entry. More...
 
virtual bool SupportsOptions () const
 Indicates whether the exporter supports an options dialog. More...
 
virtual void ShowOptionsDialog (bool model_has_selection)
 Displays a modal dialog which controls options supported by the exporter. Implementing this is required if SupportOptions is true. Options should be saved someplace which persists between this method and ConvertFromSkp as well as between sessions. More...
 
virtual bool ExportSelectionSetOnly ()
 Indicates whether the plugin supports exporting just the selection. More...
 
virtual bool SupportsProgress () const
 Indicates whether the plugin supports the progress callback. More...
 
virtual void ShowSummaryDialog ()
 Displays a modal dialog showing an optional summary of the export process. The default does nothing. Note that Ruby scripting often disables this dialog. More...
 

Detailed Description

Old style exporters must implement this interface. Note that this interface is being deprecated. New exporters must implement SketchUpModelExporterInterface.

Member Function Documentation

virtual bool SketchUpDeprecatedModelExporterInterface::DeprecatedConvertFromSkp ( void *  document,
const std::string &  output,
SketchUpPluginProgressCallback progress 
)
pure virtual

Performs the conversion from an active SketchUp model to the target output file using options set during the ShowOptionsDialog method.

Parameters
[in]documentThe ISkpDocument pointer for the model being exported.
[in]outputThe requested output file in UTF-8.
[in]progressThe exporter should support this progress interface. See that for details. The method should be tolerant to a NULL progress callback.
Returns
  • true on success
  • false on failure or cancellation

The documentation for this struct was generated from the following file: