voxelamming_gem 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ff1ac60303d84e62d69ad720a84ef3db7e180ee41c121d0e8c099dfa267aa2d
-  data.tar.gz: 17e564b684612fcf5ae6e1fbb748e89f2eb429fed9eff5a6759d79a7f9017bbe
+  metadata.gz: f3a3fa9a3c78410940120fbf945818cce7ba33a60f4ca589929320420ad990fd
+  data.tar.gz: cb7d29c6d811dadbc7eb8ff91763e6a2239e83b319af986d73f1821d4f4e8d54
 SHA512:
-  metadata.gz: fb4f8cf109ff0205257e3e24cd11b2b634390beada5a4eb61135f936e809af393afa6675074359c76c85e39efd78bae969c8b2d14ad5de96335c4b68431f9cc5
-  data.tar.gz: a00a9cae5444283683504ae9476c875d6faf910bbbf7944d361cb043e22a0efdca3eb35fa802853c996571561a27729c23d0e3231663c31a95577b2113154b59
+  metadata.gz: 36a8daed67d4c48a57d5e5d1f297062f876b02d7aa23be48f913efed9d8940587135837f2984a1ab0d7d09caf8bf5bb1be2bad0f962129e6f2aa9e7d7b6f3b7b
+  data.tar.gz: d2efbaed4f7ad61cf6b30da9b57337698a1f40e3d29de41714395ecd1a3884b3b4645a22fd81c4b222e28f72b8df4c30a28a9d642b548bb0e465924d58496bd3

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## VoxelammingGem Change log
+
+### ver. 0.1.0
+
+- first release
+
+### ver. 0.1.1
+
+- Map and ply file paths changed to be specified as relative paths.
+- a few bug fixes
+
+### ver. 0.1.3
+
+- Changed so that the size of the map can be specified.

data/README.md

@@ -1,24 +1,80 @@
 # VoxelammingGem
 
