autocad 0.4.6 → 0.5

data/lib/autocad/layer.rb

@@ -1,41 +1,129 @@
-module Autocad
-  class Layer < Element
-    def name
-      ole_obj.name
-    end
-
-    def description
-      ole_obj.description
-    end
-
-    def lock(lk = true)
-      ole_obj.Lock = lk
-    rescue
-      raise Autocad::Error.new("Error locking layer #{name}")
-    end
-
-    def visible?
-      ole_obj.Visible
-    end
-
-    def visible=(vis)
-      ole_obj.Visible = vis
-    end
-
-    def delete
-      ole_obj.Delete
-    rescue => e
-      raise Autocad::Error.new("Error deleting layer #{name} #{e}")
-    end
-
-    def linetype=(ltname)
-      found_lt = app.current_drawing.linetypes.find { |lt| lt.name == ltname }
-
-      app.current_drawing.ole_obj.Linetypes.Load(ltname, ltname) unless found_lt
-
-      ole_obj.Linetype = ltname
-    rescue => e
-      raise Autocad::Error.new("Error setting linetype of layer #{name} : #{e}")
-    end
-  end
-end
+module Autocad
+  class Layer < Element
+    # @rbs return String -- the name of the layer
+    def name
+      ole_obj.name
+    end
+
+    # Get the color of the layer
+    # @rbs return Integer -- the color index of the layer
+    def color
+      ole_obj.Color
+    end
+
+    # Set the color of the layer
+    # @rbs color: Integer|Symbol -- the color to set (can be ACAD::COLOR constant, symbol, or integer)
+    # @rbs return void
+    def color=(color)
+      ole_obj.Color = Autocad.color_to_index(color)
+    end
+
+    # Get the symbolic color name if available
+    # @rbs return Symbol|Integer -- the symbolic color name or integer if no name exists
+    def color_name
+      Autocad::Color.from_index(color)
+    end
+
+    # set the name of the layer
+    # @rbs name: String
+    # @rbs return void
+    def name=(name)
+      ole_obj.name = name
+    end
+
+    def description
+      ole_obj.description
+    end
+
+    #  is the layer the active layer
+    # @rbs return bool
+    def active?
+      drawing.active_layer_name == name
+    end
+
+    # Activates the current layer by setting it as the active layer in the drawing.
+    # This method assigns the current layer's OLE object to the ActiveLayer property of the drawing's OLE object.
+    #
+    # @rbs return void
+    def activate
+      drawing.ole_obj.ActiveLayer = ole_obj
+    end
+
+    # @rbs return bool
+    def frozen?
+      ole_obj.Freeze
+    end
+
+    #  freeze the layer - entities on layer are invisible and wont be
+    #  regenerated
+    def freeze
+      ole_obj.Freeze = true
+    end
+
+    #  unfreeze the layer
+    def unfreeze
+      ole_obj.Freeze = false
+    end
+
+    # @rbs return bool
+    def thawed?
+      !frozen?
+    end
+
+    alias_method :thaw, :unfreeze
+
+    # lock the layer - entities on layer can't be changed
+    def lock
+      ole_obj.Lock = true
+    end
+
+    # unlock the layer
+    def unlock
+      ole_obj.Lock = false
+    end
+
+    # @rbs return bool -- true if layer is locked
+    def locked?
+      ole_obj.Lock
+    end
+
+    def visible?
+      ole_obj.Visible
+    end
+
+    def visible=(vis)
+      ole_obj.Visible = vis
+    end
+
+    #  turn on the layer.
+    #
+    def turn_on
+      ole_obj.LayerOn = true
+    end
+
+    def turn_off
+      ole_obj.LayerOn = false
+    end
+
+    # @rbs return bool
+    def on?
+      ole_obj.LayerOn
+    end
+
+    def delete
+      ole_obj.Delete
+    rescue => e
+      raise Autocad::Error.new("Error deleting layer #{name} #{e}")
+    end
+
+    def linetype=(ltname)
+      found_lt = app.current_drawing.linetypes.find { |lt| lt.name == ltname }
+
+      app.current_drawing.ole_obj.Linetypes.Load(ltname, ltname) unless found_lt
+
+      ole_obj.Linetype = ltname
+    rescue => e
+      raise Autocad::Error.new("Error setting linetype of layer #{name} : #{e}")
+    end
+  end
+end

