autocad 0.4.6 → 0.5

data/lib/autocad/plot_configuration.rb

@@ -0,0 +1,372 @@
+module Autocad
+  class PlotConfiguration < Element
+    # Get the name of the plot configuration
+    # @rbs return String
+    def name
+      @ole_obj.Name
+    end
+
+    # Set the plot device configuration file
+    # @rbs name: String
+    # @rbs return void
+    def device_name=(name)
+      @ole_obj.ConfigName = name
+    end
+
+    # Get the current plot device configuration name
+    # @rbs return String
+    def device_name
+      @ole_obj.ConfigName
+    end
+
+    # Read current configuration properties from OLE object
+    # @rbs return Hash[Symbol, Object]
+    def read_ole(ole = nil)
+      {device_name: ole_obj.ConfigName,
+       media_name: ole_obj.CanonicalMediaName,
+       style_sheet: ole_obj.StyleSheet,
+       plot_type: plot_type_ole_to_sym(ole_obj.PlotType),
+       rotation: rotation_ole_to_degree(ole_obj.PlotRotation),
+       paper_units: paper_units_from_ole(ole_obj.PaperUnits)}
+    end
+
+    # Write configuration settings to OLE object
+    # @rbs value: Hash[Symbol, Object]
+    # @rbs return void
+    def write_ole(value)
+      ole_obj.ConfigName = value[:device_name]
+      ole_obj.CanonicalMediaName = value[:media_name]
+      ole_obj.StyleSheet = value[:style_sheet]
+      ole_obj.PlotType = plot_type_to_ole(value[:plot_type])
+      ole_obj.PlotRotation = rotation_degree_to_ole(value[:rotation])
+      ole_obj.PaperUnits = paper_units_to_ole(value[:paper_units])
+    end
+
+    # Get plot origin point in millimeters
+    # @rbs return Point3d
+    def plot_origin
+      Point3d.new(ole_obj.PlotOrigin)
+    end
+
+    # Set plot origin point
+    # @rbs ...: Numeric | Array[Numeric] | Point3d
+    # @rbs return void
+    # @raise [ArgumentError] For invalid coordinate values
+    def plot_origin=(...)
+      origin = Point3d.new(...)
+      ole_obj.PlotOrigin = origin.to_ole
+    rescue StandardError => e
+      app.error_proc.call(e, self)
+    end
+
+    # Get current plot style mode
+    # @rbs return Symbol
+    def plot_style_mode
+      style = drawing.get_variable('pstylemode')
+      case style
+      when 0
+        :named_style_mode
+      else
+        :color_style_mode
+      end
+    end
+
+    def plot_style_mode_variable
+      drawing.get_variable('pstylemode')
+    end
+
+    # Check if using color-dependent plot styles
+    # @rbs return bool
+    def color_style_mode?
+      plot_style_mode == :color_style_mode
+    end
+
+    # Check if using named plot styles
+    # @rbs return bool
+    def named_style_mode?
+      plot_style_mode == :named_style_mode
+    end
+
+    # Configure multiple plot settings at once
+    # @rbs kwargs: Hash{Symbol => Object} -- See write_ole for valid keys
+    # @rbs return void
+    # @example Configure for PDF output
+    #   setup(
+    #     device_name: "AutoCAD PDF.pc3",
+    #     media_name: "ANSI_D",
+    #     style_sheet: "monochrome.ctb",
+    #     plot_type: :layout
+    #   )
+    def setup(...)
+      write_ole(...)
+    end
+
+    # Update configuration with merged values
+    # @rbs value: Hash{Symbol => Object} -- Partial configuration updates
+    # @rbs return void
+    def update(value)
+      merged_value = original.merge(value)
+      super(merged_value)
+    rescue StandardError => e
+      binding.irb
+    end
+
+    # Print current configuration to console
+    # @rbs return void
+    def display_setup
+      original.each { |k, v| puts "#{k}: #{v}" }
+      puts "plot_style_mode: #{plot_style_mode}"
+    end
+
+    # Copy settings from another configuration
+    # @rbs pc: PlotConfiguration -- Source configuration
+    # @rbs return void
+    def copy_plot_configuration(pc)
+      ole_obj.CopyFrom(pc.ole_obj)
+    end
+
+    def plot_style_mode=(sym)
+      style = case sym
+      when :named, :named_style, :named_style_mode
+        0
+      when :color, :color_style, :color_style_mode
+        1
+      else
+        raise 'need either :named or :color'
+      end
+      drawing.set_variable('pstylemode', style)
+    end
+
+    # ANSI B landscape paper size name
+    # @rbs return String -- Canonical name "ANSI_B_(17.00_x_11.00_Inches)"
+    def ansi_b_landscape
+      'ANSI_B_(17.00_x_11.00_Inches)'
+    end
+
+    def ansi_d_landscape
+      'ANSI_D_(34.00_x_22.00_Inches)'
+    end
+
+    # Refresh plot device information
+    # @rbs return void
+    # @note Required after changing device configurations
+    def refresh
+      @ole_obj.RefreshPlotDeviceInfo
+    end
+
+    def style_sheet=(style)
+      ole_obj.StyleSheet = style
+    end
+
+    def style_sheet
+      ole_obj.StyleSheet
+    end
+
+    # The media devices available to for plotting
+    # @rbs return Array[String]
+    def device_names
+      refresh
+      @ole_obj.GetPlotDeviceNames
+    end
+
+    # The current device_name for printing as its Canonomical Name
+    # use this name when changing
+    # @rbs return String
+    def canonical_media_name
+      @ole_obj.CanonicalMediaName
+    end
+
+    def canonomical_media_name=(name)
+      @ole_obj.CanonicalMediaName = name
+    end
+
+    # The available paper sizes for the configured device. Use this
+    # when setting the media_name:
+    # @rbs return Array[String]
+    # @note Call refresh() first if device was changed
+    def media_names
+      refresh
+      @ole_obj.GetCanonicalMediaNames
+    end
+
+    def locale_media_name
+      @ole_obj.GetLocaleMediaName(canonical_media_name)
+    end
+
+    # Returns the different plot tables. Use one of these
+    # when setting style_sheet
+    # @rbs return Array[String] -- CTB/STB file names
+    def plot_style_table_names
+      refresh
+      @ole_obj.GetPlotStyleTableNames
+    end
+
+    # The different plot bounds or types
+    # @rbs return Array[Symbol]
+    def plot_types
+      %i[display extents layout limits view window]
+    end
+
+    # @rbs return Array[Float, Float] -- the numerator and denominator for a custom scale
+    def custom_scale
+      numerator = WIN32OLE_VARIANT.new(nil, WIN32OLE::VARIANT::VT_BYREF | WIN32OLE::VARIANT::VT_R8)
+      denominator = WIN32OLE_VARIANT.new(nil, WIN32OLE::VARIANT::VT_BYREF | WIN32OLE::VARIANT::VT_R8)
+      @ole_obj.GetCustomScale(numerator, denominator)
+      [numerator.value, denominator.value]
+    end
+
+    # The different paper units
+    # @rbs return Array[Symbol]
+    def paper_units_types
+      %i[inches mm pixels]
+    end
+
+    # Get current paper units
+    # @rbs return Symbol -- :inches, :mm, or :pixels
+    def paper_units
+      paper_units_from_ole(@ole_obj.PaperUnits)
+    end
+
+    # Conversion factor to millimeters based on paper units
+    # @rbs return Float
+    # @example
+    #   inches: 25.4 (mm per inch)
+    #   pixels: 25.4/96 (mm per pixel at 96 DPI)
+    def paper_units_scale_factor
+      unit = paper_units
+      case unit
+
+      when :inches
+        25.4
+
+      when :mm
+        1
+
+      # pixel to mm
+      when :pixels
+        25.4 / 96.0
+      end
+    end
+
+    private
+
+    # Convert paper units symbol to OLE constant
+    # @rbs unit: Symbol -- Valid values: :inches, :mm, :pixels
+    # @rbs return Integer -- OLE constant (ACAD::Ac*)
+    # @raise [ArgumentError] For invalid paper units
+    def paper_units_to_ole(unit)
+      case unit
+
+      when :inches
+
+        ACAD::AcInches
+
+      when :pixels
+
+        ACAD::AcPixels
+
+      when :mm
+
+        ACAD::AcMillimeters
+
+      end
+    end
+
+    # Convert OLE paper units constant to symbol
+    # @rbs unit: Integer -- OLE constant (ACAD::Ac*)
+    # @rbs return Symbol -- :inches, :mm, or :pixels
+    def paper_units_from_ole(unit)
+      case unit
+
+      when ACAD::AcInches
+
+        :inches
+
+      when ACAD::AcPixels
+
+        :pixels
+
+      when ACAD::AcMillimeters
+
+        :mm
+
+      end
+    end
+
+    # Convert rotation degrees to OLE constant
+    # @rbs degree: Integer -- Valid values: 0, 90, 180, 270
+    # @rbs return Integer -- OLE constant (ACAD::Ac*degrees)
+    # @raise [ArgumentError] For invalid rotation values
+    def rotation_degree_to_ole(degree)
+      case degree
+      when 0
+        ACAD::Ac0degrees
+      when 90
+        ACAD::Ac90degrees
+      when 180
+        ACAD::Ac180degrees
+      when 270
+        ACAD::Ac270degrees
+      end
+    end
+
+    # Convert OLE rotation constant to degrees
+    # @rbs rot: Integer -- OLE constant (ACAD::Ac*degrees)
+    # @rbs return Integer -- 0, 90, 180, or 270
+    def rotation_ole_to_degree(rot)
+      case rot
+
+      when ACAD::Ac0degrees
+        0
+      when ACAD::Ac90degrees
+        90
+      when ACAD::Ac180degrees
+        180
+      when ACAD::Ac270degrees
+        270
+      end
+    end
+
+    # Convert OLE plot type constant to symbol
+    # @rbs typ: Integer -- OLE constant (ACAD::Ac*)
+    # @rbs return Symbol -- :display, :extents, :layout, :limits, :view, or :window
+    def plot_type_ole_to_sym(typ)
+      case typ
+      when ACAD::AcDisplay
+        :display
+      when ACAD::AcExtents
+        :extents
+      when ACAD::AcLayout
+        :layout
+      when ACAD::AcLimits
+        :limits
+      when ACAD::AcView
+        :view
+      when ACAD::AcWindow
+        :window
+      end
+    end
+
+    # Convert plot type symbol to OLE constant
+    # @rbs typ: Symbol -- Valid values: 
+    #   :display, :extents, :layout, :limits, :view, :window
+    # @rbs return Integer -- OLE constant (ACAD::Ac*)
+    # @raise [ArgumentError] For invalid plot types
+    def plot_type_to_ole(typ)
+      case typ
+      when :display
+        ACAD::AcDisplay
+      when :extents
+        ACAD::AcExtents
+      when :layout
+        ACAD::AcLayout
+      when :limits
+        ACAD::AcLimits
+      when :view
+        ACAD::AcView
+      when :window
+        ACAD::AcWindow
+      end
+    end
+  end
+end