-TODO: Delete this and the text below, and describe your gem
+This Ruby package converts Python code into JSON format and sends it to the Voxelamming app using WebSockets, allowing users to create 3D voxel models by writing Ruby scripts.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/voxelamming_gem`. To experiment with that code, run `bin/console` for an interactive prompt.
+## What's Voxelamming?
 
-## Installation
+<p align="center"><img src="https://creativival.github.io/voxelamming/image/voxelamming_icon.png" alt="Voxelamming Logo" width="200"/></p>
+
+Voxelamming is an AR programming learning app. Even programming beginners can learn programming visually and enjoyably. Voxelamming supports iPhones and iPads with iOS 16 or later, and Apple Vision Pro.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Resources
 
-Install the gem and add to the application's Gemfile by executing:
+* **Homepage:** https://creativival.github.io/voxelamming/index.en
+* **Samples:** https://github.com/creativival/voxelamming/tree/main/sample/ruby
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Installation
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+gem install voxelamming
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'voxelamming_gem'
+
+room_name = '1000'
+build_box = VoxelammingGem::BuildBox.new(room_name)
+
+build_box.set_box_size(0.5)
+build_box.set_build_interval(0.01)
+
+for i in 0...100
+  build_box.create_box(-1, i, 0, r: 0, g: 1, b: 1)
+  build_box.create_box(0, i, 0, r: 1, g: 0, b: 0)
+  build_box.create_box(1, i, 0, r: 1, g: 1, b: 0)
+  build_box.create_box(2, i, 0, r: 0, g: 1, b: 1)
+end
+
+for i in 0...50
+  build_box.remove_box(0, i * 2, 0)
+  build_box.remove_box(1, i * 2 + 1, 0)
+end
+
+build_box.send_data
+```
+
+This code snippet demonstrates a simple example where a red voxel is created at a specific location. You can use various functions provided by the `BuildBox` class to build more complex models.
+
+#### Method description
+
+| Method name | Description | Arguments |
+|---|---|---|
+| `set_room_name(room_name)` | Sets the room name for communicating with the device. | `room_name`: Room name (string) |
+| `set_box_size(size)` | Sets the size of the voxel (default: 1.0). | `size`: Size (float) |
+| `set_build_interval(interval)` | Sets the placement interval of the voxels (default: 0.01 seconds). | `interval`: Interval (float) |
+| `change_shape(shape)` | Changes the shape of the voxel. | `shape`: Shape ("box", "square", "plane") |
+| `change_material(is_metallic, roughness)` | Changes the material of the voxel. | `is_metallic`: Whether to make it metallic (boolean), `roughness`: Roughness (float) |
+| `create_box(x, y, z, r, g, b, alpha)` | Places a voxel. | `x`, `y`, `z`: Position (float), `r`, `g`, `b`, `alpha`: Color (float, 0-1) |
+| `create_box(x, y, z, texture)` | Places a voxel with texture. | `x`, `y`, `z`: Position (float), `texture`: Texture name (string) |
+| `remove_box(x, y, z)` | Removes a voxel. | `x`, `y`, `z`: Position (float) |
+| `write_sentence(sentence, x, y, z, r, g, b, alpha)` | Draws a string with voxels. | `sentence`: String (string), `x`, `y`, `z`: Position (float), `r`, `g`, `b`, `alpha`: Color (float, 0-1) |
+| `set_light(x, y, z, r, g, b, alpha, intensity, interval, light_type)` | Places a light. | `x`, `y`, `z`: Position (float), `r`, `g`, `b`, `alpha`: Color (float, 0-1), `intensity`: Intensity (float), `interval`: Blinking interval (float), `light_type`: Type of light ("point", "spot", "directional") |
+| `set_command(command)` | Executes a command. | `command`: Command ("axis", "japaneseCastle", "float", "liteRender") |
+| `draw_line(x1, y1, z1, x2, y2, z2, r, g, b, alpha)` | Draws a line between two points. | `x1`, `y1`, `z1`: Starting point (float), `x2`, `y2`, `z2`: Ending point (float), `r`, `g`, `b`, `alpha`: Color (float, 0-1) |
+| `send_data(name)` | Sends voxel data to the device; if the name argument is set, the voxel data can be stored and reproduced as history. | |
+| `clear_data()` | Initializes voxel data. | |
+| `translate(x, y, z, pitch, yaw, roll)` | Moves and rotates the coordinate system of the voxel. | `x`, `y`, `z`: Translation amount (float), `pitch`, `yaw`, `roll`: Rotation amount (float) |
+| `animate(x, y, z, pitch, yaw, roll, scale, interval)` | Animates a voxel. | `x`, `y`, `z`: Translation amount (float), `pitch`, `yaw`, `roll`: Rotation amount (float), `scale`: Scale (float), `interval`: Interval (float) |
+| `animate_global(x, y, z, pitch, yaw, roll, scale, interval)` | Animates all voxels. | `x`, `y`, `z`: Translation amount (float), `pitch`, `yaw`, `roll`: Rotation amount (float), `scale`: Scale (float), `interval`: Interval (float) |
+| `push_matrix()` | Saves the current coordinate system to the stack. | |
+| `pop_matrix()` | Restores the coordinate system from the stack. | |
+| `frame_in()` | Starts recording a frame. | |
+| `frame_out()` | Ends recording a frame. | |
+| `set_frame_fps(fps)` | Sets the frame rate (default: 2). | `fps`: Frame rate (int) |
+| `set_frame_repeats(repeats)` | Sets the number of frame repetitions (default: 10). | `repeats`: Number of repetitions (int) |
 
 ## Development
 

data/index.html

