KOMPAS-3D APIの操作→レッスン6→さまざまな形式でドキュメントを保存する

VNII Signal JSCのソフトウェアエンジニアであるKOMPAS-3D CAD API Sergey Norseevの使用に関する一連の記事を続けています。DelphiでのKOMPASのアプリケーション開発の著者です。 使用される環境はC ++ Builderです。 このレッスンでは、ドキュメントを保存する方法について説明します。

レッスンシリーズ「COMPASS-3D APIの操作」の内容

1. 基本
2. 図面デザイン
3. COMPASSへの正しい接続
4. 主な碑文
5. グラフィックプリミティブ
6. ドキュメントをさまざまな形式で保存する
7. 設定を知る
8.タイトルブロックに書き込むより複雑な方法

簡単保存

グラフィックドキュメントを保存するには、 ksDocument2DインターフェイスのksSaveDocumentメソッドとksSaveDocumentExExメソッドが使用されます。 最初から始めましょう。そのプロトタイプを以下に示します。

BOOL ksSaveDocument ( BSTR fileName //   ); 

メソッドへの唯一のパラメーターは、ドキュメントを保存するファイルのフルネームを含む文字列です。 filenameパラメーターに空の文字列が含まれている場合、ドキュメントはksDocumentParamインターフェイスのfilenameプロパティで指定されたパスに沿って保存されます（ループの最初の部分で簡単に説明します）。

指定した名前のファイルが既に存在する場合、COMPASはそれを上書きすることに注意してください。
成功した場合、 ksSaveDocumentメソッドはtrueを返し、エラーの場合はfalseを返します 。

ksSaveDocumentExExメソッドはksSaveDocumentメソッドに似ており、実際には拡張バージョンです。 以下は、 ksSaveDocumentExメソッドのプロトタイプです。

 BOOL ksSaveDocumentEx ( BSTR fileName, //   long version //     ); 

プロトタイプからわかるように、 ksSaveDocumentメソッドと比較して、 ksSaveDocumentExメソッドはもう1つのパラメーターを追加しました。ドキュメントを保存するKOMPASのバージョンのサインです。 有効な値は3つだけです。

-1-前のバージョンへ。
0-現在のバージョン。
1-バージョン5.11へ。

ksSaveDocumentExメソッドとksSaveDocumentメソッドの唯一の違いは、追加のパラメーターです。 バージョンパラメータを0にしてksSaveDocumentExメソッドを呼び出すことは、 ksSaveDocumentメソッドを呼び出すことと同じです。

DXF形式に保存

ウィキペディアによると： DXF （Drawing eXchange Format）は、CADアプリケーション間でグラフィック情報を交換するためのオープンファイル形式です。 KOMPASはこの形式をサポートしており、この形式でドキュメントを保存できます。
グラフィックドキュメントをDXF形式で保存するには、 ksDocument2DインターフェイスのksSaveToDXFメソッドを使用します。 これが彼のプロトタイプです。

 BOOL ksSaveToDXF ( LPCTSTR dxfFileName //   ); 

唯一のパラメーターとして、ドキュメントの保存先のファイルへのフルパスを使用します。 成功した場合、メソッドはtrueを返し、エラーの場合はfalseを返します 。

基本的に、DXF形式はテキスト形式であり、標準のメモ帳でファイルの内容を表示できます。 ただし、メモ帳はこの形式を完全にはサポートしていません。 ファイルの内容を完全に表示するには、sharecad.orgサイトまたは特別なプログラムを使用できます。 次の図は、DXF形式で保存され、sharecad.orgで開いている図面を示しています。


sharecad.orgで開いているDXF図面

ラスター形式の保存オプション

KOMPASでは、ドキュメントをラスター形式で保存できます。 これを行うには、最初にksRasterFormatParamパラメーターinterfaceに入力する必要があります 。 このインターフェイスは、 ksDocument2DインターフェイスのRasterFormatParam（）メソッドを使用して取得できます。 このメソッドには入力パラメーターがなく、成功した場合、 ksRasterFormatParamインターフェイスを返します。 エラーの場合、 NULLを返します 。 ksRasterFormatParamインターフェイスのプロパティを検討してください。

colorBPP-ビットマップ画像の色。 作成する画像の色深度を指定します。 このプロパティの有効な値は、以下の表にリストされています。 定数はldefin2d.hモジュールで宣言されます。


colorBPPプロパティの有効な値

colorType-グラフィック画像の出力の色深度。 このプロパティはcolorBPPプロパティに似ており、有効な値は同じです。 2つの違いは、 colorBPPプロパティが結果のファイルの色深度を決定し、colorTypeがグラフィックオブジェクトをファイルに保存する前にラスター形式に変換するときの色深度を決定することです。
extResolution-インチあたりのドット数でのビットマップ解像度。 このプロパティの値がゼロの場合、現在の画面解像度が使用されます。 画像を作成できる最大解像度は960 dpiでしたが、より生産的なシステムでは可能ですが、さらに高い解像度で画像を作成できます。
extScale-スケール。 extScale値が1 より大きい場合、イメージはextScale倍に拡大されます。 単位が1未満の場合、イメージは1 / extScale倍に削減されます。
format-ビットマップ画像の形式。 このプロパティの有効な値を次の表に示します。 定数はldefin2d.hモジュールで宣言されます。


formatプロパティの有効な値

WMF形式はサポートされていません。 KOMPASの資料によると、この形式でドキュメントを保存しようとすると、EMF形式で保存されます。

grayScale-グレーの陰影を使用する兆候。 このプロパティの値がtrueの場合 、グレースケールが使用されます。 プロパティ値がfalseの場合、カラー画像が保存されます。
multiPageOutput -1つのファイルにドキュメントシートを保存するフラグ。 このプロパティの値がtrueの場合 、ドキュメントのすべてのシートが1つのファイルに保存されます。 このプロパティの値がfalseの場合、シートは個別のファイルに保存されます。 このプロパティは、TIFF形式でのみ使用されます。 しかし、私の実験が示すように、TIFF形式のKOMPASは、 multiPageOutputプロパティの値に関係なく、ドキュメントのシートを1つのファイルに保存します。 他の形式の場合、シートは個別のファイルに保存されます。
onlyThinLine-細い線での出力のサイン。 このプロパティの値がtrueの場合 、ドキュメントのコンテンツは細い線でのみ表示されます。 このプロパティの値がfalseの場合、オブジェクトに設定された行がドキュメント出力で使用されます。
pages-ドキュメントの出力シートのリスト。文字列として表示されます。 リストの例：「 1-18、24-25 」 この例では、シート1から18、および24シートと25シートが表示されます。 シートの番号付けは1つから実行されます。 行が空の場合、COMPASSはこのプロパティを使用しません。
rangeindex-偶数シートと奇数シートの選択の兆候。 有効なプロパティ値は次のとおりです。
0-すべてのシート。
1-奇数シート。
2-偶数シート。
ksRasterFormatParamインターフェイスのメソッドは 1つだけです。
Init（） -すべてのインターフェイスプロパティをゼロにリセットします。 入力パラメーターはなく、成功するとtrueを返します 。

ビットマップとして保存する

文書をラスターイメージとして保存するには、 ksDocument2DインターフェイスのSaveAsToRasterFormatメソッドが使用されます。 以下はそのプロトタイプです。

 BOOL SaveAsToRasterFormat ( BSTR fileName, //    LPDISPATCH rasterPar //  ); 

最初のパラメーターは、ドキュメントを保存するファイルへのフルパスを設定します。
2番目のパラメーターには、保存オプションをビットマップとして設定するksRasterFormatParamインターフェイスが含まれます。

成功した場合、 SaveAsToRasterFormatメソッドはtrueを返し、エラーの場合はfalseを返します 。

以下は、このメソッドの使用例です。

 //   ,     WideString str_filepath; str_filepath = ExtractFileDir(Application->ExeName); str_filepath += L"\\MyNewDocument.jpg"; //   KompasObjectPtr kompas; kompas.CreateInstance(L"KOMPAS.Application.5"); //   DocumentParamPtr DocumentParam; DocumentParam=(DocumentParamPtr)kompas->GetParamStruct(ko_DocumentParam); DocumentParam->Init(); DocumentParam->type= lt_DocSheetStandart;//    //  Document2DPtr Document2D; Document2D = (Document2DPtr)kompas->Document2D(); Document2D->ksCreateDocument(DocumentParam); //     RasterFormatParamPtr RasterFormatParam; RasterFormatParam = (RasterFormatParamPtr)Document2D->RasterFormatParam(); RasterFormatParam->Init(); RasterFormatParam->set_colorBPP(BPP_COLOR_24); RasterFormatParam->set_colorType(BPP_COLOR_24); RasterFormatParam->set_extResolution(0); RasterFormatParam->set_extScale(1.0); RasterFormatParam->set_format(FORMAT_JPG); RasterFormatParam->set_greyScale(false); RasterFormatParam->set_onlyThinLine(false); RasterFormatParam->set_pages(SysAllocString(L"")); RasterFormatParam->set_rangeIndex(0); //     Document2D->SaveAsToRasterFormat(SysAllocString(str_filepath.c_bstr()), RasterFormatParam); //  RasterFormatParam.Unbind(); Document2D.Unbind(); kompas->set_Visible(true); kompas.Unbind(); 

この例では、新しいドキュメントが作成され、jpegイメージとして保存されます。 ドキュメントは空なので、ほとんどの場合、空白のシートが表示されます。非商用バージョンでは、下図のように、左下隅にKOMPASとマークされています。


非商用版のドキュメントにマークを付ける（シートの端は条件付きで表示されます）

マルチシートドキュメントの保存

文書を保存した結果、1つのファイルと複数のファイルを取得できます。 次の場合に1つのファイルが取得されます。

• 保存されたドキュメントは1つのシートで構成されます。
• 1枚のドキュメントのみが保存されます。
• ドキュメントはTIFF形式で保存されます。

それ以外の場合、ドキュメントを保存すると、いくつかのファイルが作成されます。 シートごとに1つのファイル。 同時に、保存されているシートの番号がファイル名に追加されます。 たとえば、 SaveAsToRasterFormatメソッドのfileNameパラメーターでpict.jpegファイルの名前を指定した場合、番号1、4、5のシートを保存すると、pict（1）.jpeg、pict（4）.jpeg、pict（5）の3つのファイルが作成されます.jpeg。

シートの保存先のファイルが既に存在する場合、取得するファイルの数に応じてCOMPASの動作が異なります。 1ファイルの場合、警告なしで上書きされます。 複数のファイルが生成される場合、KOMPASは以下に示すダイアログボックスを表示します。 この場合、 SaveAsToRasterFormatメソッドは 、ユーザーがウィンドウを閉じるまでコントロールを返しません。


ファイル上書き警告ダイアログボックス

これらのウィンドウは、KOMPASが非表示モードで起動された場合でも表示されます。

保存されたシートの数は、 ページおよびrangeindexプロパティを使用して設定されます 。 COMPASSでの使用方法を検討してください。

pagesプロパティが設定されていないか、空の文字列を含んでおり、 rangeindexプロパティの値がゼロの場合 、ドキュメントのすべてのシートが保存されます。 pagesプロパティが設定されていて、 rangeindexプロパティの値がゼロの場合、 pagesプロパティで指定されたすべてのシートが保存されます。

pagesプロパティに無効なシート番号が含まれている場合、無視されます。 たとえば、5枚のシートで構成されるドキュメントの場合、 ページプロパティに行「 0,1,4,8 」が設定されている場合、シート1と4が保存されます。シート1と3が保存されます。

rangeindexプロパティが1 （ 2 ）で、 pagesプロパティが設定されていない場合、 ドキュメントのすべての奇数（偶数）シートが保存されます。 たとえば、5つのシートで構成されるドキュメントの場合、 rangeindexプロパティが1で、 pagesプロパティが設定されていない場合、sheets： 1、3、5が保存されます。

rangeindexプロパティが1 （ 2 ）で、 pagesプロパティが設定されている場合、 pagesプロパティで指定された奇数（偶数）シートが保存されます。 たとえば、提供された
pages = " 1,2,3 ";
rangeindex = 1 ;
シート1と3は保存されますが、シート2はドキュメントにある場合、シート5とまったく同じように保存されません。
例を見てみましょう：
pages = " 1.3 ";
rangeindex = 2
この場合、単一のシートは保存されません。 rangeindexプロパティの値に従って、 KOMPASは偶数シートを保存する必要がありますが、 pagesプロパティで偶数シートが指定されていません。 したがって、 SaveAsToRasterFormatメソッドは何も保存せず、 falseを返します 。

圧縮せずに保存

圧縮せずにドキュメントをラスターイメージとして保存するには、 ksDocument2DインターフェイスのSaveAsToUncompressedRasterFormatメソッドを使用します。 このメソッドは、 前述のSaveAsToRasterFormatメソッドと完全に似ています。 したがって、それについては説明しません。

SaveAsToRasterFormatメソッドとSaveAsToUncompressedRasterFormatメソッドの違いは、TIFFファイルで作業している場合にのみ表示されることに注意してください。 他のタイプのファイルについては、まったく同じように機能します。

おわりに
この記事では、グラフィックドキュメントをさまざまな形式で保存する方法について説明しました。 ビットマップまたはDXFとして保存しても 、 ksSaveDocumentメソッドまたはksSaveDocumentExメソッドを使用した保存に置き換わるものではありません。

一般に、KOMPASのアプリケーションを開発するときは、ドキュメントを保存する責任者（あなたまたはユーザー）を明確に決定する必要があります。 ほとんどの場合、ユーザーがこれに責任を負うべきだと思います。 プログラムはドキュメントを作成し、ユーザーに表示します。ユーザーは次に何をするかを決定します。保存するか、忘れますか。 ただし、プログラムで大量のドキュメントを変更する必要がある場合は、ドキュメントを保存するタスクをユーザーに移すのは面倒です。 この場合、プログラムはドキュメントを保存する必要があります。 すべてはタスクに依存しますが。

継続するには、ブログのニュースに従ってください。

Sergey Norseev、「DelphiでのCOMPASのアプリケーション開発」の著者。