JavaFXの2D形状におけるstrokeDashOffsetプロパティの使い方を解説

JavaFXでは、図形の枠線（ストローク）に破線パターンを適用できます。このとき、strokeDashOffsetプロパティを使用すると、破線パターンの中でどの位置から描画を開始するかを指定することができます。

strokeDashOffsetプロパティとは

ストロークに破線パターンが設定されている場合、strokeDashOffsetプロパティは破線パターン内のオフセット（ずらし幅）を指定します。これは「ダッシュフェーズ」とも呼ばれ、ストロークの開始点に対応する破線パターン上の位置を定義する役割を持ちます。

たとえば、オフセット値を変更することで、同じ破線パターンでありながら、線の見え方（切れ目の位置）を調整できるのです。

サンプルコード

以下の例では、LineとPolygonという2つの図形を作成し、それぞれに異なるstrokeDashOffsetの値を設定して、表示の違いを確認します。

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.scene.paint.Color;
import javafx.scene.shape.Line;
import javafx.scene.shape.Polygon;
import javafx.stage.Stage;

public class StrokeDashOffset extends Application {
   public void start(Stage stage) {
      // オフセット5の直線
      Line shape1 = new Line(25.0, 50.0, 565.0, 50.0);
      shape1.setStroke(Color.BROWN);
      shape1.setStrokeWidth(10);
      shape1.getStrokeDashArray().addAll(80.0, 70.0, 60.0, 50.0, 40.0);
      shape1.setStrokeDashOffset(5);

      // オフセット40の多角形
      Polygon shape2 = new Polygon(25.0, 150.0, 565.0, 150.0);
      shape2.setStroke(Color.CRIMSON);
      shape2.setStrokeWidth(10.0);
      shape2.getStrokeDashArray().addAll(80.0, 70.0, 60.0, 50.0, 40.0);
      shape2.setStrokeDashOffset(40);

      // Groupオブジェクトの作成
      Group root = new Group(shape1, shape2);

      // Sceneオブジェクトの作成
      Scene scene = new Scene(root, 595, 200);

      // Stageにタイトルを設定
      stage.setTitle("Stroke Dash Offset Example");

      // SceneをStageに追加
      stage.setScene(scene);

      // Stageの内容を表示
      stage.show();
   }

   public static void main(String args[]) {
      launch(args);
   }
}

コードのポイント

• getStrokeDashArray()：破線の長さと間隔のパターンをリストとして設定します。この例では「80, 70, 60, 50, 40」という繰り返しパターンを指定しています。
• setStrokeDashOffset()：破線パターンの開始位置をずらすオフセット値を設定します。shape1には「5」、shape2には「40」を指定しており、それぞれ破線の見え方が変化します。
• setStrokeWidth()：ストロークの太さを指定しています（どちらも10px）。

実行結果

プログラムを実行すると、以下のように2つの図形が表示されます。同じ破線パターンでも、オフセット値の違いによって破線の開始位置がずれていることが確認できます。