Skip to content

Latest commit

 

History

History
156 lines (138 loc) · 7.85 KB

README_JA.md

File metadata and controls

156 lines (138 loc) · 7.85 KB

simple_3d

日本語版の解説です。

概要

このパッケージはSimple 3D Formatの実用的なFlutter(Dart)実装です。
Simple 3D Formatは、3次元オブジェクトを専門家以外でも手軽に扱えるようにするためのファイル・フォーマットです。
このフォーマットで出力されたファイルは拡張子.sp3dを持ち、内部クラスがJSONに変換されます。１つのオブジェクトに関する全てのデータが１つのファイル内に含まれています。 この仕様は様々な用途に使用できるように複雑さを最小限に抑え、かつ簡単にテキストエディタで内容が確認できることを目的としています。
科学の為に作られたので、他のジャンルで使いにくい可能性があります。
科学の発展のため、利権や争いなどに影響されずに利用できることを目指しています。

利用方法

クイックスタート

Sp3dObjのレンダリングのためのパッケージを用意しています。
下記のパッケージを利用すると、より簡単にご利用になれます。
利用方法はsimple_3d_rendererパッケージをご覧ください。

simple_3d_renderer
util_simple_3d

Sp3dObjを直接編集することがあるアプリで、Undo, Redo機能を導入したい場合、
下記のパッケージが利用できます。
file_state_manager

これは非常に実験的なプロジェクトですが、他の3D形式から変換するためのパッケージもあります。
ただし、このパッケージはあくまでも科学用であり、機能に大きな差があるため最低限の互換性のみがサポートされます。
convert_simple_3d

データ作成

final sp3dObj = Sp3dObj(
    [Sp3dV3D(0, 0, 0)],
    [
      Sp3dFragment(
          [
            Sp3dFace([0], 0)
          ],
          isParticle: true,
          r: 1)
    ],
    [
      Sp3dMaterial(
        Color.fromARGB(255, 0, 255, 0),
        true,
        1,
        Color.fromARGB(255, 0, 255, 0),
      )
    ],
    []);

オブジェクトの操作例

// 移動
sp3dObj.move(Sp3dV3D(1,0,0));
// 回転
sp3dObj.rotate(Sp3dV3D(0,1,0),45*pi/180);
// 頂点の操作
// Sp3dV3Dの機能を使うと、他にも様々なことが出来ます。
sp3dObj.vertices[0] += Sp3dV3D(1,0,0);

保存用の変換

final sp3dObjDict = sp3dObj.toDict();

復元

final restored = Sp3dObj.fromDict(sp3dObjDict);

サポート

もし何らかの理由で有償のサポートが必要な場合は私の会社に問い合わせてください。
このパッケージは私が個人で開発していますが、会社経由でサポートできる場合があります。
合同会社シンプルアプリ

フォーマット名

Simple 3D Format

拡張子

.sp3d

MIME Type ( 仮 )

model/x.sp3d

このオブジェクトが有用なもの

科学（例えば物理計算）や簡単なゲームなどに向いています。

このオブジェクトが有用でないもの

高度なグラフィックを必要とするものには向いていません。

内部構造 ( デコードされた状態 )

  • Sp3dObj
    • vertices: List
      • v: Sp3dV3D
    • fragments: List
      • fragment: Sp3dFragment
        • faces: List, 面の定義です。三角メッシュまたは四角メッシュを表します。
          • face: Sp3dFace
            • vertexIndexList: List, 頂点のインデックスリストです. 左上から逆時計回りで定義します。
              • index: int
            • materialIndex: int?
        • isParticle: bool.
        • r: double, particleの場合の半径です。
        • physics: Sp3dPhysics?, 物理演算用の変数です。
        • isTouchable: bool, Falseの場合はレンダリングされたこのフラグメントがタッチ計算の対象外になります。
        • name: String?, フラグメント名。
        • option: Map<String, dynamic>?, アプリ毎に拡張可能なオプション属性です。ただし、JSON化出来るパラメータのみ入れられます。
    • materials: List
      • material: Sp3dMaterial
        • bg: Color, argb.
        • isFill: bool, falseの場合線だけを表示します。
        • strokeWidth: double
        • strokeColor: Color, argb
        • imageIndex: int?, nullでは無い時、指定された画像でfaceを塗りつぶします。
        • textureCoordinates: List?, ３点、又は６点（四角の場合、三角形２つで指定します）での、画像の切り出し位置の指定です。
        • name: String?, 素材名。
        • option: Map<String, dynamic>?, アプリ毎に拡張可能なオプション属性です。ただし、JSON化出来るパラメータのみ入れられます。
    • images: list
      • image: Uint8List, png data.
    • id: String?
    • name: String?
    • author: String?
    • physics: Sp3dPhysics?, 物理演算用の変数です。
      • mass: double?, 質量(kg)。ただし、原子の計算などの場合は適切な単位に変更すべきです。
      • speed: double?, 速さ(m/s)。計算時の簡単のためにあります。ただし、原子の計算などの場合は適切な単位に変更すべきです。
      • direction: Sp3dV3D?, 進行方向の向きベクトル（単位ベクトル）。計算時の簡単のためにあります。
      • velocity: Sp3dV3D?, 速度。速さと向きの両方を含みます。moveする時に使います。
      • rotateAxis: Sp3dV3D?, 回転軸。
      • angularVelocity: double?, 角速度(rad/s)。回転と移動は分離して考えます。単位はラジアン毎秒です。
      • angle: double?, ラジアン(rad)。
      • name: String?, 動作の名前。
      • others: Map<String, dynamic>?
    • option: Map<String, dynamic>?, アプリ毎に拡張可能なオプション属性です。ただし、JSON化出来るパラメータのみ入れられます。
    • layerNum: int, レンダリングソフトに対して有効になる、奥行方向の描画優先度。レイヤー番号が小さい方から先に描画されます。
    • drawMode: enum, Sp3dObjがレンダラーで描画される時の、モード指定のための値です。

パラメータのメモ

多数の原子の計算にSp3dObjを使用する場合は、isParticleフラグとr（半径）の使用を検討してください。
各原子は計算または保存時に1つの頂点を持ち、画面上に描画する場合にのみUtilSp3dGeometryなどを使用して球を描画することが出来ます。（つまり、描画の時には新しいSp3dObjを作ります）。

バージョン管理について

バージョン3.1.0以降において以下のようになっています。
それぞれ、Cの部分が変更されます。

  • 変数の追加など、以前のファイルの読み込み時に問題が起こったり、ファイルの構造が変わるような変更
    • C.X.X
  • メソッドの追加など
    • X.C.X
  • 軽微な変更やバグ修正
    • X.X.C

ライセンス

このソフトウェアはMITライセンスの元配布されます。LICENSEファイルの内容をご覧ください。

著作権表示

The “Dart” name and “Flutter” name are trademarks of Google LLC.
*The developer of this package is not Google LLC.