simple_3d 3.3.1

This package was created for the convenience of 3D non-experts, including scientists.

simple_3d

(en)The explanation is in English and Japanese.
(ja)日本語版は(ja)として記載してあります。

Overview

(en)This package is a working Flutter(Dart) implementation of Simple 3D Format.
Simple 3D Format is a file format that makes it easy for non-experts to handle 3D objects.
The file output in this format has the extension .sp3d, and the inner class convert to JSON. All the data about one object is contained in one file.
This specification aims to minimize complexity, make it easier to read in a text editor, and make it versatile.
Made for science, it can be difficult to use in other genres. For the development of science, I aim to be able to use it without being affected by interests and conflicts.

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

Usage

Quick Start

(en)I created a package for rendering Sp3dObj.
You can use it more easily by using the following packages.
See the simple_3d_renderer package for how to use it.

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

simple_3d_renderer
util_simple_3d

Create Data

final sp3dobj = Sp3dObj(
    "1",
    "test",
    [Sp3dV3D(0, 0, 0)],
    [
      Sp3dFragment(
          true,
          [
            Sp3dFace([0], 0)
          ],
          1,
          null)
    ],
    [
      Sp3dMaterial(Color.fromARGB(255, 0, 255, 0), true, 1,
          Color.fromARGB(255, 0, 255, 0), null, null)
    ],
    [],
    null);

Operation example

// Move
sp3dobj.move(Sp3dV3D(1,0,0));
// Rotate
sp3dobj.rotate(Sp3dV3D(0,1,0),45*pi/180);
// Vertex manipulation
// (en)You can do many other things with the Sp3dV3D feature.
// (ja)Sp3dV3Dの機能を使うと、他にも様々なことが出来ます。
sp3dobj.vertices[0] += Sp3dV3D(1,0,0);

Convert

final sp3dobj_d = sp3dobj.to_dict();

Load

final restored = Sp3dObj.from_dict(sp3dobj_d);

About future development

(en)I continue to develop packages for rendering.
Currently, drawing of image files is not supported. I plan to support it in the future.
(ja)レンダリングのためのパッケージの開発を継続しています。
現在、画像ファイルの描画が未サポートです。今後、対応させる予定です。

Format Name

Simple 3D Format

Filename Extension

.sp3d

MIME Type ( Temporary )

model/x.sp3d

Suitable

(en)Science, Simple Games, etc.
(ja)科学や簡単なゲームなどに向いています。

Not Suitable

(en)Advanced graphics.
(ja)高度なグラフィックを必要とするものには向いていません。

Structure ( Decoded object )

• Sp3dObj
  • id: String?
  • name: String?
  • vertices: List
    • v: Sp3dV3D
  • fragments: List
    • fragment: Sp3dFragment
      • is_particle: bool
      • faces: List, One vertex for particle type.
        • face: Sp3dFace
          • vertex_index_list: List, Vertices index. Counterclockwise rotation from the upper left.
            • index: int
          • material_index: int?
        • r: double, Radius for particle type.
        • option: Map<String, dynamic>, Optional attributes that may be added for each app.
  • materials: List
    • material: Sp3dMaterial
      • bg: Color, argb.
      • is_fill: bool, if false, stroke line only.
      • stroke_width: double
      • stroke_color: Color, argb
      • image_index: int?, Invalid if null. When fill is enabled and there are 4 vertex, fill with image with the Counterclockwise order as the vertices from the upper left.
      • option: Map<String, dynamic>, Optional attributes that may be added for each app.
  • images: list
    • image: Uint8List, png data.
  • option: Map<String, dynamic>, Optional attributes that may be added for each app.

About version control

(en)It is as follows in version 3.1.0 or later.
The C part will be changed at the time of version upgrade.

• Changes such as adding variables, structure change that cause problems when reading previous files.
  • C.X.X
• Adding methods, etc.
  • X.C.X
• Minor changes and bug fixes.
  • X.X.C

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

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

License

(en)This software is released under the MIT License, see LICENSE file.
(ja)このソフトウェアはMITライセンスの元配布されます。LICENSEファイルの内容をご覧ください。

Copyright notice

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