tool.Graph3D ライブラリ APIライブラリ(以下、Graph3D ライブラリライブラリ)は、3次元グラフソフトウェアを制御するためのライブラリです。
Graph3D ライブラリ ライブラリは拡張ライブラリであり、VCSSLの言語仕様における標準ライブラリには含まれていません。従って、全てのVCSSL処理系において、必ずしもGraph3D ライブラリ ライブラリの実装がサポートされるわけではありません。
Graph3D ライブラリ ライブラリの仕様は、広く一般的な2次元グラフソフトウェアをVCSSLから制御する事を想定して定義されており、特定の2次元グラフソフトウェアを前提としたものではありません。 Graph3D ライブラリ ライブラリの実装において、制御対象にどのような2次元グラフソフトウェアが採用されるかは処理系依存であり、処理系の開発元(ベンダー)、バージョン、またはグラフソフトウェアとの通信機能を提供するプラグインなどに依存します。このような事情があるため、Graph3D ライブラリ ライブラリが提供する各種関数も、異なる処理系に関しては、厳密に同一の挙動を期待すべきではありません。
また、同一の処理系であっても、Graph3D ライブラリ ライブラリは標準ライブラリでは無いため、その実装において、恒久的に同様の挙動が保証されるものではありません。Graph3D ライブラリ ライブラリの実装は、あくまで処理系が独自にサポートする拡張機能であるという点に留意しておく必要があります。例えば、グラフソフトウェアの大幅なアップデートが行われると、 それに伴い、Graph3D ライブラリ ライブラリの挙動も微妙に変化してしまうケースなどが考えられます。
RINEARN VCSSLランタイム、及びそれを搭載するVCSSL対応ソフトウェア(リニアンプロセッサーなど)では、Graph3D ライブラリ ライブラリをサポートしており、その実装には科学技術分野用グラフソフトウェア「 リニアングラフ3D 」を採用しています。リニアングラフ2D本体( RinearnGraph3D ライブラリ.jar )はVCSSLランタイムの配布パッケージ内に同梱されているため、別途何かを用意する必要はありません。
- なし - None -
- なし - None -
定義 - Signature |
int newGraph3D() |
詳細 - Details |
3次元グラフをデフォルトのサイズで生成し、それに固有の識別番号 ( グラフID ) を割り振って返します。 |
戻り値 - Return |
生成したグラフのID |
定義 - Signature |
int newGraph3D( int x, int y, int width, int height, string title ) |
詳細 - Details |
3次元グラフを指定されたサイズで生成し、それに固有の識別番号 ( グラフID ) を割り振って返します。 |
引数 - Arguments |
x : グラフウィンドウ左上頂点のX座標 y : グラフウィンドウ左上頂点のY座標 width : グラフウィンドウの幅 height : グラフウィンドウの高さ title : グラフウィンドウタイトル |
戻り値 - Return |
生成したグラフのID |
定義 - Signature |
int getGraph3D() |
詳細 - Details |
処理系で起動・確保されている特別なグラフがあれば、そのグラフIDを取得します。無ければ新規生成します。 |
戻り値 - Return |
取得または生成したグラフID |
定義 - Signature |
void deleteGraph3D( int graphID ) |
詳細 - Details |
グラフを破棄します。 |
引数 - Arguments |
graphID : 対象グラフのID |
定義 - Signature |
void clearGraph3D( int graphID ) |
詳細 - Details |
グラフの内容をクリアします。 |
引数 - Arguments |
graphID : 対象グラフのID |
定義 - Signature |
int getGraph3DGraphics( int graphID ) |
詳細 - Details |
グラフの保持している描画内容を、Graphicsライブラリ互換のグラフィックスデータに変換します。変換されたグラフィックスデータは、2D/3Dレンダラ―などで加工できます。 |
引数 - Arguments |
graphID : 対象グラフのID |
戻り値 - Return |
グラフィックスデータID |
定義 - Signature |
void setGraph3DLocation( int graphID, int x, int y ) |
詳細 - Details |
グラフウィンドウの位置を設定します。 |
引数 - Arguments |
graphID : 対象グラフのID x : グラフウィンドウ左上頂点のX座標 y : グラフウィンドウ左上頂点のY座標 |
定義 - Signature |
void setGraph3DSize( int graphID, int width, int height ) |
詳細 - Details |
グラフウィンドウの大きさを設定します。 |
引数 - Arguments |
graphID : 対象グラフのID width : グラフウィンドウの幅 height : グラフウィンドウ高さ |
定義 - Signature |
void hideGraph3D( int graphID ) |
詳細 - Details |
グラフウィンドウを不可視化します。 |
引数 - Arguments |
graphID : 対象グラフのID |
定義 - Signature |
void showGraph3D( int graphID ) |
詳細 - Details |
グラフウィンドウを可視化します。 |
引数 - Arguments |
graphID : 対象グラフのID |
定義 - Signature |
void setGraph3DFile( int graphID, string filePath ) |
詳細 - Details |
ファイルを読み込み、グラフにプロットします。 |
引数 - Arguments |
graphID : 対象グラフのID filePath : プロットするファイルのファイル名またはパス |
定義 - Signature |
void setGraph3DFile( int graphID, string file[ ] ) |
詳細 - Details |
複数のファイルを読み込み、グラフにプロットします。 |
引数 - Arguments |
graphID : 対象グラフのID file : プロットするファイルのファイル名またはパス |
定義 - Signature |
void setGraph3DData( int graphID, string data ) |
詳細 - Details |
ファイルの内容と同じ書式で記載されたテキストを読み込み、グラフにプロットします。 |
引数 - Arguments |
graphID : 対象グラフのID data : ファイルの内容と同じ書式で記載されたテキスト |
定義 - Signature |
void setGraph3DData( int graphID, float dataX[ ], float dataY[ ], float dataZ[ ] ) |
詳細 - Details |
座標値を格納する float 型配列を読み込み、グラフにプロットします。 |
引数 - Arguments |
graphID : 対象グラフのID dataX : X座標を格納する配列( [ 点インデックス ] ) dataY : Y座標を格納する配列( [ 点インデックス ] ) dataZ : Z座標を格納する配列( [ 点インデックス ] ) |
定義 - Signature |
void setGraph3DData( int graphID, float dataX[ ][ ], float dataY[ ][ ], float dataZ[ ][ ] ) |
詳細 - Details |
座標値を格納する float 型配列を読み込み、グラフにプロットします。 |
引数 - Arguments |
graphID : 対象グラフのID dataX : X座標を格納する配列( [ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataY : Y座標を格納する配列( [ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataZ : Z座標を格納する配列( [ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) |
定義 - Signature |
void setGraph3DData( int graphID, float dataX[ ][ ][ ], float dataY[ ][ ][ ], float dataZ[ ][ ][ ] ) |
詳細 - Details |
座標値を格納する float 型配列を読み込み、グラフにプロットします。 |
引数 - Arguments |
graphID : 対象グラフのID dataX : X座標を格納する配列( [ 系列インデックス ][ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataY : Y座標を格納する配列( [ 系列インデックス ][ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataZ : Z座標を格納する配列( [ 系列インデックス ][ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) |
定義 - Signature |
void addGraph3DData( int graphID, float dataX[ ], float dataY[ ], float dataZ[ ] ) |
詳細 - Details |
座標値を格納する float 型配列を読み込み、グラフに追記プロットします。 |
引数 - Arguments |
graphID : 対象グラフのID dataX : X座標を格納する配列( [ 点インデックス ] ) dataY : Y座標を格納する配列( [ 点インデックス ] ) dataZ : Z座標を格納する配列( [ 点インデックス ] ) |
定義 - Signature |
void addGraph3DData( int graphID, float dataX[ ][ ], float dataY[ ][ ], float dataZ[ ][ ] ) |
詳細 - Details |
座標値を格納する float 型配列を読み込み、グラフに追記プロットします。 |
引数 - Arguments |
graphID : 対象グラフのID dataX : X座標を格納する配列( [ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataY : Y座標を格納する配列( [ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataZ : Z座標を格納する配列( [ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) |
定義 - Signature |
void addGraph3DData( int graphID, float dataX[ ][ ][ ], float dataY[ ][ ][ ], float dataZ[ ][ ][ ] ) |
詳細 - Details |
座標値を格納する float 型配列を読み込み、グラフに追記プロットします。 |
引数 - Arguments |
graphID : 対象グラフのID dataX : X座標を格納する配列( [ 系列インデックス ][ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataY : Y座標を格納する配列( [ 系列インデックス ][ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) dataZ : Z座標を格納する配列( [ 系列インデックス ][ メッシュ上のY方向インデックス ][ メッシュ上のX方向インデックス ] ) |
定義 - Signature |
void setGraph3DConfigurationFile( int graphID, string file ) |
詳細 - Details |
設定ファイルを読み込み、グラフに自動で設定を行います。 |
引数 - Arguments |
graphID : 対象グラフのID file : 設定ファイルのファイル名またはパス |
定義 - Signature |
void setGraph3DRange( int graphID, double xMin, double xMax, double yMin, double yMax, double zMin, double zMax ) |
詳細 - Details |
プロット範囲を設定します。 |
引数 - Arguments |
graphID : 対象グラフのID xMin : X軸の最小値 xMax : X軸の最大値 yMin : Y軸の最小値 yMax : Y軸の最大値 zMin : Z軸の最小値 zMax : Z軸の最大値 |
定義 - Signature |
void setGraph3DRangeX( int graphID, double xMin, double xMax ) |
詳細 - Details |
X軸のプロット範囲を設定します。 |
引数 - Arguments |
graphID : 対象グラフのID xMin : X軸の最小値 xMax : X軸の最大値 |
定義 - Signature |
void setGraph3DRangeY( int graphID, double yMin, double yMax ) |
詳細 - Details |
Y軸のプロット範囲を設定します。 |
引数 - Arguments |
graphID : 対象グラフのID yMin : Y軸の最小値 yMax : Y軸の最大値 |
定義 - Signature |
void setGraph3DRangeZ( int graphID, double zMin, double zMax ) |
詳細 - Details |
Z軸のプロット範囲を設定します。 |
引数 - Arguments |
graphID : 対象グラフのID zMin : Z軸の最小値 zMax : Z軸の最大値 |
定義 - Signature |
void setGraph3DAutoRange( int graphID, bool autoX, bool autoY, bool autoZ ) |
詳細 - Details |
プロット範囲の自動調整機能を有効化または無効化します。 |
引数 - Arguments |
graphID : 対象グラフのID autoX : X軸方向の自動調性機能を有効にするならtrue、無効にするならfalse autoY : Y軸方向の自動調性機能を有効にするならtrue、無効にするならfalse autoZ : Z軸方向の自動調性機能を有効にするならtrue、無効にするならfalse |
定義 - Signature |
void setGraph3DOption( int graphID, string option, bool value ) |
詳細 - Details |
グラフのオプション項目を設定します。項目名は処理系に依存します。代表的なオプション項目名は以下の通りです:
|
引数 - Arguments |
graphID : 対象グラフのID option : オプション項目名 value : オプションを有効にするならtrue、無効にするにはfalse |
定義 - Signature |
void setGraph3DMenu( int graphID, string option, string value ) |
詳細 - Details |
グラフのメニュー項目を設定します。項目名は処理系に依存します。代表的なオプション項目名は以下の通りです:
|
引数 - Arguments |
graphID : 対象グラフのID option : メニュー項目名 value : メニュー項目を有効にするならtrue、無効にするにはfalse |
定義 - Signature |
void setGraph3DAnimation( int graphID, string option, bool state ) |
詳細 - Details |
グラフのアニメーションを有効化または無効化します。利用可能なアニメーションモードは処理系に依存します。代表的なアニメーションモードは以下の通りです:
|
引数 - Arguments |
graphID : 対象グラフのID mode : アニメーションモード state : アニメーションを有効化するならtrue、無効化するならfalse |
定義 - Signature |
void exportGraph3D( int graphID, string filename, string format ) |
詳細 - Details |
グラフを画像に出力します。 |
引数 - Arguments |
graphID : 対象グラフのID filename : 出力ファイル名またはパス 形式( : "PNG" または "JPEG" ) |
定義 - Signature |
void exportGraph3D( int graphID, string filename, string format, float quality ) |
詳細 - Details |
グラフを画像に出力します。 |
引数 - Arguments |
graphID : 対象グラフのID filename : 出力ファイル名またはパス 形式( : "PNG" または "JPEG" ) quality : 品質( 0.0 ~ 100.0 ) |
定義 - Signature |
void onGraph2DClose( int graphID ) |
詳細 - Details |
グラフウィンドウが閉じられた際にコールされます。 |
引数 - Arguments |
graphID : イベント発生元グラフのID |