@@ -0,0 +1,139 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <title>VoxelammingGem</title>
+    <style>
+        body {
+            font-family: sans-serif;
+            line-height: 1.6;
+            margin: 2rem auto;
+            max-width: 800px;
+            padding: 0 1rem;
+        }
+
+        h1, h2, h3 {
+            margin-top: 1.5rem;
+        }
+
+        a {
+            color: #0645ad;
+            text-decoration: none;
+        }
+
+        a:hover {
+            text-decoration: underline;
+        }
+
+        img {
+            max-width: 100%;
+            height: auto;
+        }
+
+        pre {
+            background-color: #f5f5f5;
+            border: 1px solid #ccc;
+            overflow-x: auto;
+            padding: 1rem;
+        }
+
+        code {
+            font-family: monospace;
+        }
+
+        table {
+            border-collapse: collapse;
+            width: 100%;
+        }
+
+        th, td {
+            border: 1px solid #ccc;
+            padding: 0.5rem;
+        }
+
+        th {
+            background-color: #f0f0f0;
+            font-weight: bold;
+        }
+    </style>
+</head>
+<body>
+<h1><a href="#voxelamminggem" id="voxelamminggem"></a>VoxelammingGem</h1>
+<p>This Ruby package converts Python code into JSON format and sends it to the Voxelamming app using WebSockets, allowing users to create 3D voxel models by writing Ruby scripts.</p>
+<h2><a href="#whats-voxelamming" id="whats-voxelamming"></a>What's Voxelamming?</h2>
+<p align="center"><img src="https://creativival.github.io/voxelamming/image/voxelamming_icon.png" alt="Voxelamming Logo" width="200"/></p>
+<p>Voxelamming is an AR programming learning app. Even programming beginners can learn programming visually and enjoyably. Voxelamming supports iPhones and iPads with iOS 16 or later, and Apple Vision Pro.</p>
+<h2><a href="#resources" id="resources"></a>Resources</h2>
+<ul>
+    <li><strong>Homepage:</strong> <a href="https://creativival.github.io/voxelamming/index.en">https://creativival.github.io/voxelamming/index.en</a></li>
+    <li><strong>Samples:</strong> <a href="https://github.com/creativival/voxelamming/tree/main/sample/ruby">https://github.com/creativival/voxelamming/tree/main/sample/ruby</a></li>
+</ul>
+<h2><a href="#installation" id="installation"></a>Installation</h2>
+<pre><code class="bash">gem install voxelamming
+</code></pre>
+<h2><a href="#usage" id="usage"></a>Usage</h2>
+<pre><code class="ruby">require 'voxelamming_gem'
+
+room_name = '1000'
+build_box = VoxelammingGem::BuildBox.new(room_name)
+
+build_box.set_box_size(0.5)
+build_box.set_build_interval(0.01)
+
+for i in 0...100
+  build_box.create_box(-1, i, 0, r: 0, g: 1, b: 1)
+  build_box.create_box(0, i, 0, r: 1, g: 0, b: 0)
+  build_box.create_box(1, i, 0, r: 1, g: 1, b: 0)
+  build_box.create_box(2, i, 0, r: 0, g: 1, b: 1)
+end
+
+for i in 0...50
+  build_box.remove_box(0, i * 2, 0)
+  build_box.remove_box(1, i * 2 + 1, 0)
+end
+
+build_box.send_data
+</code></pre>
+<p>This code snippet demonstrates a simple example where a red voxel is created at a specific location. You can use various functions provided by the <code>BuildBox</code> class to build more complex models.</p>
+<h4><a href="#method-description" id="method-description"></a>Method description</h4>
+<table>
+    <thead>
+    <tr><th> Method name </th><th> Description </th><th> Arguments </th></tr>
+    </thead>
+    <tbody>
+    <tr><td> <code>set_room_name(room_name)</code> </td><td> Sets the room name for communicating with the device. </td><td> <code>room_name</code>: Room name (string) </td></tr>
+    <tr><td> <code>set_box_size(size)</code> </td><td> Sets the size of the voxel (default: 1.0). </td><td> <code>size</code>: Size (float) </td></tr>
+    <tr><td> <code>set_build_interval(interval)</code> </td><td> Sets the placement interval of the voxels (default: 0.01 seconds). </td><td> <code>interval</code>: Interval (float) </td></tr>
+    <tr><td> <code>change_shape(shape)</code> </td><td> Changes the shape of the voxel. </td><td> <code>shape</code>: Shape ("box", "square", "plane") </td></tr>
+    <tr><td> <code>change_material(is_metallic, roughness)</code> </td><td> Changes the material of the voxel. </td><td> <code>is_metallic</code>: Whether to make it metallic (boolean), <code>roughness</code>: Roughness (float) </td></tr>
+    <tr><td> <code>create_box(x, y, z, r, g, b, alpha)</code> </td><td> Places a voxel. </td><td> <code>x</code>, <code>y</code>, <code>z</code>: Position (float), <code>r</code>, <code>g</code>, <code>b</code>, <code>alpha</code>: Color (float, 0-1) </td></tr>
+    <tr><td> <code>create_box(x, y, z, texture)</code> </td><td> Places a voxel with texture. </td><td> <code>x</code>, <code>y</code>, <code>z</code>: Position (float), <code>texture</code>: Texture name (string) </td></tr>
+    <tr><td> <code>remove_box(x, y, z)</code> </td><td> Removes a voxel. </td><td> <code>x</code>, <code>y</code>, <code>z</code>: Position (float) </td></tr>
+    <tr><td> <code>write_sentence(sentence, x, y, z, r, g, b, alpha)</code> </td><td> Draws a string with voxels. </td><td> <code>sentence</code>: String (string), <code>x</code>, <code>y</code>, <code>z</code>: Position (float), <code>r</code>, <code>g</code>, <code>b</code>, <code>alpha</code>: Color (float, 0-1) </td></tr>
+    <tr><td> <code>set_light(x, y, z, r, g, b, alpha, intensity, interval, light_type)</code> </td><td> Places a light. </td><td> <code>x</code>, <code>y</code>, <code>z</code>: Position (float), <code>r</code>, <code>g</code>, <code>b</code>, <code>alpha</code>: Color (float, 0-1), <code>intensity</code>: Intensity (float), <code>interval</code>: Blinking interval (float), <code>light_type</code>: Type of light ("point", "spot", "directional") </td></tr>
+    <tr><td> <code>set_command(command)</code> </td><td> Executes a command. </td><td> <code>command</code>: Command ("axis", "japaneseCastle", "float", "liteRender") </td></tr>
+    <tr><td> <code>draw_line(x1, y1, z1, x2, y2, z2, r, g, b, alpha)</code> </td><td> Draws a line between two points. </td><td> <code>x1</code>, <code>y1</code>, <code>z1</code>: Starting point (float), <code>x2</code>, <code>y2</code>, <code>z2</code>: Ending point (float), <code>r</code>, <code>g</code>, <code>b</code>, <code>alpha</code>: Color (float, 0-1) </td></tr>
+    <tr><td> <code>send_data(name)</code> </td><td> Sends voxel data to the device; if the name argument is set, the voxel data can be stored and reproduced as history. </td><td> </td></tr>
+    <tr><td> <code>clear_data()</code> </td><td> Initializes voxel data. </td><td> </td></tr>
+    <tr><td> <code>translate(x, y, z, pitch, yaw, roll)</code> </td><td> Moves and rotates the coordinate system of the voxel. </td><td> <code>x</code>, <code>y</code>, <code>z</code>: Translation amount (float), <code>pitch</code>, <code>yaw</code>, <code>roll</code>: Rotation amount (float) </td></tr>
+    <tr><td> <code>animate(x, y, z, pitch, yaw, roll, scale, interval)</code> </td><td> Animates a voxel. </td><td> <code>x</code>, <code>y</code>, <code>z</code>: Translation amount (float), <code>pitch</code>, <code>yaw</code>, <code>roll</code>: Rotation amount (float), <code>scale</code>: Scale (float), <code>interval</code>: Interval (float) </td></tr>
+    <tr><td> <code>animate_global(x, y, z, pitch, yaw, roll, scale, interval)</code> </td><td> Animates all voxels. </td><td> <code>x</code>, <code>y</code>, <code>z</code>: Translation amount (float), <code>pitch</code>, <code>yaw</code>, <code>roll</code>: Rotation amount (float), <code>scale</code>: Scale (float), <code>interval</code>: Interval (float) </td></tr>
+    <tr><td> <code>push_matrix()</code> </td><td> Saves the current coordinate system to the stack. </td><td> </td></tr>
+    <tr><td> <code>pop_matrix()</code> </td><td> Restores the coordinate system from the stack. </td><td> </td></tr>
+    <tr><td> <code>frame_in()</code> </td><td> Starts recording a frame. </td><td> </td></tr>
+    <tr><td> <code>frame_out()</code> </td><td> Ends recording a frame. </td><td> </td></tr>
+    <tr><td> <code>set_frame_fps(fps)</code> </td><td> Sets the frame rate (default: 2). </td><td> <code>fps</code>: Frame rate (int) </td></tr>
+    <tr><td> <code>set_frame_repeats(repeats)</code> </td><td> Sets the number of frame repetitions (default: 10). </td><td> <code>repeats</code>: Number of repetitions (int) </td></tr>
+    </tbody>
+</table>
+<h2><a href="#development" id="development"></a>Development</h2>
+<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake test</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
+<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and the created tag, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
+<h2><a href="#contributing" id="contributing"></a>Contributing</h2>
+<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/[USERNAME]/voxelamming_gem">https://github.com/[USERNAME]/voxelamming_gem</a>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="https://github.com/[USERNAME]/voxelamming_gem/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
+<h2><a href="#license" id="license"></a>License</h2>
+<p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
+<h2><a href="#code-of-conduct" id="code-of-conduct"></a>Code of Conduct</h2>
+<p>Everyone interacting in the VoxelammingGem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the <a href="https://github.com/[USERNAME]/voxelamming_gem/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
+</body>
+</html>