data/lib/autocad/point.rb

@@ -0,0 +1,7 @@
+module Autocad
+  class Point < Element
+    def coordinates
+      Point3d(ole_obj.Coordinates)
+    end
+  end
+end

data/lib/autocad/point3d.rb

@@ -3,6 +3,11 @@
 module Autocad
   class Point3d
     class << self
+      # @rbs return Point3d -- return a Point3d at [0,0,0]
+      def zero
+        new(0.0, 0.0, 0, 0)
+      end
+
       def cartesian_to_polar(x, y)
         r = Math.sqrt(x * x + y * y)
         angle = Angle.radians(Math.atan2(y, x))
@@ -91,7 +96,7 @@ module Autocad
       {x: @x, y: @y, z: @z}
     end
 
-    # @rbs return [Float,Float, Float]
+    # @rbs return [
     def to_ary
       [x, y, z]
     end
@@ -110,6 +115,17 @@ module Autocad
       [x, y]
     end
 
+    # @rbs model_space: bool
+    # @return Autocad::Point
+    def to_acad_point(model_space = true)
+      ole = if model_space
+        drawing.ModelSpace.AddPoint(x, y, z)
+      else
+        drawing.PaperSpace.AddPoint(x, y, z)
+      end
+      app.wrap(ole)
+    end
+
     def xy_bounds(other)
       x2, y2 = Points3d.new(other).to_xy
       [x, y, x2, y, x2, y2, x, y2, x, y]