data/lib/autocad/layout.rb

@@ -0,0 +1,120 @@
+module Autocad
+  class Layout < PlotConfiguration
+    # Inserts a block into the layout
+    # @rbs block: Block
+    # @rbs pt: Point3d?
+    # @rbs return void
+    def insert_block(block, pt: nil)
+    end
+
+    # Get the layout name
+    # @rbs return String
+    def name
+      @ole_obj.Name
+    end
+
+    # Set the layout name
+    # @rbs str: String
+    # @rbs return void
+    def name=(str)
+      @ole_obj.Name = str
+    end
+
+    # Copy plot settings from another configuration
+    # @rbs pc: PlotConfiguration
+    # @rbs return void
+    def copy_plot_configuration(pc)
+      ole_obj.CopyFrom(pc.ole_obj)
+    end
+
+    # Insert a block reference into the layout
+    # @rbs name: String
+    # @rbs pt: Point3d
+    # @rbs rotation: Float
+    # @rbs scale: Float
+    # @rbs return BlockReference?
+    # @raise [StandardError] On insertion failure
+    def add_block_reference(name, pt:, rotation: 0.0, scale: 1.0)
+      name = name.to_s
+      name = app.windows_path(name) if File.file?(name)
+      
+      pt3d = Point3d.new(pt)
+      ole_reference = ole_obj.Block.InsertBlock(pt3d.to_ole, name.to_s,
+        scale.to_f, scale.to_f, scale.to_f, rotation.to_f)
+      app.wrap(ole_reference)
+    rescue StandardError => e
+      app.error_proc.call(e, self)
+      nil
+    end
+
+    # Get layout tab order position
+    # @rbs return Integer
+    def tab_order
+      @ole_obj.TabOrder
+    end
+
+    # Set layout tab order position
+    # @rbs n: Integer
+    # @rbs return void
+    def tab_order=(n)
+      @ole_obj.TabOrder = n
+    end
+
+    # Get paper dimensions in millimeters
+    # @rbs return [Float, Float]
+    def paper_size
+      width = WIN32OLE_VARIANT.new(nil, WIN32OLE::VARIANT::VT_BYREF | WIN32OLE::VARIANT::VT_R8)
+      height = WIN32OLE_VARIANT.new(nil, WIN32OLE::VARIANT::VT_BYREF | WIN32OLE::VARIANT::VT_R8)
+      @ole_obj.GetPaperSize(width, height)
+      [width.value, height.value]
+    end
+
+    # Calculate usable area bounds with margins
+    # @rbs return BoundingBox
+    def bounds
+      width, height = paper_size
+      lower_left, upper_right = paper_margins
+      lower_left_pt = lower_left
+      upper_right_pt = Point3d(width, height) - upper_right
+      BoundingBox.from_min_max(lower_left_pt, upper_right_pt)
+    end
+
+    # Get paper size in inches
+    # @rbs return [Float, Float]
+    def paper_size_inches
+      width, height = paper_size
+      [width / 25.4, height / 25.4]
+    end
+
+    # Add a paper space viewport
+    # @rbs scale: Symbol
+    # @rbs return PViewport
+    def add_pviewport(scale = :scale_to_fit)
+      psize_width, psize_h = paper_size
+      margins = paper_margins
+      width_mm = psize_width - margins[0][0] - margins[1][0]
+      height_mm = psize_h - margins[0][1] - margins[1][1]
+      width = width_mm / paper_units_scale_factor
+      height = height_mm / paper_units_scale_factor
+
+      center = [width / 2.0, height / 2.0]
+      pv = drawing.paper_space.add_pv_viewport(center, width: width, height: height)
+      pv.on
+      pv.standard_scale = scale
+      pv
+    end
+
+    # Get page margins
+    # @rbs return [[Float, Float], [Float, Float]]
+    def paper_margins
+      lower_left = nil
+      upper_right = nil
+      @ole_obj.GetPaperMargins lower_left, upper_right
+      lower_left, upper_right = WIN32OLE::ARGV
+      [lower_left, upper_right]
+    rescue StandardError => e
+      puts "Error getting paper margins: #{e.message}"
+      [[0.0, 0.0], [0.0, 0.0]]  # Return default values instead of breaking
+    end
+  end
+end

