ProcessingでXファイルを解析（スタティックメッシュ篇その1）

今日は、DirectX で標準的に使用されていた X ファイルを読み込んで、Processing で表示してみたいと思います。 すなわち ——

Metasequoia にプリセットされている「日本橋麒麟像」

こんなふうに任意のモデリングソフトで作成したデータを、

上図のように、Processing でそのまま使えるようにしてしまおうという試みです。

しかし僕がアホすぎるせいで、まだ静止した 3D モデルの幾何形状だけしか読めていませんごめんなさい（アニメーションはおろか物体の色付けやテクスチャも無し）。

---

この課題の一番のネックは X ファイルのパーサです。

X のフォーマットはそれなりに自由度が高く、使用するモデリングソフトによって構造が変わったりします。 すべての状況に適応できる汎用性の高いコードを本気で書こうとすると、割と本格的な構文解析器を実装する必要があるような気がして心が折れます。

というわけで、個人的にはひとまず姑息的なパーサを手っ取り早く作り、なんか問題が起きたら適宜設計を見直しつつ修正していこうかと思います。

---

とりあえずXファイル読み込み関連をまとめたプログラム（長いので折りたたんであります）。

+ expand sourceview plainprint?

1. // -------------------------------------------------  
2. // =================================================  
3. // Xファイル形式で記述されたメッシュを表示するテスト  
4. //                    スタティックメッシュ篇不完全版  
5. // =================================================  
6. // -------------------------------------------------  
7.   
8.   
9. // =================================================  
10.   
11. // メッシュ  
12. class Mesh {  
13.   List<Polygon> polygons;  
14.     
15.   public Mesh() {  
16.     polygons = new ArrayList<Polygon>();  
17.   }  
18.     
19.   public void add(Polygon p) {  
20.     polygons.add(p);  
21.   }  
22.     
23.   public void render() {  
24.     if(polygons == null) return;  
25.       
26.     for(Polygon p : polygons) p.render();  
27.   }  
28. }  
29.   
30. // =================================================  
31.   
32. // ポリゴン  
33. class Polygon {  
34.   List<PVector> vertices;  
35.     
36.   public Polygon() {  
37.     vertices = new ArrayList<PVector>();  
38.   }  
39.     
40.   public void add(PVector v) {  
41.     vertices.add(v);  
42.   }  
43.     
44.   public void render() {  
45.     if(vertices == null) return;  
46.       
47.     if(vertices.size() == 3)      beginShape(TRIANGLES);  
48.     else if(vertices.size() == 4) beginShape(QUADS);  
49.     else                          beginShape();  
50.     for(PVector v : vertices) vertex(v.x, v.y, v.z);  
51.     endShape();  
52.   }  
53. }  
54.   
55. // =================================================  
56.   
57. // Xファイルローダクラス  
58. class Loader {  
59.   // Xファイルの文字列データが一括して格納される  
60.   private StringBuffer data;  
61.     
62.   // Xファイル内の部分文字列の先頭を指すインデックス  
63.   private int          index;  
64.   
65.   // 頂点リスト  
66.   List<PVector> verticesList;  
67.     
68.   // ----------------------------------------  
69.   public Loader() {  
70.     data = new StringBuffer();  
71.     verticesList = new ArrayList<PVector>();  
72.   }  
73.     
74.   // ----------------------------------------  
75.   // ファイル名を指定してメッシュをロード   
76.   public Mesh loadX(final String fileName) {   
77.     Mesh mesh = new Mesh();  
78.       
79.     index = 0;  
80.     data.delete(0, data.length());  
81.     String[] lines = loadStrings(fileName);  
82.     for(String line : lines) {  
83.       // ここで本来はコメント除去の処理が必要  
84.         
85.       data.append(line + "\n");  
86.     }  
87.     while(index < data.length()) {  
88.       String token = getNextToken();  
89.         
90.       // テンプレートは読み飛ばす  
91.       if(token.equals("template")) skipBlock();  
92.   
93.       // ====================  
94.       // MESH  
95.       // ====================  
96.       else if(token.equals("Mesh")) {  
97.         token = getNextToken();  
98.         // トークンが { でない場合  
99.         if(!token.equals("{")) {  
100.           getNextToken();  
101.         }   
102.         /* 
103.         else { 
104.           // 名前つきマップに入れたい 
105.         }*/  
106.           
107.         // 頂点リストを作成  
108.         verticesList.clear();  
109.           
110.         // 全頂点数を取得  
111.         int nVertices = Integer.parseInt(getNextToken());  
112.           
113.         // 各頂点の座標を取得  
114.         for(int i = 0; i < nVertices; ++i) {  
115.           float x = Float.parseFloat(getNextToken());  
116.           float y = Float.parseFloat(getNextToken());  
117.           float z = Float.parseFloat(getNextToken());            
118.           verticesList.add(new PVector(x, y, z));  
119.         }  
120.           
121.         // ポリゴン数を取得  
122.         int nPolygons = Integer.parseInt(getNextToken());  
123.         for(int i = 0; i < nPolygons; ++i) {  
124.           Polygon poly = new Polygon();  
125.             
126.           // 1ポリゴンあたりの頂点数  
127.           int nVerticesPerPolygon = Integer.parseInt(getNextToken());  
128.           for(int j = 0; j < nVerticesPerPolygon; ++j) {  
129.               
130.             // 頂点インデックスを取得  
131.             int verticesIndex = Integer.parseInt(getNextToken());  
132.               
133.             // 頂点インデックスから該当する頂点を取得してポリゴンに追加  
134.             poly.add(verticesList.get(verticesIndex));  
135.           }  
136.   
137.           mesh.add(poly);  
138.         }  
139.       }  
140.     }  
141.     return mesh;  
142.   }  
143.     
144.   // ----------------------------------------  
145.   // { } で囲まれたブロックを読み飛ばす  
146.   private void skipBlock() {  
147.     try {  
148.       // はじめの { まで読み飛ばす   
149.       while(!(getNextToken().equals("{")) && index < data.length()) ;  
150.         
151.       int n = 1;  
152.       while(n > 0 && index < data.length()) {  
153.         String token = getNextToken();  
154.         if(token.equals("{")) ++n;  
155.         if(token.equals("}")) --n;  
156.       }  
157.     } catch (RuntimeException ex) {  
158.       ex.printStackTrace();  
159.     }  
160.   }  
161.     
162.   // ----------------------------------------  
163.   // 次のトークンを得る  
164.   private String getNextToken() {  
165.     // 最初にインデックスの範囲チェック  
166.     if(!(index < data.length())) return "";  // ファイルの末尾に達した場合は""を返す  
167.       
168.     // デリミタ（区切り文字）の読み飛ばし  
169.     String delimiters = " \t\r\n,;\"";  
170.     while(index < data.length() &&   
171.           strChr(delimiters, data.charAt(index)))    
172.       ++index;  
173.   
174.     if(!(index < data.length())) return "";  // ファイルの末尾  
175.    
176.     // 中括弧の検出  
177.     char[] c = { data.charAt(index) };  
178.     if(c[0] == '{' || c[0] == '}') {  
179.       ++index;  
180.       return new String(c);  
181.     }  
182.       
183.     // それ以外のトークン検出  
184.     delimiters += "{}";  
185.     int startIndex = index;  
186.     int endIndex   = index;  
187.     while(endIndex < data.length() &&  
188.           !strChr(delimiters, data.charAt(endIndex)))  
189.       ++endIndex;  
190.     index = endIndex;  
191.     return data.substring(startIndex, endIndex);  
192.   }  
193.     
194.   // ----------------------------------------  
195.   // 文字列シーケンスsの中に、cが含まれているかどうかをチェック  
196.   private boolean strChr(final CharSequence s, final char c) {  
197.     for(int i = 0; i < s.length(); ++i)  
198.       if(s.charAt(i) == c) return true;  
199.     return false;  
200.   }  
201. }  

