magica_voxel 0.1.0

data/lib/magica_voxel/frame.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'matrix'
+
+module MagicaVoxel
+  # The Frame of Transform
+  #
+  # @since 0.1.0
+  class Frame
+    # @param [Hash] attributes
+    #
+    # @since 0.1.0
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    # Rotation
+    #
+    # @return [Matrix]
+    #
+    # @since 0.1.0
+    def rotation
+      nil # TODO
+    end
+
+    # Translate
+    #
+    # @return [Vector3]
+    #
+    # @since 0.1.0
+    def translate
+      return Vector3.new(0, 0, 0) if @attributes['_t'].nil?
+
+      x, y, z = @attributes['_t'].split
+      @translate ||=
+        Vector3.new(x.to_i, y.to_i, z.to_i)
+    end
+
+    # Index
+    #
+    # @return [Number]
+    def index
+      return 0 if @attributes['_f'].nil?
+
+      @index ||= @attributes['_f'].to_i
+    end
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def inspect
+      "#<MagicaVoxel::Frame index=#{index}, translate=#{translate}>"
+    end
+  end
+end

data/lib/magica_voxel/group.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type nGRP
+  #
+  # @since 0.1.0
+  class Group < Node
+    # @since 0.1.0
+    attr_reader :child_ids
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def inspect
+      "#<MagicaVoxel::Group id=#{id}, name=#{name}, hidden=#{hidden?}>"
+    end
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        id: :int32,
+        attributes: :dict,
+        child_ids: :int32_array
+      }
+    end
+  end
+end

data/lib/magica_voxel/layer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type LAYR
+  #
+  # TODO: Remove dependency on Node
+  #
+  # @since 0.1.0
+  class Layer < Node
+    # @since 0.1.0
+    attr_reader :reserved_id
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def inspect
+      "#<MagicaVoxel::Layer id=#{id}, name=#{name}, hidden=#{hidden?}>"
+    end
+
+    # TODO: Expose Properties
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        id: :int32,
+        attributes: :dict,
+        reversed_id: :int32
+      }
+    end
+  end
+end

data/lib/magica_voxel/main.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type MAIN
+  #
+  # @since 0.1.0
+  class Main < Chunk
+  end
+end

data/lib/magica_voxel/material.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type MATL
+  #
+  # @since 0.1.0
+  class Material < Chunk
+    # @since 0.1.0
+    attr_reader :id, :properties
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def inspect
+      "#<MagicaVoxel::Material id=#{id}>"
+    end
+
+    # TODO: Expose Properties
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        id: :int32,
+        properties: :dict
+      }
+    end
+  end
+end

data/lib/magica_voxel/model.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type XYZI
+  #
+  # @since 0.1.0
+  class Model < Chunk
+    # @since 0.1.0
+    attr_reader :voxels
+
+    # :nodoc:
+    #
+    # @return 0.1.0
+    def inspect
+      "#<MagicaVoxel::Model size=#{voxels.size}>"
+    end
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        voxels: :voxels
+      }
+    end
+  end
+end

data/lib/magica_voxel/node.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Node type Chunk
+  #
+  # @since 0.1.0
+  class Node < Chunk
+    # @since 0.1.0
+    attr_reader :id, :attributes
+
+    # @return [String] name
+    #
+    # @since 0.1.0
+    def name
+      @attributes['_name']
+    end
+
+    # @return [TrueClass|FalseClass] is hidden
+    #
+    # @since 0.1.0
+    def hidden?
+      @attributes['_hidden'] == '1'
+    end
+  end
+end

data/lib/magica_voxel/note.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type NOTE
+  #
+  # @since 0.1.0
+  class Note < Chunk
+    # @since 0.1.0
+    attr_reader :names
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        names: :string_array
+      }
+    end
+  end
+end

data/lib/magica_voxel/object.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type rOBJ
+  #
+  # @since 0.1.0
+  class Object < Chunk
+    # @since 0.1.0
+    attr_reader :attributes
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        attributes: :dict
+      }
+    end
+  end
+end