data/lib/autocad/line.rb

@@ -1,55 +1,154 @@
-# rbs_inline: enabled
-
-require_relative 'element'
-
-module Autocad
-  class Line < Element
-    def length
-      ole_obj.length
-    end
-
-    def line?
-      true
-    end
-
-    def start_point # : Point3d
-      Point3d(ole_obj.StartPoint)
-    end
-
-    def end_point # : Point3d
-      Point3d(ole_obj.EndPoint)
-    end
-
-    def normal
-      ole_obj.Normal
-    end
-
-    def thickness
-      ole_obj.Thickness
-    end
-
-    def delta
-      ole_obj.Delta
-    end
-  end
-
-  class Circle < Element
-    def center
-      Point3d.new(ole_obj.Center)
-    end
-
-    def radius
-      Point3d.new(ole_obj.Radius)
-    end
-  end
-
-  class Polyline < Element
-    def length
-      @ole_obj.Length
-    end
-
-    def coordinates
-      @ole_obj.coordinates
-    end
-  end
-end
+# rbs_inline: enabled
+
+require_relative 'element'
+
+module Autocad
+  # Represents a line entity in AutoCAD, providing access to geometric properties and spatial relationships.
+  #
+  # Key Features:
+  # - Length calculation
+  # - Start/end point coordinates
+  # - 3D orientation properties
+  # - Thickness control
+  # - Geometric vector analysis
+  #
+  # Geometric Relationships:
+  #        Normal (Z-axis)
+  #           ↑
+  #           │
+  # Start ●───┼───● End
+  #           │
+  #           └─── Delta Vector
+  #
+  # @example Create and query a line
+  #   line = drawing.model.add_line([0,0,0], [5,5,0])
+  #   puts line.length  # => 7.0710678118654755
+  #   puts line.delta   # => (5.0, 5.0, 0.0)
+  class Line < Element
+    # Calculates the linear length of the line segment.
+    #
+    # @example
+    #   line = drawing.model.add_line([0,0,0], [5,5,0])
+    #   puts line.length  # => 7.0710678118654755
+    #
+    # @return [Float] The length of the line
+    # @rbs return float
+    def length
+      ole_obj.length
+    end
+
+    # Type-check method confirming this is a line entity.
+    #
+    # @example
+    #   line.line?  # => true
+    #
+    # @return [Boolean] Always returns true for Line objects
+    # @rbs return bool
+    def line?
+      true
+    end
+
+    # 3D coordinates of the line's starting point in World Coordinate System (WCS).
+    #
+    # @example
+    #   start = line.start_point
+    #   puts start  # => (0.0, 0.0, 0.0)
+    #
+    # @return [Point3d] The start point coordinates
+    # @rbs return Point3d
+    def start_point
+      Point3d.new(ole_obj.StartPoint)
+    end
+
+    # 3D coordinates of the line's endpoint in World Coordinate System (WCS).
+    #
+    # @example
+    #   ending = line.end_point
+    #   puts ending  # => (5.0, 5.0, 0.0)
+    #
+    # @return [Point3d] The end point coordinates
+    # @rbs return Point3d
+    def end_point
+      Point3d.new(ole_obj.EndPoint)
+    end
+
+    # Unit vector perpendicular to the line's plane (Z-axis direction by default).
+    #
+    # Properties:
+    # - Always returns unit vector (magnitude = 1)
+    # - Affects shading and 3D operations
+    #
+    # @example
+    #   line.normal  # => (0.0, 0.0, 1.0)
+    #
+    # @return [Point3d] The normal vector
+    # @rbs return Point3d
+    def normal
+      Point3d.new ole_obj.Normal
+    end
+
+    # Extrusion thickness along the normal vector (3D effect).
+    #
+    # Note:
+    # - Positive values extrude in normal direction
+    # - Negative values extrude opposite direction
+    # - 0 = 2D line
+    #
+    # @example
+    #   line.thickness = 2.5  # Creates 3D prism
+    #
+    # @return [Float] The current thickness value
+    # @rbs return float
+    def thickness
+      ole_obj.Thickness
+    end
+
+    # Directional vector from start to end point (equivalent to `end_point - start_point`).
+    #
+    # Mathematical Properties:
+    # - X/Y/Z components = coordinate differences
+    # - Magnitude = line length
+    #
+    # @example
+    #   line.delta  # => (5.0, 5.0, 0.0)
+    #   line.delta.magnitude == line.length  # => true
+    #
+    # @return [Point3d] The vector from start to end point
+    # @rbs return Point3d
+    def delta
+      Point3d.new ole_obj.Delta
+    end
+  end
+
+  class Circle < Element
+    # The center point of the circle in World Coordinate System (WCS)
+    # @rbs return Point3d
+    def center
+      Point3d.new(ole_obj.Center)
+    end
+
+    # The radius of the circle
+    # @rbs return float
+    def radius
+      ole_obj.Radius
+    end
+
+    def inspect
+      "#<#{self.class} center=#{center} radius=#{radius}>"
+    end
+  end
+
+  class Polyline < Element
+    # The total length of all polyline segments
+    # @rbs return float
+    def length
+      Point3d.new @ole_obj.Length
+    end
+
+    # Array of all vertex coordinates in the polyline
+    # @rbs return Array[Point3d]
+    def coordinates
+      @ole_obj.coordinates.map { |pt| Point3d.new(pt) }
+    end
+  end
+end