// -------------------------------------------------
// =================================================
// Xファイル形式で記述されたメッシュを表示するテスト
//                    スタティックメッシュ篇不完全版
// =================================================
// -------------------------------------------------


// =================================================

// メッシュ
class Mesh {
  List<Polygon> polygons;
  
  public Mesh() {
    polygons = new ArrayList<Polygon>();
  }
  
  public void add(Polygon p) {
    polygons.add(p);
  }
  
  public void render() {
    if(polygons == null) return;
    
    for(Polygon p : polygons) p.render();
  }
}

// =================================================

// ポリゴン
class Polygon {
  List<PVector> vertices;
  
  public Polygon() {
    vertices = new ArrayList<PVector>();
  }
  
  public void add(PVector v) {
    vertices.add(v);
  }
  
  public void render() {
    if(vertices == null) return;
    
    if(vertices.size() == 3)      beginShape(TRIANGLES);
    else if(vertices.size() == 4) beginShape(QUADS);
    else                          beginShape();
    for(PVector v : vertices) vertex(v.x, v.y, v.z);
    endShape();
  }
}

// =================================================

// Xファイルローダクラス
class Loader {
  // Xファイルの文字列データが一括して格納される
  private StringBuffer data;
  
  // Xファイル内の部分文字列の先頭を指すインデックス
  private int          index;

  // 頂点リスト
  List<PVector> verticesList;
  
  // ----------------------------------------
  public Loader() {
    data = new StringBuffer();
    verticesList = new ArrayList<PVector>();
  }
  