data/lib/magica_voxel/pattle.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type RGBA
+  #
+  # @since 0.1.0
+  class Pattle < Chunk
+    # @since 0.1.0
+    attr_reader :pattle
+
+    # Get color by index
+    #
+    # @param id [Number]
+    #
+    # @return [MagicVoxel::Color]
+    #
+    # @since 0.1.0
+    def [](id)
+      @pattle[id]
+    end
+
+    # :nodoc
+    #
+    # @since 0.1.0
+    def inspect
+      '#<MagicaVoxel::Pattle>'
+    end
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        pattle: :pattle
+      }
+    end
+  end
+end

data/lib/magica_voxel/pattle_map.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type IMAP
+  #
+  # @since 0.1.0
+  class PattleMap < Chunk
+    # @since 0.1.0
+    attr_reader :items
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        items: :imap
+      }
+    end
+  end
+end

data/lib/magica_voxel/reader.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Data Reader
+  #
+  # @since 0.1.0
+  class Reader
+    class << self
+      # Open IO stream
+      #
+      # @param [IO|String] the stream to read
+      #
+      # @since 0.1.0
+      def open(io)
+        io = io.is_a?(IO) ? io : StringIO.new(io)
+        yield new(io)
+        io.close
+      end
+    end
+    # @param [IO] the stream to read
+    #
+    # @since 0.1.0
+    def initialize(io)
+      @io = io
+    end
+
+    # Read int32
+    #
+    # @return [Number]
+    #
+    # @since 0.1.0
+    def int32
+      @io.read(4).unpack1('l')
+    end
+
+    # Read String
+    #
+    # @return [String]
+    #
+    # @since 0.1.0
+    def string
+      @io.read(int32)
+    end
+
+    # Read Dictionary
+    #
+    # @return [Hash]
+    #
+    # @since 0.1.0
+    def dict
+      Hash[*Array.new(int32 * 2).map { string }]
+    end
+
+    # Read Int32 Array
+    #
+    # @return [Array<Number>]
+    #
+    # @since 0.1.0
+    def int32_array
+      Array.new(int32).map { int32 }
+    end
+
+    # Read String Array
+    #
+    # @return [Array<String>]
+    #
+    # @since 0.1.0
+    def string_array
+      Array.new(int32).map { string }
+    end
+
+    # Read Frames
+    #
+    # @return [Array<MagicaVoxel::Frame>]
+    #
+    # @since 0.1.0
+    def frames
+      Array.new(int32).map { Frame.new(dict) }
+    end
+
+    # Read Pattle
+    #
+    # @return [Array<MagicaVoxel::Color]
+    #
+    # @since 0.1.0
+    def pattle
+      Array.new(256).map { rgba }
+    end
+
+    # Read RGBA
+    #
+    # @return [MagicaVoxel::Color]
+    #
+    # @since 0.1.0
+    def rgba
+      r, g, b, a = @io.read(4).unpack('CCCC')
+      Color.new(r, g, b, a)
+    end
+
+    # Read Pattle Index MAP
+    #
+    # @return [Array<Number>]
+    #
+    # @since 0.1.0
+    def imap
+      Array.new(256).map { int32 }
+    end
+
+    # Read Voxels
+    #
+    # @return [Array<MagicaVoxel::Voxel>]
+    #
+    # @since 0.1.0
+    def voxels
+      Array.new(int32).map { voxel }
+    end
+
+    # Read Voxel
+    #
+    # @return [MagicaVoxel::Voxel]
+    #
+    # @since 0.1.0
+    def voxel
+      x, y, z, i = @io.read.unpack('cccC')
+      Voxel.new(x, y, z, i)
+    end
+
+    # Read Shape's Model
+    #
+    # @return [MagicaVoxel::Shape::Model]
+    #
+    # @since 0.1.0
+    def shape_model
+      Array.new(int32).map { Shape::Model.new(int32, dict) }
+    end
+  end
+end