data/lib/autocad/message_box.rb

@@ -1,95 +1,95 @@
-require "fiddle/import"
-require "fiddle/types"
-
-module WinAPI
-  extend Fiddle::Importer
-  dlload "user32.dll"
-  include Fiddle::BasicTypes
-  include Fiddle::Win32Types
-
-  typealias "LPCWSTR", "wchar_t*"
-
-  extern "int MessageBoxA(HWND, LPCSTR, LPCSTR, DWORD)"
-  extern "int MessageBoxW(HWND, LPCWSTR, LPCWSTR, DWORD)"
-  # window handling
-  extern "HWND GetForegroundWindow()"
-  extern "int GetWindowText(HWND, char*, int)"
-  extern "int GetWindowTextLength(HWND)"
-
-  def get_foreground_window
-    GetForegroundWindow()
-  end
-
-  def self.get_text_of_active_window
-    hwnd = GetForegroundWindow()
-    buf_size = GetWindowTextLength(hwnd)
-    str = " " * (buf_size + 1)
-    GetWindowText(hwnd, str, str.length)
-    str.encode(Encoding.default_external)
-  end
-
-  module MB
-    OK = 1
-    CANCEL = 1
-    ABORT = 3
-    RETRY = 4
-    IGNORE = 5
-    YES = 6
-    NO = 7
-
-    module ICON
-      ERROR = 16
-      QUESTION = 32
-      INFORMATION = 64
-      WARNING = 128
-    end
-
-    module BTN
-      OK = 0
-      OKCANCEL = 1
-      ABORTRETRYIGNORE = 2
-      YESNO = 4
-    end
-  end
-end
-
-# msgbox_yesno('Do you want to continue?') do |y|
-#   if y
-#     puts 'proceeding with ...'
-#   else
-#     puts 'cancelled ...'
-#   end
-# end
-#
-# msgbox('We are finished here')
-#
-# loop do
-#   puts WinAPI.get_text_of_active_window
-#   sleep 1
-# end
-module Kernel
-  module_function
-
-  # @rbs str: String
-  # @rbs return String
-  def L(str)
-    str.encode("UTF-16LE")
-  end
-
-  # @example
-  # msg_box_yesno("Do you want to continue") do |y|
-  #  if y
-  #    puts "proceeding"
-  # else
-  #   puts "cancelled"
-  # end
-  # end
-  def msgbox_yesno(content, title: "Alert")
-    result = WinAPI::MessageBoxW(0, L(content), L(title), WinAPI::MB::BTN::YESNO) == WinAPI::MB::YES
-    yield(result)
-  end
-
-  def msgbox(content, title: "Alert")
-    WinAPI::MessageBoxW(0, L(content), L(title), WinAPI::MB::BTN::OK)
-  end
-end
+require "fiddle/import"
+require "fiddle/types"
+
+module WinAPI
+  extend Fiddle::Importer
+  dlload "user32.dll"
+  include Fiddle::BasicTypes
+  include Fiddle::Win32Types
+
+  typealias "LPCWSTR", "wchar_t*"
+
+  extern "int MessageBoxA(HWND, LPCSTR, LPCSTR, DWORD)"
+  extern "int MessageBoxW(HWND, LPCWSTR, LPCWSTR, DWORD)"
+  # window handling
+  extern "HWND GetForegroundWindow()"
+  extern "int GetWindowText(HWND, char*, int)"
+  extern "int GetWindowTextLength(HWND)"
+
+  def get_foreground_window
+    GetForegroundWindow()
+  end
+
+  def self.get_text_of_active_window
+    hwnd = GetForegroundWindow()
+    buf_size = GetWindowTextLength(hwnd)
+    str = " " * (buf_size + 1)
+    GetWindowText(hwnd, str, str.length)
+    str.encode(Encoding.default_external)
+  end
+
+  module MB
+    OK = 1
+    CANCEL = 1
+    ABORT = 3
+    RETRY = 4
+    IGNORE = 5
+    YES = 6
+    NO = 7
+
+    module ICON
+      ERROR = 16
+      QUESTION = 32
+      INFORMATION = 64
+      WARNING = 128
+    end
+
+    module BTN
+      OK = 0
+      OKCANCEL = 1
+      ABORTRETRYIGNORE = 2
+      YESNO = 4
+    end
+  end
+end
+
+# msgbox_yesno('Do you want to continue?') do |y|
+#   if y
+#     puts 'proceeding with ...'
+#   else
+#     puts 'cancelled ...'
+#   end
+# end
+#
+# msgbox('We are finished here')
+#
+# loop do
+#   puts WinAPI.get_text_of_active_window
+#   sleep 1
+# end
+module Kernel
+  module_function
+
+  # @rbs str: String
+  # @rbs return String
+  def L(str)
+    str.encode("UTF-16LE")
+  end
+
+  # @example
+  # msg_box_yesno("Do you want to continue") do |y|
+  #  if y
+  #    puts "proceeding"
+  # else
+  #   puts "cancelled"
+  # end
+  # end
+  def msgbox_yesno(content, title: "Alert")
+    result = WinAPI::MessageBoxW(0, L(content), L(title), WinAPI::MB::BTN::YESNO) == WinAPI::MB::YES
+    yield(result)
+  end
+
+  def msgbox(content, title: "Alert")
+    WinAPI::MessageBoxW(0, L(content), L(title), WinAPI::MB::BTN::OK)
+  end
+end