KOMPAS-3D APIの操作→レッスン7→設定の概要

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

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

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

読み取り設定

設定を読み取るには、 KompasObjectインターフェースのksGetSysOptionsメソッドを使用します。 以下はそのプロトタイプです。

long ksGetSysOptions ( long optionsType, //  LPDISPATCH param //  ); 

optionsTypeパラメーターには、取得する設定の種類を決定する整数が含まれます。 paramパラメーターは、要求された設定が書き込まれるインターフェイスへのポインターです。 このインターフェイスのタイプは、要求した構成によって異なります。 optionsTypeとparamの対応は、以下の表に記載されています。


表1. optionsTypeとparamの対応

これらの定数は、 ldefin2d.hファイルで宣言されています。
成功した場合、 ksGetSysOptionsメソッドは1を返し、エラーの場合はゼロを返します 。

KOMPASドキュメントの多くの場所で、 ksGetSysOptionsメソッドを使用して1つまたは別のインターフェイスを取得できることが示されています。 しかし、これはそうではありません。 このメソッドを使用すると、インターフェイスに入力できますが、取得することはできません。 KompasObjectインターフェイスのGetParamStructメソッドを使用して、自分でインターフェイスを取得する必要があります。 受信していないインターフェイスをksGetSysOptionsメソッドに渡すと、メソッドはゼロ （エラー）を返します 。

バインド設定

表1を見ると、 SNAP_OPTIONS_EX設定を取得するためにはアクティブなドキュメントが必要であり、 SNAP_OPTIONS設定を取得するためにドキュメントは不要であるという仮定が思わず生じます。 これは実際にはそうではありません。 私の実験が示すように、アクティブなドキュメントがない場合、 ksGetSysOptionsメソッドはSNAP_OPTIONS_EXではなくSNAP_OPTIONSに対してゼロ （エラー）を返します 。 エラーメッセージが画面に表示されます。


エラーメッセージ

また、上記のエラーが発生した場合は、修正するためにKOMPASを再起動する必要があります。 実際には、アクティブなドキュメントが存在する場合でも、 ksGetSysOptionsメソッドへの後続の呼び出しはすべて失敗します。

ksSnapOptionsインターフェースの概要。 その特性：
angSnap- 「角度スナップ」バインディングが有効かどうか（ true-有効、 false-無効）。
angleStep-角度スナップのステップ（ 度単位 ）;
commonOpt-共通バインディングのフラグのセット（考慮しません）;
grid-「グリッド上の」スナップが有効かどうか（ true-有効、 false-無効）。
交差 -交差バインディングが有効かどうか（ true-有効、 false-無効）;
localSnap-ローカルバインディングのタイプ。
nearestMiddle-ミドルバインディングが有効かどうか（ true-有効、 false-無効）。
nearestPoint- 「最近点」バインディングが有効かどうか（ true-有効、 false-無効）。
pointOnCurve-有効な曲線上のスナップです （ true-有効、 false-無効）。
TangentToCurve- 「タッチ」バインディングが有効かどうか（ true-有効、 false-無効）。
xyAlign-アライメントバインディングが有効かどうか（ true-有効、 false-無効）。
ksSnapOptionsインターフェースには3つのメソッドしかありません。
Init（） -すべてのプロパティをリセットし、成功した場合はtrueを返します 。
GetCommonOptValueおよびSetCommonOptValue - commonOptプロパティで動作するように設計されています。
以下は、 ksSnapOptionsインターフェイスの使用方法を示すプログラム例です。

 //   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); //   ksSnapOptionsPtr SnapOptions; SnapOptions = (ksSnapOptionsPtr)kompas->GetParamStruct(ko_SnapOptions); kompas->ksGetSysOptions(SNAP_OPTIONS, SnapOptions); ShowMessage(FloatToStr(SnapOptions->get_angleStep())); //  DocumentParam.Unbind(); Document2D.Unbind(); SnapOptions.Unbind(); kompas->set_Visible(true); kompas.Unbind(); 

この例では、コーナースナップのピッチを定義します。 たとえば、自宅のコンピューターでは45°でした（別のコンピューターを使用している場合もあります）。 これは非常に単純化された例であることに注意してください。 KOMPASへの正しい接続を実装せず、エラー処理を省略します。

シートオプション

設定コンテキストのシートパラメーターは、 ksSheetOptionsインターフェイスによって記述されます。 このインターフェイスは、このシリーズの第2部で検討したksSheetParインターフェイスに似ています。 ksSheetOptionsインターフェイスのプロパティを検討してください。
layoutName-設計ライブラリへのパス。
sheetType-シートタイプ（ true-カスタムフォーマット、 false-標準シート）;
shtType -layoutNameライブラリのタイトルブロックのタイプ。
layoutNameプロパティとshtTypeプロパティは、同じ名前のksSheetParインターフェイスプロパティに似ています。
ksSheetOptionsインターフェースには2つのメソッドしかありません。
GetSheetParam-シートパラメーターインターフェイス（標準シートの場合はksStandartSheet 、非標準シートの場合はksSheetSize）を返します。 単一のパラメーターとして、シート形式属性（ true-非標準シート、 false-標準シート）を受け入れます。 パラメーター値は、 sheetTypeプロパティの値と一致する必要があることに注意してください。 一部の古いライブラリとの互換性が必要なため、このような情報の重複は残りました。
Init（） -すべてのインターフェイスプロパティをリセットします。
以下は、このインターフェイスを使用してシート形式を決定する例です。

 //   KompasObjectPtr kompas; kompas.CreateInstance(L"KOMPAS.Application.5"); //    SheetOptionsPtr SheetOptions; SheetOptions = (ksSheetOptionsPtr)kompas->GetParamStruct(ko_SheetOptions); //  kompas->ksGetSysOptions(SHEET_OPTIONS_EX, SheetOptions); if(SheetOptions->get_sheetType()) ShowMessage(" "); else { //  ksStandartSheetPtr StandartSheet; StandartSheet = (ksStandartSheetPtr)SheetOptions->GetSheetParam(false); ShowMessage(IntToStr(StandartSheet->get_format())); StandartSheet.Unbind(); } //  SheetOptions.Unbind(); kompas->set_Visible(true); kompas.Unbind(); 

この例では、ドキュメントシートのパラメーターを定義します。 非標準サイズの場合、「カスタムシート」という行が表示されます。 標準形式の場合、形式を示す数字が画面に表示されます。 たとえば、私の自宅のコンピューターでは、 4が表示され、シートがA4形式に設定されます（異なる場合があります）。

この例ではドキュメントが作成されていないことに気付いたでしょう。 合理的な疑問が生じます。文書がない場合、プログラムで定義する文書のシート形式ですか？ この例では、新しいドキュメントのデフォルト形式を定義しています。

KOMPASのドキュメントでは、定数SHEET_OPTIONS_EXの類似物として、定数SHEET_OPTIONS （ 3 ）についても言及しています。 ただし、 SHEET_OPTIONS定数は廃止されたと見なされ、一部の古いライブラリとの互換性のために残されています。

背景色

背景色は、 ksViewColorParamインターフェイスによって記述されます。 このインターフェイスのプロパティを検討してください。

BottomColor-遷移色を下げます。モデルドキュメントでのみ使用できます。
色 -背景色。 このプロパティの値が-1の場合、Windowsで設定されたウィンドウの色が使用されます。
TopColor-上部遷移色。モデルドキュメントでのみ使用可能。
UseGradient-勾配遷移の使用のサイン（ true-使用済み、false-使用なし）。
KOMPAS APIドキュメントは、KOMPAS自体のように、どの色表現形式が使用されているかを明示的に示していませんが、APIはRGB形式を使用しています。
ksViewColorParamインターフェイスのメソッドは 1つだけです。
Init（） -すべてのインターフェイスプロパティの値をリセットします。 成功した場合、 trueを返します 。
以下は、このインターフェースの使用例です。

 //   KompasObjectPtr kompas; kompas.CreateInstance(L"KOMPAS.Application.5"); //    ksViewColorParamPtr ViewColor; ViewColor = (ksViewColorParamPtr)kompas->GetParamStruct(ko_ViewColorParam); kompas->ksGetSysOptions(VIEWCOLOR_OPTIONS, ViewColor); DWORD color; color = ViewColor->get_color(); AnsiString str; str = "(0x"+IntToHex(GetRValue(color),2) + ";0x"+IntToHex(GetGValue(color),2) + ";0x"+IntToHex(GetBValue(color),2) + ")"; ShowMessage(str); //  ViewColor.Unbind(); kompas->set_Visible(true); kompas.Unbind(); 

この例では、ドキュメントの作業フィールドの背景色が決定され、赤、緑、青のコンポーネントの形式で画面に表示されます。

データ型オプション

バリアントは、あるタイプの値を格納する変数です。 KOMPASは、 ksLtVariantインターフェイスを使用してオプションを実装します。 多くのプロパティがあり、メインプロパティ-valTypeに関連してそれらを考慮するのが最も便利です 。 このプロパティは、バリアントに格納される値のタイプを設定します。 このプロパティの有効な値、 およびksLtVariantインターフェイスの他のプロパティを以下の表に示します。


表2. ksLtVariantインターフェースのプロパティ

これらの定数は、 ldefin2d.hファイルで宣言されています。
たとえば、 valTypeプロパティの値がltv_Uintである場合、バリアントに格納されている値はuIntValプロパティにあります。 valTypeプロパティの値がltv_Doubleに等しい場合、バリアントに格納されている値はdoubleValプロパティにあります。

ksLtVariantインターフェースには1つのメソッドしかありません。
Init（） -すべてのインターフェイスプロパティをリセットします。 成功した場合、 trueを返します 。

ユニット設定

表1によると、 LENGTHUNITS_OPTIONS定数を使用してユニット設定が要求されます。 同時に、 ksGetSysOptionsメソッドは、 ltv_Short型のksLtVariantバリアントを生成します。 このオプションは、次の表に示す有効な値のいずれかを記録します。


表3. ltv_Shortタイプの有効なksLtVariant値

これらの定数は、 ldefin2d.hファイルで宣言されています。
デシメートルの単位はサポートされていないことに注意してください。
以下は、ユニットの定義を示すサンプルプログラムです。

 //   KompasObjectPtr kompas; kompas.CreateInstance(L"KOMPAS.Application.5"); //    ksLtVariantPtr Variant; Variant = (ksLtVariantPtr)kompas->GetParamStruct(ko_LtVariant); kompas->ksGetSysOptions(LENGTHUNITS_OPTIONS, Variant); AnsiString str; switch(Variant->get_shortVal()) { case ST_MIX_MM: str = ""; break; case ST_MIX_SM: str = ""; break; case ST_MIX_DM: str = "" ; break; case ST_MIX_M : str = "" ; break; default: str = ""; } ShowMessage(str); //  Variant.Unbind(); kompas->set_Visible(true); kompas.Unbind(); 

このプログラムは、現在の測定単位を決定し、画面に表示します。
この例では、バリアントがltv_Shortタイプであるという事実に基づいて、バリアントのタイプをチェックしません。 これは、例を単純化するために行いました。 実際のアプリケーションでは、オプションのタイプを常に確認する必要があります。

設定を変更する

設定を変更するには、 KompasObjectインターフェースのksSetSysOptionsメソッドを使用します。 以下は、このメソッドのプロトタイプです。

 long ksSetSysOptions ( long optionsType, //  LPDISPATCH param //   ); 

このメソッドのプロトタイプは、 ksGetSysOptionsメソッドのプロトタイプに似ていることが簡単にわかります。 設定のタイプとそれを説明するインターフェースの関係も表1で決定されます。成功した場合、 ksSetSysOptionsメソッドは1を返し、エラーの場合はzeroを返します 。
変更された設定は、現在のCOMPASSセッション中にのみ「存在」することに注意してください。 再起動後、すべての設定は元の値に戻ります。
以下は、 ksSetSysOptionsメソッドを使用してドキュメントの背景色を変更する例を示すプログラムの例です。

 //   KompasObjectPtr kompas; kompas.CreateInstance(L"KOMPAS.Application.5"); //   kompas->set_Visible(true); //   DocumentParamPtr DocumentParam; DocumentParam=(DocumentParamPtr)kompas->GetParamStruct(ko_DocumentParam); DocumentParam->Init(); DocumentParam->type= lt_DocSheetStandart;//    //  Document2DPtr Document2D; Document2D = (Document2DPtr)kompas->Document2D(); Document2D->ksCreateDocument(DocumentParam); //     ViewColorParamPtr ViewColorParam; ViewColorParam = (ViewColorParamPtr)kompas->GetParamStruct(ko_ViewColorParam); ViewColorParam->set_color(RGB(0,0xFF,0)); //   kompas->ksSetSysOptions(VIEWCOLOR_OPTIONS, ViewColorParam); //  ViewColorParam.Unbind(); DocumentParam.Unbind(); Document2D.Unbind(); kompas.Unbind(); 

この例では、背景色を緑に設定します。
注：設定を変更する前に、COMPASSはほぼすぐに表示されます。 設定を変更した後にCOMPASSが表示される場合、 ksSetSysOptionsメソッドは1を返しますが、COMPASSは変更されません。
残念ながら、 ksSetSysOptionsメソッドではドキュメントシートの形式を変更できません。

KsGetDocOptionsおよびksSetDocOptionsメソッド

ksDocument2Dインターフェースには、 KospasObjectインターフェースのksGetSysOptionsおよびksSetSysOptionsメソッドに類似したksGetDocOptionsおよびksSetDocOptionsメソッドが含まれています。 これらのメソッドはすべて同じプロトタイプを備えており、任意の設定を読み取る（変更する）ことができます。 違いは、 ksDocument2Dインターフェイスメソッドはシステム全体の設定を返さず （変更）、1つのドキュメントのみを返すことです。

KompasObjectインターフェースには、 ksGetDocOptionsおよびksSetDocOptionsメソッドも含まれています 。 これらは、同じ名前のksDocument2Dインターフェイスメソッドに似ており、現在のドキュメントの設定を返します（変更します）。
（両方のインターフェースの） ksGetDocOptionsメソッドには、 ksGetSysOptionsメソッドとの1つの（ドキュメント化されていない）違いがあります。 SHEET_OPTIONS_EXの設定は少し異なります。 ksGetSysOptionsメソッドが成功した場合に常に1を返す場合、これはksGetDocOptionsメソッドには当てはまりません。 返される値は、ドキュメントのタイプ（標準かどうか）によって異なります。 成功した場合、標準ドキュメントの場合はlt_DocSheetStandart （ 1 ）を、非標準ドキュメントの場合はlt_DocSheetUser （ 2 ）を返します。

マルチシートドキュメントの場合、 ksGetDocOptionsメソッドはドキュメントの最初のシートについてのみSHEET_OPTIONS_EX設定を返します。 後続のシートの形式は、APIバージョン5インターフェイスを使用して決定できません。 これを行うには、APIバージョン7インターフェースを使用します。

ksSetDocOptionsメソッドと同様に、（両方のインターフェイスの） ksSetDocOptionsメソッドでは 、ドキュメント形式を変更できません。

おわりに
この記事では、プロパティについて説明しました。 残念ながら、1つの記事の枠組みの中で、それらすべてを詳細に説明することは不可能です。 特に、重複するオブジェクトの設定とサイズの設定は考慮しませんでしたが、それほど複雑ではありません。

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

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