disp3D 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,78 @@
 = disp3D
+本ライブラリは、Qtと組み合わせて、3次元の表示が簡単に可能なフレームワークを提供する目的で開発されています。ターゲットは、簡単なアプリ、プロトタイピング、学術利用などを想定しています。
 
-This library provide 3D GUI framework. 
+以下のような特徴を持つようなライブラリを目指します。
+- シンプルで使いやすく！
+- Rubyでの開発が可能
+- windows,mac,linuxなどプラットフォームを問わない
+
+また、ゲーム、CGや大規模モデルなどは当面の目標からは外れます。
+
+== インストール
+ライブラリは以下の３つのgemに依存しています。
+- gmath3D
+- ruby-opengl
+- qtbindings()
+
+=== gmath3D
+gemからインストールが可能です
+
+gem install GMath3D
+
+=== ruby-opengl
+openglを扱う上では、必須となります。
+
+gemでのインストールが失敗する可能性があります。
+https://github.com/toshi0328/ruby-opengl
+の内容をビルド、インストールします。
+
+=== qtbindings
+Qtを利用する場合に必要となります。
+
+gemでのインストールが失敗する可能性があります。
+https://github.com/toshi0328/qtbindings
+の内容をビルド、インストールします。
+
+== 使い方
+=== 例
+1.点や線を３次元ビュー上に追加し、表示する
+開発中
+
+2.Qtアプリケーションとして開発をする
+開発中
+
+3.STLファイルを読み込み、表示する
+開発中
+
+4.表示要素をマウス操作で取得する
+開発中
+
+=== データ構造
+中心となるクラスは、GLViewおよびSceneGraphです。
+執筆中
+
+== 今後の課題
+=== 開発項目
+- デモアプリ（STLビューワー）
+　- QTでのアプリケーション設計
+　- tri_nodeの法線方向指定
+- インディケート処理の追加
+- trackball manipulatorを洗練させる
+　- 回転中心を変えるとか・・・
+- DSLの設計
+- 自動テスト構築
+- Windowsでの利用(なぜか、インストールでエラー・・・)
+- ライティングの工夫、表示の洗練
+- ドキュメント整理(html?)
+- テクスチャの貼り付け
+- データの可視化としての応用
+- アニメーション
+- モバイル応用
+
+=== 他ライブラリとの組み合わせ
+- 3次元画像処理,pclの利用
+- 医用応用として、DICOMパーサー(Ruby-DICOM)の利用
+- 2次元画像処理、RMagicに任せる・・・（Ruby-DICOMとのつなぎなど）
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/disp3D.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{disp3D}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Toshiyasu Shimizu"]
+  s.date = %q{2011-11-03}
+  s.description = %q{disp3D provide 3D GUI framework}
+  s.email = %q{toshi0328@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "disp3D.gemspec",
+    "example/stl_viewer/app_model.rb",
+    "example/stl_viewer/document.rb",
+    "example/stl_viewer/document_ctrl.rb",
+    "example/stl_viewer/gl_ctrl.rb",
+    "example/stl_viewer/main.rb",
+    "example/stl_viewer/mesh_info.rb",
+    "example/stl_viewer/stl_viewer.rb",
+    "lib/camera.rb",
+    "lib/disp3D.rb",
+    "lib/dsl.rb",
+    "lib/gl_view.rb",
+    "lib/glut_window.rb",
+    "lib/light.rb",
+    "lib/manipulator.rb",
+    "lib/node.rb",
+    "lib/node_arrows.rb",
+    "lib/node_collection.rb",
+    "lib/node_leaf.rb",
+    "lib/node_lines.rb",
+    "lib/node_points.rb",
+    "lib/node_polylines.rb",
+    "lib/node_tea_pod.rb",
+    "lib/node_text.rb",
+    "lib/node_tris.rb",
+    "lib/picked_result.rb",
+    "lib/picker.rb",
+    "lib/qt_widget_gl.rb",
+    "lib/scene_graph.rb",
+    "lib/stl.rb",
+    "lib/util.rb",
+    "test/helper.rb",
+    "test/test_data/binary_test.stl",
+    "test/test_data/cube-ascii.stl",
+    "test/test_dsl.rb",
+    "test/test_glut_window.rb",
+    "test/test_qtgl.rb",
+    "test/test_stl.rb",
+    "test/test_tea_pod.rb"
+  ]
+  s.homepage = %q{http://github.com/toshi0328/disp3D}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{disp3D provide 3D GUI framework.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<gmath3D>, [">= 0"])
+      s.add_development_dependency(%q<ruby-opengl>, ["= 0.60.1"])
+      s.add_development_dependency(%q<qtbindings>, ["= 4.6.3.4"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<gmath3D>, [">= 0"])
+      s.add_dependency(%q<ruby-opengl>, ["= 0.60.1"])
+      s.add_dependency(%q<qtbindings>, ["= 4.6.3.4"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<gmath3D>, [">= 0"])
+    s.add_dependency(%q<ruby-opengl>, ["= 0.60.1"])
+    s.add_dependency(%q<qtbindings>, ["= 4.6.3.4"])
+  end
+end
+

data/example/stl_viewer/app_model.rb

@@ -0,0 +1,8 @@
+require 'stl_viewer'
+
+#TODO all model should have @dirty flg...
+class AppModel
+  def initialize
+    @dirty = false
+  end
+end

data/example/stl_viewer/document.rb

@@ -0,0 +1,15 @@
+require 'stl_viewer'
+
+class Document
+  def initialize
+    @tri_mesh_info_list = []
+    # @dirty = false
+  end
+
+  def add_tri_mesh!(tri_mesh)
+    # @dirty = true
+    mesh_info = MeshInfo.new(tri_mesh)
+    @tri_mesh_info_list.push(mesh_info)
+    return mesh_info
+  end
+end

data/example/stl_viewer/document_ctrl.rb

@@ -0,0 +1,62 @@
+require 'stl_viewer'
+
+class DocumentCtrl
+  attr_reader :document
+
+  def initialize(main_window)
+    @document = nil # this is THE ROOT DOCUMENT of this application
+    @main_window = main_window
+    @gl_ctrl = GLCtrl.new(main_window.gl_widget)
+  end
+
+  def new
+    if (@document.nil? || may_be_save)
+      @document = Document.new()
+    end
+  end
+
+  def open
+    #TODO implement!
+  end
+
+  def save
+    #TODO implement! return true if success
+    return true
+  end
+
+  def add_stl
+    if(@document.nil?)
+      new()
+    end
+
+    file_name = Qt::FileDialog.getOpenFileName(@main_window)
+    if !file_name.nil?
+      stl = STL.new()
+      if stl.parse(file_name)
+        added =  @document.add_tri_mesh!(stl.tri_mesh)
+        if !added.nil?
+          @gl_ctrl.add2scenegraph(added)
+        end
+      end
+    end
+  end
+
+private
+  def may_be_save
+    if @document.dirty
+      ret = Qt::MessageBox::warning(@main_window, tr("STL Viewer"),
+                            tr("The document has been modified. \n" +
+                               "Do you want to save your change?"),
+                            Qt::MessageBox::Yes | Qt::MessageBox::Defaut,
+                            Qt::MessageBox::No,
+                            Qt::MessageBox::Cancel | Qt::MessageBox::Escape)
+      if ret == Qt::MessageBox::Yes
+        return save()
+      elsif ret == Qt::MessageBox::Cancel
+        return false
+      end
+    end
+    return true
+  end
+
+end

data/example/stl_viewer/gl_ctrl.rb

@@ -0,0 +1,15 @@
+require 'stl_viewer'
+
+class GLCtrl
+  def initialize(gl_widget)
+    @gl_widget = gl_widget
+  end
+
+  def add2scenegraph(mesh_info)
+    mesh_info.mesh_node = Disp3D::NodeTris.new(mesh_info.mesh_geom)
+    mesh_info.mesh_node.material_color = [1,0,0,1]
+    @gl_widget.world_scene_graph.add(mesh_info.mesh_node)
+    @gl_widget.fit
+    @gl_widget.updateGL
+  end
+end

data/example/stl_viewer/main.rb

@@ -0,0 +1,120 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../..', 'lib'))
+
+require 'Qt'
+require 'qt_widget_gl'
+require 'stl_viewer'
+
+class STLViewerWindow < Qt::MainWindow
+  attr_reader :gl_widget
+
+  slots 'new()',
+        'open()',
+        'save()',
+        'add_stl()',
+        'about()',
+        'aboutQt()'
+
+  def initialize(parent = nil)
+    super
+
+    w = Qt::Widget.new
+    setCentralWidget(w)
+
+    topFiller = Qt::Widget.new
+    topFiller.setSizePolicy(Qt::SizePolicy::Expanding, Qt::SizePolicy::Expanding)
+
+    @gl_widget = QtWidgetGL.new(self)
+    @gl_widget.width = 600
+    @gl_widget.height = 400
+
+    bottomFiller = Qt::Widget.new
+    bottomFiller.setSizePolicy(Qt::SizePolicy::Expanding, Qt::SizePolicy::Expanding)
+
+    vbox = Qt::VBoxLayout.new
+    vbox.margin = 5
+    vbox.addWidget(topFiller)
+    vbox.addWidget(@gl_widget)
+    vbox.addWidget(bottomFiller)
+    w.layout = vbox
+
+    createActions()
+    createMenus()
+
+    setWindowTitle(tr("STL Viewer"))
+    setMinimumSize(160, 160)
+
+    # controllers
+    @doc_ctrl = DocumentCtrl.new(self)
+  end
+
+  def createActions()
+    @newAct = Qt::Action.new(tr("&New..."), self)
+    @newAct.shortcut = Qt::KeySequence.new( tr("Ctrl+N") )
+    @newAct.statusTip = tr("Create new file")
+    connect(@newAct, SIGNAL('triggered()'), self, SLOT('new()'))
+
+    @openAct = Qt::Action.new(tr("&Open..."), self)
+    @openAct.shortcut = Qt::KeySequence.new( tr("Ctrl+O") )
+    @openAct.statusTip = tr("Open an existing file")
+    connect(@openAct, SIGNAL('triggered()'), self, SLOT('open()'))
+
+    @saveAct = Qt::Action.new(tr("&Save"), self)
+    @saveAct.shortcut = Qt::KeySequence.new( tr("Ctrl+S") )
+    @saveAct.statusTip = tr("Save the document to disk")
+    connect(@saveAct, SIGNAL('triggered()'), self, SLOT('save()'))
+
+    @addStlAct = Qt::Action.new(tr("&Add STL"), self)
+    @addStlAct.shortcut = Qt::KeySequence.new( tr("Ctrl+A") )
+    @addStlAct.statusTip = tr("Add STL file")
+    connect(@addStlAct, SIGNAL('triggered()'), self, SLOT('add_stl()'))
+
+    @aboutAct = Qt::Action.new(tr("&About"), self)
+    @aboutAct.statusTip = tr("Show the application's About box")
+    connect(@aboutAct, SIGNAL('triggered()'), self, SLOT('about()'))
+
+    @aboutQtAct = Qt::Action.new(tr("About &Qt"), self)
+    @aboutQtAct.statusTip = tr("Show the Qt library's About box")
+    connect(@aboutQtAct, SIGNAL('triggered()'), $qApp, SLOT('aboutQt()'))
+  end
+
+  def createMenus()
+    @fileMenu = menuBar().addMenu(tr("&File"))
+    @fileMenu.addAction(@newAct)
+    @fileMenu.addAction(@openAct)
+    @fileMenu.addAction(@saveAct)
+    @fileMenu.addAction(@addStlAct)
+
+    @helpMenu = menuBar().addMenu(tr("&Help"))
+    @helpMenu.addAction(@aboutAct)
+    @helpMenu.addAction(@aboutQtAct)
+  end
+
+  def new()
+    @doc_ctrl.new
+  end
+
+  def open()
+    @doc_ctrl.open
+  end
+
+  def save()
+    @doc_ctrl.save
+  end
+
+  def add_stl()
+    @doc_ctrl.add_stl
+  end
+
+  def about()
+    Qt::MessageBox.about(self, tr("About Menu"),
+                   tr("STL Viewer, Demo application using <b>disp3D</b> library."))
+  end
+end
+
+# start application
+app = Qt::Application.new(ARGV)
+window = STLViewerWindow.new
+window.show
+app.exec
+

data/example/stl_viewer/mesh_info.rb

@@ -0,0 +1,12 @@
+require 'stl_viewer'
+
+class MeshInfo
+  attr_reader :mesh_geom
+  attr_accessor :mesh_node
+
+  def initialize(mesh)
+    @mesh_geom = mesh
+    @mesh_node = nil
+  end
+
+end

data/example/stl_viewer/stl_viewer.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'app_model'
+
+require 'document'
+require 'mesh_info'
+
+require 'document_ctrl'
+require 'gl_ctrl'

data/lib/camera.rb

@@ -2,56 +2,70 @@ require 'disp3D'
 
 module Disp3D
   class Camera
-    attr_accessor :rotX
-    attr_accessor :rotY
+    attr_accessor :rotation
+    attr_accessor :translate
+    attr_accessor :center
+    attr_accessor :scale
+    attr_accessor :is_orth
 
-    LIGHT_POSITION = [0.25, 1.0, 0.25, 0.0]
-    LIGHT_DIFFUSE  = [1.0, 1.0, 1.0]
-    LIGHT_AMBIENT  = [0.25, 0.25, 0.25]
-    LIGHT_SPECULAR = [1.0, 1.0, 1.0]
-
-    MAT_DIFFUSE   = [0.0, 0.0, 0.0]
-    MAT_AMBIENT   = [0.25, 0.25, 0.25]
-    MAT_SPECULAR  = [1.0, 1.0, 1.0]
-    MAT_SHININESS = [32.0]
+    def initialize()
+      @rotation = Quat.from_axis(Vector3.new(1,0,0),0)
+      @translate = nil
+      @eye = Vector3.new(0,0,5)
+      @center = Vector3.new(0,0,0)
+      @scale = 1
+      @angle = 30
+      @is_orgh = false
+      @near = 0.1
+      @far = 100.0
+    end
 
     def reshape(w,h)
-      GL.Viewport(0,0,w,h)
-
+      GL.Viewport(0.0,0.0,w,h)
       GL.MatrixMode(GL::GL_PROJECTION)
       GL.LoadIdentity()
-      GLU.Perspective(45.0, w.to_f()/h.to_f(), 0.1, 100.0)
-      #    GL.Ortho(-1,1,-1,1,2,4)
+      set_screen(w,h)
     end
 
     def display()
       GL.MatrixMode(GL::GL_MODELVIEW)
       GL.LoadIdentity()
-      GLU.LookAt(0.0, 0.0, 3.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0)
-
-      GL.Lightfv(GL::GL_LIGHT0, GL::GL_POSITION, LIGHT_POSITION)
-      GL.Lightfv(GL::GL_LIGHT0, GL::GL_DIFFUSE, LIGHT_DIFFUSE)
-      GL.Lightfv(GL::GL_LIGHT0, GL::GL_AMBIENT, LIGHT_AMBIENT)
-      GL.Lightfv(GL::GL_LIGHT0, GL::GL_SPECULAR, LIGHT_SPECULAR)
+      GLU.LookAt(@eye.x, @eye.y, @eye.z, @center.x, @center.y, @center.z, 0.0, 1.0, 0.0)
 
-      GL.Materialfv(GL::GL_FRONT, GL::GL_DIFFUSE, MAT_DIFFUSE)
-      GL.Materialfv(GL::GL_FRONT, GL::GL_AMBIENT, MAT_AMBIENT)
-      GL.Materialfv(GL::GL_FRONT, GL::GL_SPECULAR, MAT_SPECULAR)
-      GL.Materialfv(GL::GL_FRONT, GL::GL_SHININESS, MAT_SHININESS)
+      GL.Translate(translate.x, translate.y, translate.z) if(@translate)
+      rot_mat = Matrix.from_quat(@rotation)
+      rot_mat_array = [
+        [rot_mat[0,0], rot_mat[0,1], rot_mat[0,2], 0],
+        [rot_mat[1,0], rot_mat[1,1], rot_mat[1,2], 0],
+        [rot_mat[2,0], rot_mat[2,1], rot_mat[2,2], 0],
+        [0,0,0,1]]
 
-      GL.Clear(GL::GL_COLOR_BUFFER_BIT | GL::GL_DEPTH_BUFFER_BIT)
-
-      GL.Rotate(@rotX, 1, 0, 0)
-      GL.Rotate(@rotY, 0, 1, 0)
+      GL.MultMatrix(rot_mat_array)
+      GL.Scale(@scale, @scale, @scale)
     end
 
-    def initialize()
-      @rotY = 0
-      @rotX = 0
-      GL.Enable(GL::GL_LIGHTING)
-      GL.Enable(GL::GL_LIGHT0)
+    def fit(radius, width, height)
+      eye_z = radius / Math.sin(@angle/2.0*Math::PI/180.0)
+      @eye = Vector3.new(0,0,eye_z)
+      @near = radius - 1
+      @far = eye_z + radius
+      if @is_orgh
+        min_screen = [width, height].min
+        @scale = (min_screen.to_f/2.0)/radius
+      else
+        @scale = 1.0
+      end
+      set_screen(width,height)
+    end
 
-      GLUT.ReshapeFunc(method(:reshape).to_proc())
+    def set_screen(w,h)
+      @aspect = w.to_f()/h.to_f()
+      if @is_orgh
+        GL.Ortho(-w/2.0, w/2.0, -h/2.0, h/2.0, -@far*@scale*10, @far*@scale*10)
+      else
+        GLU.Perspective(@angle, @aspect, @near, @far)
+      end
     end
+
   end
 end