data/lib/voxelamming_gem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VoxelammingGem
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/voxelamming_gem.rb

@@ -491,9 +491,7 @@ module VoxelammingGem
   end
 
   # Map
-  $column_num, $row_num = 257, 257
-
-  def self.get_map_data_from_csv(csv_file, height_scale)
+  def self.get_map_data_from_csv(csv_file, height_scale, column_num = 257, row_num = 257)
     # csvファイルから地図データを読み込み
     heights = []
 
@@ -507,7 +505,7 @@ module VoxelammingGem
     #   puts "heights: #{heights}"
 
     max_height = heights.max.floor
-    box_positions = (0...$row_num).map { |i| heights[i * $column_num, $column_num] }
+    box_positions = (0...row_num).map { |i| heights[i * column_num, column_num] }
     puts "max_height: #{max_height}"
     #   puts "box_positions: #{box_positions}"
     { 'boxes' => box_positions, 'max_height' => max_height }

data/main_make_model.rb

@@ -6,7 +6,7 @@ build_box = VoxelammingGem::BuildBox.new(room_name)
 build_box.set_box_size(0.5)
 build_box.set_build_interval(0.01)
 
-ply_file_name = 'piyo.ply'
+ply_file_name = 'ply_file/piyo.ply'
 
 boxes = VoxelammingGem.get_boxes_from_ply(ply_file_name)
 # puts boxes

data/main_map.rb

@@ -8,7 +8,7 @@ build_box.set_build_interval(0.001)
 build_box.set_command('liteRender')
 
 column_num, row_num = 257, 257
-csv_file = 'map_38_138_100km.csv'
+csv_file = 'map_file/map_38_138_100km.csv'
 height_scale = 100
 high_color = [0.5, 0, 0]
 low_color = [0, 1, 0]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voxelamming_gem
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - creativival
@@ -34,10 +34,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- index.html
 - lib/matrix_util.rb
 - lib/voxelamming_gem.rb
 - lib/voxelamming_gem/version.rb
@@ -52,6 +54,8 @@ files:
 - ply_file/frog5.ply
 - ply_file/piyo.ply
 - sig/voxelamming_gem.rbs
+- voxelamming_gem-0.1.0.gem
+- voxelamming_gem-0.1.1.gem
 homepage: https://creativival.github.io/voxelamming
 licenses:
 - MIT