@@ -124,20 +140,11 @@ module Autocad
       [x, y, z]
     end
 
-    # @rbs return Point3d -- return a Point3d at [0,0,0]
-    def zero
-      new(0.0, 0.0, 0, 0)
-    end
-
     def to_cartesian
     end
 
     def to_ole
-      ole = WIN32OLE::Variant.array([3], WIN32OLE::VARIANT::VT_R8)
-      ole[0] = x
-      ole[1] = y
-      ole[z] = z
-      ole
+      WIN32OLE::Variant.new([x, y, z], WIN32OLE::VARIANT::VT_ARRAY | WIN32OLE::VARIANT::VT_R8)
     end
   end
 end

data/lib/autocad/pviewport.rb

@@ -1,21 +1,136 @@
-require_relative "element"
-
-module Autocad
-  class PViewport < Element
-    def width
-      @ole_obj.Width
-    end
-
-    def height
-      @ole_obj.Height
-    end
-
-    def each
-      return enum_for(:each) unless block_given?
-
-      @ole_obj.each do |ole|
-        yield app.wrap(ole)
-      end
-    end
-  end
-end
+require_relative 'element'
+
+module Autocad
+  class PViewport < Element
+    # the viewport width
+    # @rbs return Float
+    def width
+      @ole_obj.Width
+    end
+
+    def width_inches
+      width / 25.4
+    end
+
+    def height_inches
+      height / 25.4
+    end
+
+    def pviewport?
+      true
+    end
+
+    # change the viewport to front_view direction
+    def front_view
+      view_direction = Point3d(0, -1, 0)
+      ole_obj.Direction = view_direction.to_ole
+    end
+
+    def top_view
+      view_direction = Point3d(0, 0, 1)
+      ole_obj.Direction = view_direction.to_ole
+    end
+
+    def right_view
+      view_direction = Point3d(1, 0, 0)
+      ole_obj.Direction = view_direction.to_ole
+    end
+
+    def isometric_view
+      view_direction = Point3d(1, 1, 1)
+      ole_obj.Direction = view_direction.to_ole
+    end
+
+    # the viewport height
+    # @rbs return Float
+    def height
+      @ole_obj.Height
+    end
+
+    # @rbs return bool
+    def on?
+      @ole_obj.ViewPortOn
+    end
+
+    # turn on the view
+    # @rbs return void
+    def on
+      @ole_obj.Display(true)
+    end
+
+    # turn of the display of viewport
+    # @rbs return void
+    def off
+      @ole_obj.Display(false)
+    end
+
+    # the standard scale from Autocad AcViewportScale enum converted to symbol
+    # @rbs return Symbol
+    def standard_scale
+      ole = @ole_obj.StandardScale
+      standard_scale_ole_to_symbol(ole)
+    end
+
+    def standard_scale=(scale)
+      if scale.is_a?(Symbol)
+        ole = standard_scale_symbol_to_ole(scale)
+        @ole_obj.StandardScale = ole
+      else
+        @ole_obj.StandardScale = scale
+      end
+    end
+
+    def standard_scale_ole_to_symbol(scale)
+      case scale
+      when ACAD::AcVpScaleToFit then :scale_to_fit
+      when ACAD::AcVpCustomScale then :custom
+      when ACAD::AcVp1_128in_1ft then :"128_to_1"
+      when ACAD::AcVp1_64in_1ft then :"64_to_1"
+      when ACAD::AcVp1_32in_1ft then :"32_to_1"
+      when ACAD::AcVp1_16in_1ft then :"16_to_1"
+      when ACAD::AcVp1_8in_1ft then :"8_to_1"
+      end
+    end
+
+    def standard_scale_symbol_to_ole(scale)
+      case scale
+      when :scale_to_fit then ACAD::AcVpScaleToFit
+      when :custom then ACAD::AcVpCustomScale
+      when :"128_to_1" then ACAD::AcVp1_128in_1ft
+      when :"64_to_1" then ACAD::AcVp1_64in_1ft
+      when :"32_to_1" then ACAD::AcVp1_32in_1ft
+      when :"16_to_1" then ACAD::AcVp1_16in_1ft
+      when :"8_to_1" then ACAD::AcVp1_8in_1ft
+      end
+    end
+
+    # set a custom scale for model objects
+    # @rbs scale: Float
+    def custom_scale=(scale)
+      @ole_obj.CustomScale = scale
+    end
+
+    def lock_display
+      @ole_obj.DisplayLocked = true
+    end
+
+    # specifies the lock stat fo the viewports display. When locked, cant
+    # change view
+    # @rbs return bool
+    def display_locked?
+      @ole_obj.DisplayLocked
+    end
+
+    def unlock_display
+      @ole_obj.DisplayLocked = false
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      @ole_obj.each do |ole|
+        yield app.wrap(ole)
+      end
+    end
+  end
+end