data/lib/magica_voxel/shape.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type nSHP
+  #
+  # @since 0.1.0
+  class Shape < Node
+    # :nodoc:
+    class Model
+      # @since 0.1.0
+      attr_reader :id, :attributes
+
+      # @param id [Number] the mode id
+      # @param attributes [Hash] the model attributes
+      #
+      # @since 0.1.0
+      def initialize(id, attributes)
+        @id = id
+        @attributes = attributes
+      end
+    end
+
+    # @since 0.1.0
+    attr_reader :models
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def inspect
+      "#<MagicaVoxel::Shape id=#{id}, name=#{name}, hidden=#{hidden?}>"
+    end
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        id: :int32,
+        attributes: :dict,
+        models: :shape_model
+      }
+    end
+  end
+end

data/lib/magica_voxel/size.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type SIZE
+  #
+  # @since 0.1.0
+  class Size < Chunk
+    # @since 0.1.0
+    attr_reader :x, :y, :z
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def inspect
+      "#<MagicaVoxel::Size x=#{x}, y=#{y}, z=#{z}>"
+    end
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        x: :int32,
+        y: :int32,
+        z: :int32
+      }
+    end
+  end
+end

data/lib/magica_voxel/transform.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  # The Chunk type nTRN
+  #
+  # @since 0.1.0
+  class Transform < Node
+    # @since 0.1.0
+    attr_reader :child_id, :reserved_id, :layer_id, :frames
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def inspect
+      "#<MagicaVoxel::Transform id=#{id}, name=#{name}, hidden=#{hidden?}>"
+    end
+
+    private
+
+    # :nodoc:
+    #
+    # @since 0.1.0
+    def layout
+      {
+        id: :int32,
+        attributes: :dict,
+        child_id: :int32,
+        reserved_id: :int32,
+        layer_id: :int32,
+        frames: :frames
+      }
+    end
+  end
+end

data/lib/magica_voxel/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MagicaVoxel
+  VERSION = '0.1.0'
+end

data/lib/magica_voxel.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'magica_voxel/version'
+require_relative 'magica_voxel/reader'
+require_relative 'magica_voxel/chunk'
+require_relative 'magica_voxel/main'
+require_relative 'magica_voxel/size'
+require_relative 'magica_voxel/model'
+require_relative 'magica_voxel/pattle'
+require_relative 'magica_voxel/node'
+require_relative 'magica_voxel/transform'
+require_relative 'magica_voxel/frame'
+require_relative 'magica_voxel/group'
+require_relative 'magica_voxel/shape'
+require_relative 'magica_voxel/material'
+require_relative 'magica_voxel/layer'
+require_relative 'magica_voxel/object'
+require_relative 'magica_voxel/camera'
+require_relative 'magica_voxel/note'
+require_relative 'magica_voxel/pattle_map'
+require_relative 'magica_voxel/file'
+
+# The MagicaVoxel file parser
+#
+# @since 0.1.0
+module MagicaVoxel
+  # The Voxel Data
+  #
+  # @since 0.1.0
+  Voxel = Struct.new(:x, :y, :z, :color)
+
+  # The Voxel Color
+  #
+  # @since 0.1.0
+  Color = Struct.new(:r, :g, :b, :a)
+
+  # The Vector3
+  #
+  # @since 0.1.0
+  Vector3 = Struct.new(:x, :y, :z)
+end

data/magica_voxel.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/magica_voxel/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'magica_voxel'
+  spec.version = MagicaVoxel::VERSION
+  spec.authors = ['蒼時弦也']
+  spec.email = ['contact@frost.tw']
+
+  spec.summary = 'The MagicaVoxel reader'
+  spec.description = 'The MagicaVoxel reader'
+  spec.homepage = 'https://github.com/elct9620/magica_voxel-rb'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/elct9620/magica_voxel-rb'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+end