  // ----------------------------------------
  // ファイル名を指定してメッシュをロード 
  public Mesh loadX(final String fileName) { 
    Mesh mesh = new Mesh();
    
    index = 0;
    data.delete(0, data.length());
    String[] lines = loadStrings(fileName);
    for(String line : lines) {
      // ここで本来はコメント除去の処理が必要
      
      data.append(line + "\n");
    }
    while(index < data.length()) {
      String token = getNextToken();
      
      // テンプレートは読み飛ばす
      if(token.equals("template")) skipBlock();

      // ====================
      // MESH
      // ====================
      else if(token.equals("Mesh")) {
        token = getNextToken();
        // トークンが { でない場合
        if(!token.equals("{")) {
          getNextToken();
        } 
        /*
        else {
          // 名前つきマップに入れたい
        }*/
        
        // 頂点リストを作成
        verticesList.clear();
        
        // 全頂点数を取得
        int nVertices = Integer.parseInt(getNextToken());
        
        // 各頂点の座標を取得
        for(int i = 0; i < nVertices; ++i) {
          float x = Float.parseFloat(getNextToken());
          float y = Float.parseFloat(getNextToken());
          float z = Float.parseFloat(getNextToken());          
          verticesList.add(new PVector(x, y, z));
        }
        
        // ポリゴン数を取得
        int nPolygons = Integer.parseInt(getNextToken());
        for(int i = 0; i < nPolygons; ++i) {
          Polygon poly = new Polygon();
          
          // 1ポリゴンあたりの頂点数
          int nVerticesPerPolygon = Integer.parseInt(getNextToken());
          for(int j = 0; j < nVerticesPerPolygon; ++j) {
            
            // 頂点インデックスを取得
            int verticesIndex = Integer.parseInt(getNextToken());
            
            // 頂点インデックスから該当する頂点を取得してポリゴンに追加
            poly.add(verticesList.get(verticesIndex));
          }

          mesh.add(poly);
        }
      }
    }
    return mesh;
  }
  
  // ----------------------------------------
  // { } で囲まれたブロックを読み飛ばす
  private void skipBlock() {
    try {
      // はじめの { まで読み飛ばす 
      while(!(getNextToken().equals("{")) && index < data.length()) ;
      
      int n = 1;
      while(n > 0 && index < data.length()) {
        String token = getNextToken();
        if(token.equals("{")) ++n;
        if(token.equals("}")) --n;
      }
    } catch (RuntimeException ex) {
      ex.printStackTrace();
    }
  }
  
  // ----------------------------------------
  // 次のトークンを得る
  private String getNextToken() {
    // 最初にインデックスの範囲チェック
    if(!(index < data.length())) return "";  // ファイルの末尾に達した場合は""を返す
    
    // デリミタ（区切り文字）の読み飛ばし
    String delimiters = " \t\r\n,;\"";
    while(index < data.length() && 
          strChr(delimiters, data.charAt(index)))  
      ++index;

    if(!(index < data.length())) return "";  // ファイルの末尾
 
    // 中括弧の検出
    char[] c = { data.charAt(index) };
    if(c[0] == '{' || c[0] == '}') {
      ++index;
      return new String(c);
    }
    
    // それ以外のトークン検出
    delimiters += "{}";
    int startIndex = index;
    int endIndex   = index;
    while(endIndex < data.length() &&
          !strChr(delimiters, data.charAt(endIndex)))
      ++endIndex;
    index = endIndex;
    return data.substring(startIndex, endIndex);
  }
  
  // ----------------------------------------
  // 文字列シーケンスsの中に、cが含まれているかどうかをチェック
  private boolean strChr(final CharSequence s, final char c) {
    for(int i = 0; i < s.length(); ++i)
      if(s.charAt(i) == c) return true;
    return false;
  }
}

で、使い方はこんな感じ。

view plainprint?

1. Mesh mesh;  
2.   
3. void setup() {  
4.   size(640, 480, P3D);  
5.     
6.   // ファイル名を指定してXをロード    
7.   mesh = new Loader().loadX("nihonbasikirin.x");  
8.     
9. }  
10.   
11. void draw() {  
12.   background(0);  
13.   camera();  
14.   lights();  
15.   noStroke();  
16.   
17.   camera(500, 500, 500, 0, 300, 0, 0, -1, 0);  
18.       
19.   scale(300);  
20.     
21.   // メッシュの描画  
22.   mesh.render();  
23. }  

Mesh mesh;

void setup() {
  size(640, 480, P3D);
  
  // ファイル名を指定してXをロード  
  mesh = new Loader().loadX("nihonbasikirin.x");
  
}

void draw() {
  background(0);
  camera();
  lights();
  noStroke();

  camera(500, 500, 500, 0, 300, 0, 0, -1, 0);
    
  scale(300);
  
  // メッシュの描画
  mesh.render();
}

---

ちなみに、現在の制約では、一つの X ファイルに複数のメッシュ情報が定義されている場合、うまく読み込む事ができません（対応は簡単ですが、それが必要な例を見た事がないのでとりあえずこのままでいいや的な……）。

ただ、視覚的には複数のように見えるメッシュであっても、内部的には一つのメッシュにまとめられているような場合は、正しくロードする事ができます（下図参照）。

Metasequoia にプリセットされている「魔道少女」

これを Processing で表示させると、ちゃんと 2 つのモデルが表示されます。

これからいろいろ忙しくなりますが、暇を見つけて『色付け』と『アニメーション』に対応していけたらなぁ……と考えています。 うーん……。