パッケージ com.rinearn.graph2d

クラス RinearnGraph2D

java.lang.Object
com.rinearn.graph2d.RinearnGraph2D
public class RinearnGraph2D extends Object
2次元グラフソフト「リニアングラフ2D (RINEARN Graph 2D)」を、Java言語のコードから操作するためのAPIクラスです。

  • コンストラクタの概要

    コンストラクタ
    コンストラクタ
    説明
    RinearnGraph2D()
    インスタンスを生成し、グラフを起動します。

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    void
    addKeyListener​(KeyListener listener)
    グラフのスクリーン上における、キーイベントのリスナーを追加登録します。
    void
    addMouseListener​(MouseListener listener)
    グラフのスクリーン上における、マウスイベントのリスナーを追加登録します。
    void
    addMouseMotionListener​(MouseMotionListener listener)
    グラフのスクリーン上における、マウスモーションイベントのリスナーを追加登録します。
    void
    addMouseWheelListener​(MouseWheelListener listener)
    グラフのスクリーン上における、マウスホイールイベントのリスナーを追加登録します。
    void
    addPlottingListener​(RinearnGraph2DPlottingListener listener)
    再プロットが必要になった際に発行される RinearnGraph2DPlottingEvent を受け取る、RinearnGraph2DPlottingListener インタフェースを実装したイベントリスナーを登録します。
    void
    addWindowListener​(WindowListener listener)
    ウィンドウイベントのリスナーを追加登録します。
    void
    appendData​(double[][] x, double[][] y)
    グラフにプロットする座標値データを、現在の内容を保持したまま追加します。
    void
    appendData​(double[] x, double[] y)
    グラフにプロットする座標値データを、現在の内容を保持したまま追加します。
    void
    clear()
    現在のグラフの内容を消去します。
    void
    dispose()
    グラフを終了し、リソースを破棄します。
    void
    exportImageFile​(File file, double quality)
    現在のグラフの描画内容を、画像ファイルに出力します。
    Image
    getImage()
    現在のグラフの描画内容を表す java.awt.Image オブジェクトを返します。
    RinearnGraph2DRenderer
    getRenderer()
    グラフ画面を描画するのに使用されている描画エンジン（レンダラー）を返します。
    boolean
    isAsynchronousPlottingEnabled()
    非同期プロット機能の有効・無効状態を取得します。
    boolean
    isOptionSelected​(RinearnGraph2DOptionItem option)
    プロットオプションの選択状態を取得します。
    boolean
    isXAutoRangingEnabled()
    描画範囲の自動調整機能(X軸方向)の有効/無効を取得します。
    boolean
    isYAutoRangingEnabled()
    描画範囲の自動調整機能(Y軸方向)の有効/無効を取得します。
    void
    loadConfigurationFile​(File file)
    設定ファイルを読み込みます。
    void
    openDataFile​(File file)
    座標値データが記載されたファイルを開き、その内容をグラフにプロットします。
    void
    openDataFiles​(File[] files)
    座標値データが記載されたファイルを複数開き、その内容をグラフにプロットします。
    void
    setAsynchronousPlottingEnabled​(boolean state)
    非同期プロット機能の有効・無効を設定します。
    void
    setAutoDisposingEnabled​(boolean state)
    グラフのウィンドウを閉じた時点で、グラフを終了し、リソースを破棄する機能の有効/無効を設定します。
    void
    setAutoExittingEnabled​(boolean state)
    グラフのウィンドウが閉じられた時点で、上層も含めてアプリケーション全体を終了（ exit ）させる機能の有効/無効を設定します。
    void
    setData​(double[][] x, double[][] y)
    グラフにプロットする座標値データ（このメソッドでは曲面的なデータ）を設定します。
    void
    setData​(double[] x, double[] y)
    グラフにプロットする座標値データ（このメソッドでは曲線的なデータ）を設定します。
    void
    setDefaultMouseListenerEnabled​(boolean state)
    グラフのスクリーン上における、デフォルトのマウスイベントのリスナーの有効/無効を設定します。
    void
    setDefaultMouseMotionListenerEnabled​(boolean state)
    グラフのスクリーン上における、デフォルトのマウスモーションイベントのリスナーの有効/無効を設定します。
    void
    setDefaultMouseWheelListenerEnabled​(boolean state)
    グラフのスクリーン上における、デフォルトのマウスホイールイベントのリスナーの有効/無効を設定します。
    void
    setJMenuBar​(JMenuBar menuBar)
    デフォルトのメニューバーを、指定された JMenuBar で置き換えます。
    void
    setLegends​(String[] legends)
    グラフの凡例を設定します。
    void
    setMenuVisible​(boolean visible)
    メニューバーや右クリックメニューの表示状態を設定します。
    void
    setOptionParameter​(RinearnGraph2DOptionParameter parameter)
    プロットオプションのパラメータを設定します。
    void
    setOptionSelected​(RinearnGraph2DOptionItem option, boolean selected)
    プロットオプションの選択状態を設定します。
    void
    setScreenSize​(int width, int height)
    グラフスクリーンのサイズを設定します。
    void
    setTitle​(String title)
    グラフのタイトルを設定します。
    void
    setWindowBounds​(int x, int y, int width, int height)
    グラフ表示ウィンドウの位置とサイズを設定します。
    void
    setWindowTitle​(String title)
    グラフ表示ウィンドウのタイトルを設定します。
    void
    setWindowVisible​(boolean visible)
    グラフ表示ウィンドウの表示状態を設定します。
    void
    setXAutoRangingEnabled​(boolean state)
    描画範囲の自動調整機能(X軸方向)の有効/無効を設定します。
    void
    setXLabel​(String label)
    X軸の表記を設定します。
    void
    setXRange​(double min, double max)
    X軸方向の描画範囲を設定します。
    void
    setYAutoRangingEnabled​(boolean state)
    描画範囲の自動調整機能(Y軸方向)の有効/無効を設定します。
    void
    setYLabel​(String label)
    Y軸の表記を設定します。
    void
    setYRange​(double min, double max)
    Y軸方向の描画範囲を設定します。

    クラスから継承されたメソッド java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • コンストラクタの詳細

    • RinearnGraph2D

      public RinearnGraph2D()
      インスタンスを生成し、グラフを起動します。

  • メソッドの詳細

    • dispose

      public void dispose()
      グラフを終了し、リソースを破棄します。 この処理は、デフォルトではグラフを閉じた時点で、自動で行われます。 その挙動を変更したい場合は、setAutoDisposingEnabled メソッドで設定を行ってください。

    • getRenderer

      public RinearnGraph2DRenderer getRenderer()
      グラフ画面を描画するのに使用されている描画エンジン（レンダラー）を返します。
      戻り値:
      描画エンジン（レンダラー）

    • openDataFile

      public void openDataFile​(File file) throws FileNotFoundException, IOException
      座標値データが記載されたファイルを開き、その内容をグラフにプロットします。
      パラメータ:
      file - プロットする座標値ファイル
      例外:
      FileNotFoundException - 指定されたファイルが存在しない場合にスローされます。
      IOException - ファイルの入出力時に問題が発生した場合にスローされる可能性があります(バージョン依存)。

    • openDataFiles

      public void openDataFiles​(File[] files) throws FileNotFoundException, IOException
      座標値データが記載されたファイルを複数開き、その内容をグラフにプロットします。
      パラメータ:
      files - プロットする座標値ファイルが格納された配列
      例外:
      FileNotFoundException - 指定されたファイルが存在しない場合にスローされます。
      IOException - ファイルの入出力時に問題が発生した場合にスローされる可能性があります(バージョン依存)。

    • clear

      public void clear()
      現在のグラフの内容を消去します。描画内容だけでなく、保持している座標値データも消去されます。

    • getImage

      public Image getImage()
      現在のグラフの描画内容を表す java.awt.Image オブジェクトを返します。
      戻り値:
      グラフの描画内容を表すImage

    • setWindowBounds

      public void setWindowBounds​(int x, int y, int width, int height)
      グラフ表示ウィンドウの位置とサイズを設定します。 変更後のウィンドウのサイズに合わせて、グラフスクリーンのサイズも変更されます。 なお、グラフスクリーンのサイズは、ウィンドウのサイズよりも若干小さくなり、 その差はバージョンや環境に依存する事に注意してください。 画像出力用途などで、グラフスクリーンのサイズを明示的に指定したい場合は、 setScreenSize 代わりにメソッドを使用してください。
      パラメータ:
      x - ウィンドウ左上のX座標
      y - ウィンドウ左上のY座標
      width - ウィンドウの幅
      height - ウィンドウの高さ

    • setWindowTitle

      public void setWindowTitle​(String title)
      グラフ表示ウィンドウのタイトルを設定します。
      パラメータ:
      title - ウィンドウのタイトル

    • setWindowVisible

      public void setWindowVisible​(boolean visible)
      グラフ表示ウィンドウの表示状態を設定します。
      パラメータ:
      visible - ウィンドウの表示状態(falseの場合に表示されない)

    • setScreenSize

      public void setScreenSize​(int width, int height)
      グラフスクリーンのサイズを設定します。 変更後のスクリーンサイズに合わせて、ウィンドウのサイズも自動で変更されます。
      パラメータ:
      width - スクリーンの幅
      height - スクリーンの高さ

    • setAutoDisposingEnabled

      public void setAutoDisposingEnabled​(boolean state)
      グラフのウィンドウを閉じた時点で、グラフを終了し、リソースを破棄する機能の有効/無効を設定します。 この機能はデフォルトで有効になっています。
      パラメータ:
      state - 自動終了機能の状態(trueなら有効)

    • setAutoExittingEnabled

      public void setAutoExittingEnabled​(boolean state)
      グラフのウィンドウが閉じられた時点で、上層も含めてアプリケーション全体を終了（ exit ）させる機能の有効/無効を設定します。 この機能はデフォルトでは無効です。
      パラメータ:
      state - 自動終了機能の状態(trueなら有効)

    • setXRange

      public void setXRange​(double min, double max)
      X軸方向の描画範囲を設定します。
      パラメータ:
      min - 範囲の最小値
      max - 範囲の最大値

    • setYRange

      public void setYRange​(double min, double max)
      Y軸方向の描画範囲を設定します。
      パラメータ:
      min - 範囲の最小値
      max - 範囲の最大値

    • setXAutoRangingEnabled

      public void setXAutoRangingEnabled​(boolean state)
      描画範囲の自動調整機能(X軸方向)の有効/無効を設定します。
      パラメータ:
      state - 自動調整機能の状態(trueなら有効)

    • setYAutoRangingEnabled

      public void setYAutoRangingEnabled​(boolean state)
      描画範囲の自動調整機能(Y軸方向)の有効/無効を設定します。
      パラメータ:
      state - 自動調整機能の状態(trueなら有効)

    • isXAutoRangingEnabled

      public boolean isXAutoRangingEnabled()
      描画範囲の自動調整機能(X軸方向)の有効/無効を取得します。
      戻り値:
      state 自動調整機能の状態(trueなら有効)

    • isYAutoRangingEnabled

      public boolean isYAutoRangingEnabled()
      描画範囲の自動調整機能(Y軸方向)の有効/無効を取得します。
      戻り値:
      state 自動調整機能の状態(trueなら有効)

    • setXLabel

      public void setXLabel​(String label)
      X軸の表記を設定します。
      パラメータ:
      label - X軸の表記内容

    • setYLabel

      public void setYLabel​(String label)
      Y軸の表記を設定します。
      パラメータ:
      label - Y軸の表記内容

    • setTitle

      public void setTitle​(String title)
      グラフのタイトルを設定します。
      パラメータ:
      title - タイトル

    • setLegends

      public void setLegends​(String[] legends)
      グラフの凡例を設定します。 なお、openDataFile メソッドや setData メソッドなどでプロット対象のデータを変更すると、 凡例設定はクリアされます。 必要に応じて、その都度、新しいデータに対する凡例を再設定してください。
      パラメータ:
      legends - 凡例を格納する配列

    • setOptionSelected

      public void setOptionSelected​(RinearnGraph2DOptionItem option, boolean selected)
      プロットオプションの選択状態を設定します。 プロットオプションの項目は列挙型 RinearnGraph2DOptionItem の項目で指定します。
      パラメータ:
      option - プロットオプションの項目
      selected - 選択状態(trueなら有効化)

    • isOptionSelected

      public boolean isOptionSelected​(RinearnGraph2DOptionItem option)
      プロットオプションの選択状態を取得します。 プロットオプションの項目は列挙型 RinearnGraph2DOptionItem の項目で指定します。
      パラメータ:
      option - プロットオプションの項目
      戻り値:
      選択状態(trueなら有効化)

    • setOptionParameter

      public void setOptionParameter​(RinearnGraph2DOptionParameter parameter)
      プロットオプションのパラメータを設定します。 パラメータの設定状態は RinearnGraph2DOptionParameter クラスのインスタンスで指定します。
      パラメータ:
      parameter - パラメータの設定状態を保持するRinearnGraph2DOptionParameterインスタンス

    • setAsynchronousPlottingEnabled

      public void setAsynchronousPlottingEnabled​(boolean state)
      非同期プロット機能の有効・無効を設定します。 この機能の有効・無効は、setData(double[], double[]) メソッドなどを連続的に呼び出し続けて、大量の座標値データをグラフにプロットさせ続ける場合の振る舞いに影響します。 この機能が無効の場合は、座標値データを渡した際、それがグラフにプロットされた後に、呼び出し元に処理が戻ります。 渡したデータが確実にプロットされるため、プロット結果を画像ファイルに出力するような場合に適しています。 それに対して、この機能が有効の場合は、座標値データは一時的なバッファ領域に控えられるだけで、すぐに呼び出し元に処理が戻ります。 そして、バッファされたデータは、後の適当なタイミングでグラフにプロットされます。 そのため、外部装置などから入力されるデータを、リアルタイムにアニメーションさせて可視化したいような場合に適しています。 なお、この機能はデフォルトでは無効になっています。
      パラメータ:
      state - 非同期プロット機能の有効・無効の状態(trueなら有効)

    • isAsynchronousPlottingEnabled

      public boolean isAsynchronousPlottingEnabled()
      非同期プロット機能の有効・無効状態を取得します。
      戻り値:
      バッファリング機能の有効・無効の状態(trueなら有効)

    • setData

      public void setData​(double[] x, double[] y)
      グラフにプロットする座標値データ（このメソッドでは曲線的なデータ）を設定します。 引数には、曲線上の点の番号をインデックスとして、各点における座標のX値、Y値を格納する配列を渡してください。 なお、このメソッドの呼び出し元に処理が返ってくるのは、通常はグラフのプロット完了後のタイミングです。 しかし、座標値データのバッファリング機能が有効の場合は、プロット完了を待たずに、すぐに呼び出し元に処理が返されます。 詳細は setAsynchronousPlottingEnabled メソッドの項目を参照してください。 また、このメソッドを実行すると、凡例の設定はクリアされます。 必要に応じて、setLegends メソッドを使用し、新しいデータに対する凡例を再設定してください。
      パラメータ:
      x - 座標値データのX値を格納する配列
      y - 座標値データのY値を格納する配列

    • setData

      public void setData​(double[][] x, double[][] y)
      グラフにプロットする座標値データ（このメソッドでは曲面的なデータ）を設定します。 引数には、曲面上の格子点の番号を2次元的なインデックスとして、各格子点における座標のX値、Y値を格納する配列を渡してください。 なお、このメソッドの呼び出し元に処理が返ってくるのは、通常はグラフのプロット完了後のタイミングです。 しかし、座標値データのバッファリング機能が有効の場合は、プロット完了を待たずに、すぐに呼び出し元に処理が返されます。 詳細は setAsynchronousPlottingEnabled メソッドの項目を参照してください。
      パラメータ:
      x - 座標値データのX値を格納する配列
      y - 座標値データのY値を格納する配列

    • appendData

      public void appendData​(double[] x, double[] y)
      グラフにプロットする座標値データを、現在の内容を保持したまま追加します。 なお、このメソッドは現時点において、座標値データのバッファリング機能には未対応です。
      パラメータ:
      x - 追加する座標値データのX値を格納する配列
      y - 追加する座標値データのY値を格納する配列

    • appendData

      public void appendData​(double[][] x, double[][] y)
      グラフにプロットする座標値データを、現在の内容を保持したまま追加します。 なお、このメソッドは現時点において、座標値データのバッファリング機能には未対応です。
      パラメータ:
      x - 追加する座標値データのX値を格納する配列
      y - 追加する座標値データのY値を格納する配列

    • loadConfigurationFile

      public void loadConfigurationFile​(File file) throws FileNotFoundException, IOException
      設定ファイルを読み込みます。
      パラメータ:
      file - 設定ファイル
      例外:
      FileNotFoundException - 指定されたファイルが存在しない場合にスローされます。
      IOException - ファイルの入出力時に問題が発生した場合にスローされる可能性があります(バージョン依存)。

    • exportImageFile

      public void exportImageFile​(File file, double quality) throws IOException
      現在のグラフの描画内容を、画像ファイルに出力します。画像形式は、ファイルの拡張子で判断されます。現時点では「JPEG(.jpg)」、「PNG(.png)」、「BMP(.bmp)」の画像形式のみがサポートされています。
      パラメータ:
      file - 出力する画像ファイル
      quality - 画質(0.0から1.0までの範囲)
      例外:
      IOException - ファイルの出力に失敗したか、対応していない画像形式であった場合にスローされます。

    • setMenuVisible

      public void setMenuVisible​(boolean visible)
      メニューバーや右クリックメニューの表示状態を設定します。 なお、setJMenuBar メソッドにより外部から設定したメニューバーの表示状態は、 このメソッドによる設定の影響を受けません。
      パラメータ:
      visible - メニューの表示状態(falseの場合に表示されない)

    • setJMenuBar

      public void setJMenuBar​(JMenuBar menuBar)
      デフォルトのメニューバーを、指定された JMenuBar で置き換えます。
      パラメータ:
      menuBar - メニューバー

    • addPlottingListener

      public void addPlottingListener​(RinearnGraph2DPlottingListener listener)
      再プロットが必要になった際に発行される RinearnGraph2DPlottingEvent を受け取る、RinearnGraph2DPlottingListener インタフェースを実装したイベントリスナーを登録します。
      パラメータ:
      listener - イベントリスナ

    • addWindowListener

      public void addWindowListener​(WindowListener listener)
      ウィンドウイベントのリスナーを追加登録します。 ユーザーがグラフ画面を閉じた際に、 setAutoDisposingEnabled(boolean) や setAutoExittingEnabled(boolean) メソッドでの設定機能では実現できない、独自の終了時処理を実装したい場合などに使用します。
      パラメータ:
      listener - ウィンドウイベントのリスナー

    • addKeyListener

      public void addKeyListener​(KeyListener listener)
      グラフのスクリーン上における、キーイベントのリスナーを追加登録します。
      パラメータ:
      listener - イベントリスナー

    • addMouseListener

      public void addMouseListener​(MouseListener listener)
      グラフのスクリーン上における、マウスイベントのリスナーを追加登録します。
      パラメータ:
      listener - イベントリスナー

    • setDefaultMouseListenerEnabled

      public void setDefaultMouseListenerEnabled​(boolean state)
      グラフのスクリーン上における、デフォルトのマウスイベントのリスナーの有効/無効を設定します。
      パラメータ:
      state - デフォルトのリスナーの状態(trueなら有効)

    • addMouseMotionListener

      public void addMouseMotionListener​(MouseMotionListener listener)
      グラフのスクリーン上における、マウスモーションイベントのリスナーを追加登録します。
      パラメータ:
      listener - イベントリスナー

    • setDefaultMouseMotionListenerEnabled

      public void setDefaultMouseMotionListenerEnabled​(boolean state)
      グラフのスクリーン上における、デフォルトのマウスモーションイベントのリスナーの有効/無効を設定します。
      パラメータ:
      state - デフォルトのリスナーの状態(trueなら有効)

    • addMouseWheelListener

      public void addMouseWheelListener​(MouseWheelListener listener)
      グラフのスクリーン上における、マウスホイールイベントのリスナーを追加登録します。
      パラメータ:
      listener - イベントリスナー

    • setDefaultMouseWheelListenerEnabled

      public void setDefaultMouseWheelListenerEnabled​(boolean state)
      グラフのスクリーン上における、デフォルトのマウスホイールイベントのリスナーの有効/無効を設定します。
      パラメータ:
      state - デフォルトのリスナーの状態(trueなら有効)