sketchup-api-stubs 0.7.0 → 0.7.5

data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb

@@ -8,6 +8,62 @@ class Layout::Grid
 
   # Instance Methods
 
+  # The {#clip_to_margins=} method sets whether or not the grid is clipped to the
+  # page margins.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.clip_to_margins = true
+  #
+  # @param [Boolean] clip
+  #
+  # @version LayOut 2020.1
+  def clip_to_margins=(clip)
+  end
+
+  # The {#clip_to_margins?} method returns whether or not the grid is clipped to
+  # the page margins.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   in_front = grid.clip_to_margins?
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2020.1
+  def clip_to_margins?
+  end
+
+  # The {#in_front=} method sets whether or not the grid is drawn on top of
+  # entities.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.in_front = true
+  #
+  # @param [Boolean] in_front
+  #
+  # @version LayOut 2020.1
+  def in_front=(in_front)
+  end
+
+  # The {#in_front?} method returns whether or not the grid is drawn on top of
+  # entities.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   in_front = grid.in_front?
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2020.1
+  def in_front?
+  end
+
   # The {#major_color} method returns the {Sketchup::Color} for the major grid
   # lines.
   #
@@ -22,6 +78,26 @@ class Layout::Grid
   def major_color
   end
 
+  # The {#major_color=} method sets the {Sketchup::Color} for the major grid
+  # lines.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.major_color = Sketchup::Color.new(255, 0, 0)
+  #   grid.major_color = 255
+  #   grid.major_color = 0x0000ff
+  #   grid.major_color = "red"
+  #   grid.major_color = "#ff0000"
+  #   grid.major_color = [1.0, 0.0, 0.0]
+  #   grid.major_color = [255, 0, 0]
+  #
+  # @param [Sketchup::Color] color
+  #
+  # @version LayOut 2020.1
+  def major_color=(color)
+  end
+
   # The {#major_spacing} method returns the major space size of the
   # {Layout::Grid}.
   #
@@ -36,6 +112,24 @@ class Layout::Grid
   def major_spacing
   end
 
+  # The {#major_spacing=} method sets the major space size of the
+  # {Layout::Grid}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.major_spacing = 1.25
+  #
+  # @param [Float] spacing
+  #   The double specifying the space size for the
+  #   {Layout::Grid}
+  #
+  # @raise [ArgumentError] if spacing is not greater than zero
+  #
+  # @version LayOut 2020.1
+  def major_spacing=(spacing)
+  end
+
   # The {#minor_color} method returns the {Sketchup::Color} for the minor grid
   # lines.
   #
@@ -50,6 +144,26 @@ class Layout::Grid
   def minor_color
   end
 
+  # The {#minor_color=} method sets the {Sketchup::Color} for the minor grid
+  # lines.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.minor_color = Sketchup::Color.new(255, 0, 0)
+  #   grid.minor_color = 255
+  #   grid.minor_color = 0x0000ff
+  #   grid.minor_color = "red"
+  #   grid.minor_color = "#ff0000"
+  #   grid.minor_color = [1.0, 0.0, 0.0]
+  #   grid.minor_color = [255, 0, 0]
+  #
+  # @param [Sketchup::Color] color
+  #
+  # @version LayOut 2020.1
+  def minor_color=(color)
+  end
+
   # The {#minor_divisions} method returns the number of minor divisions of the
   # {Layout::Grid}.
   #
@@ -64,6 +178,38 @@ class Layout::Grid
   def minor_divisions
   end
 
+  # The {#minor_divisions=} method sets the number of minor divisions of the
+  # {Layout::Grid}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.major_spacing = 1.25
+  #
+  # @param [Integer] divisions
+  #   The number of minor divisions for the
+  #   {Layout::Grid}
+  #
+  # @raise [ArgumentError] if divisions is negative
+  #
+  # @version LayOut 2020.1
+  def minor_divisions=(divisions)
+  end
+
+  # The {#print=} method sets whether or not the {Layout::Grid} is
+  # printed.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.print = false
+  #
+  # @param [Boolean] print
+  #
+  # @version LayOut 2020.1
+  def print=(print)
+  end
+
   # The {#print?} method returns whether or not the {Layout::Grid} is
   # printed.
   #
@@ -78,6 +224,20 @@ class Layout::Grid
   def print?
   end
 
+  # The {#show=} method sets whether or not the {Layout::Grid} is
+  # visible.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.show = true
+  #
+  # @param [Boolean] show
+  #
+  # @version LayOut 2020.1
+  def show=(show)
+  end
+
   # The {#show?} method returns whether or not the {Layout::Grid} is
   # visible.
   #
@@ -92,6 +252,20 @@ class Layout::Grid
   def show?
   end
 
+  # The {#show_major=} method sets whether or not the major grid lines are
+  # visible.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.show_major = true
+  #
+  # @param [Boolean] show
+  #
+  # @version LayOut 2020.1
+  def show_major=(show)
+  end
+
   # The {#show_major?} method returns whether or not the major grid lines are
   # visible.
   #
@@ -106,6 +280,20 @@ class Layout::Grid
   def show_major?
   end
 
+  # The {#show_minor=} method sets whether or not the minor grid lines are
+  # visible.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   grid = doc.grid
+  #   grid.show_minor = false
+  #
+  # @param [Boolean] show
+  #
+  # @version LayOut 2020.1
+  def show_minor=(show)
+  end
+
   # The {#show_minor?} method returns whether or not the minor grid lines are
   # visible.
   #

data/lib/sketchup-api-stubs/stubs/Layout/Image.rb

@@ -32,7 +32,9 @@ class Layout::Image < Layout::Entity
   def clip_mask
   end
 
-  # The {#clip_mask=} method sets the clip mask of the {Layout::Image}.
+  # The {#clip_mask=} method sets the clip mask of the {Layout::Image}. clip_mask
+  # can be a {Layout::Rectangle}, {Layout::Ellipse}, or {Layout::Path}, or +nil+,
+  # and it must not currently exist in a {Layout::Document}, or {Layout::Group}.
   #
   # @example
   #   image = Layout::Image.new("my_image.png", [[1, 1], [3, 3]])
@@ -42,11 +44,14 @@ class Layout::Image < Layout::Entity
   #   clip_mask = Layout::Rectangle.new(bounds)
   #   image.clip_mask = clip_mask
   #
-  # @param [Layout::Entity] clip_mask
+  # @note +clip_mask+ may be +nil+ as of LayOut 2020.1.
+  #
+  # @param [Layout::Entity, nil] clip_mask
   #   The clip mask can be a {Layout::Path},
   #   {Layout::Rectangle}, {Layout::Ellipse}, or +nil+.
   #
-  # @raise [ArgumentError] if clip mask is already in a document
+  # @raise [ArgumentError] if clip mask is already in a {Layout::Document} or
+  #   {Layout::Group}
   #
   # @raise [ArgumentError] if clip mask is not a {Layout::Path},
   #   {Layout::Rectangle}, or {Layout::Ellipse}

data/lib/sketchup-api-stubs/stubs/Layout/Label.rb

@@ -205,9 +205,8 @@ class Layout::Label < Layout::Entity
   #   @param [Geom::Bounds2d] bounds
   #   @return [Layout::Label]
   #
-  # @overload initialize(text, leader_type, target_point, anchor_point,
+  # @overload initialize(text, leader_type, target_point, anchor_point, anchor_type)
   #
-  #   anchor_type)
   #   @param [String] text The label text
   #   @param [Integer] leader_type The leader line type
   #   @param [Geom::Point2d] target_point Where the label leader should point to

data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb

@@ -119,6 +119,11 @@ class Layout::Layers
   #     puts layer.name
   #   }
   #
+  # @note Don't remove content from this collection while iterating over it with
+  #   {#each}. This would change the size of the collection and cause elements to
+  #   be skipped as the indices change. Instead copy the current collection to an
+  #   array using +to_a+ and then use +each+ on the array, when removing content.
+  #
   # @version LayOut 2018
   #
   # @yieldparam [Layout::Layer] layer
@@ -153,6 +158,7 @@ class Layout::Layers
   # @version LayOut 2018
   def length
   end
+  alias_method :size, :length
 
   # The {#remove} method deletes the given {Layout::Layer} from the
   # {Layout::Document}.
@@ -216,17 +222,4 @@ class Layout::Layers
   def reorder(layer, new_index)
   end
 
-  # The {#length} method returns the number of {Layout::Layer}s.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   layers = doc.layers
-  #   num_layers = layers.length
-  #
-  # @return [Integer]
-  #
-  # @version LayOut 2018
-  def size
-  end
-
 end

data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb

@@ -77,7 +77,7 @@ class Layout::LinearDimension < Layout::Entity
   #   point_1 = Geom::Point2d.new(5, 7.5)
   #   point_2 = Geom::Point2d.new(8.5, 9)
   #   table = Layout::Rectangle.new([point_1, point_2])
-  #   doc.add_entity(table, @doc.layers.first, @doc.pages.first)
+  #   doc.add_entity(table, doc.layers.first, doc.pages.first)
   #   start_point = Layout::ConnectionPoint.new(table, point_1)
   #   end_point = Layout::ConnectionPoint.new(table, point_2)
   #   height = 1.0
@@ -532,6 +532,10 @@ class Layout::LinearDimension < Layout::Entity
   #   dim = Layout::LinearDimension.new(start_point, end_point, height)
   #   text = dim.text
   #
+  # @note With the addition of auto-text in dimensions for LayOut 2019.2, the
+  #   copy of the dimension text incorrectly provided the plain text when
+  #   requesting the display text. This has been fixed for LayOut 2020.1.
+  #
   # @return [Layout::FormattedText]
   #
   # @version LayOut 2018

data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb

@@ -65,6 +65,11 @@ class Layout::Pages
   #     puts page.name
   #   }
   #
+  # @note Don't remove content from this collection while iterating over it with
+  #   {#each}. This would change the size of the collection and cause elements to
+  #   be skipped as the indices change. Instead copy the current collection to an
+  #   array using +to_a+ and then use +each+ on the array, when removing content.
+  #
   # @version LayOut 2018
   #
   # @yieldparam [Layout::Page] page
@@ -142,6 +147,7 @@ class Layout::Pages
   # @version LayOut 2018
   def length
   end
+  alias_method :size, :length
 
   # The {#remove} method deletes the given {Layout::Page} from the
   # {Layout::Document}.
@@ -200,17 +206,4 @@ class Layout::Pages
   def reorder(page, new_index)
   end
 
-  # The {#length} method returns the number of {Layout::Page}s.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   pages = doc.pages
-  #   num_pages = pages.length
-  #
-  # @return [Integer]
-  #
-  # @version LayOut 2018
-  def size
-  end
-
 end

data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb

@@ -44,6 +44,20 @@ class Layout::SketchUpModel < Layout::Entity
 
   # Instance Methods
 
+  # The {#camera_modified?} method returns whether the camera of the
+  # {Layout::SketchUpModel} has been modified.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   modified = model.camera_modified?
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2020.1
+  def camera_modified?
+  end
+
   # The {#clip_mask} method returns the clip mask entity for the
   # {Layout::SketchUpModel}, or +nil+ if it does not have one. clip_mask can be a
   # {Layout::Rectangle}, {Layout::Ellipse}, or {Layout::Path}.
@@ -61,7 +75,8 @@ class Layout::SketchUpModel < Layout::Entity
 
   # The {#clip_mask=} method sets a clip mask for the {Layout::SketchUpModel}.
   # clip_mask can be a {Layout::Rectangle}, {Layout::Ellipse}, or {Layout::Path},
-  # and it must not currently exist in a {Layout::Document}.
+  # or +nil+, and it must not currently exist in a {Layout::Document},
+  # or {Layout::Group}.
   #
   # @example
   #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
@@ -69,9 +84,14 @@ class Layout::SketchUpModel < Layout::Entity
   #   rect = Layout::Rectangle.new([[2, 2], [3, 3]]);
   #   model.clip_mask = rect
   #
-  # @param [Layout::Entity] clip_mask
+  # @note +clip_mask+ may be +nil+ as of LayOut 2020.1.
   #
-  # @raise [ArgumentError] if clip_mask is already in a {Layout::Document}
+  # @param [Layout::Entity, nil] clip_mask
+  #   The clip mask can be a {Layout::Path},
+  #   {Layout::Rectangle}, {Layout::Ellipse}, or +nil+.
+  #
+  # @raise [ArgumentError] if clip_mask is already in a {Layout::Document} or
+  #   {Layout::Group}
   #
   # @raise [ArgumentError] if clip_mask is not a {Layout::Rectangle},
   #   {Layout::Ellipse}, or {Layout::Path}
@@ -210,6 +230,20 @@ class Layout::SketchUpModel < Layout::Entity
   def display_background?
   end
 
+  # The {#effects_modified?} method returns whether the shadow or fog settings
+  # of the {Layout::SketchUpModel} have been modified.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   modified = model.effects_modified?
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2020.1
+  def effects_modified?
+  end
+
   # The {#entities} method returns the {Layout::Group} that represents the
   # {Layout::SketchUpModel} in its exploded form. The {Layout::Group} will
   # contain a {Layout::Image} for raster and hybrid-rendered models, and
@@ -248,6 +282,25 @@ class Layout::SketchUpModel < Layout::Entity
   def initialize(path, bounds)
   end
 
+  # The {#layers_modified?} method returns whether the layers of the
+  # {Layout::SketchUpModel} has been modified.
+  #
+  #
+  # @note: In SketchUp 2020, SketchUp "layers" were renamed to "tags". For
+  #   consistency with the SketchUp API, this will continue to refer to
+  #   "tags" as "layers".
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   modified = model.layers_modified?
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2020.1
+  def layers_modified?
+  end
+
   # The {#line_weight} method returns the line weight for the
   # {Layout::SketchUpModel}.
   #
@@ -366,7 +419,10 @@ class Layout::SketchUpModel < Layout::Entity
   def preserve_scale_on_resize?
   end
 
-  # The {#render} method renders the {Layout::SketchUpModel}.
+  # The {#render} method renders the {Layout::SketchUpModel}. If the model
+  # belongs to a {Layout::Document}, then the render will be performed at the
+  # quality set in document.page_info (see {Layout::Document} and
+  # {Layout::PageInfo}). Otherwise, the render will be performed at Low quality.
   #
   # @example
   #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
@@ -441,6 +497,79 @@ class Layout::SketchUpModel < Layout::Entity
   def render_needed?
   end
 
+  # The {#reset_camera} method resets the {Layout::SketchUpModel}'s camera to
+  # the scene's setting.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   model.reset_camera if model.camera_modified?
+  #
+  # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
+  # @version LayOut 2020.1
+  def reset_camera
+  end
+
+  # The {#reset_effects} method resets the {Layout::SketchUpModel}'s shadow and
+  # fog settings to the scene's settings.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   model.reset_effects if model.effects_modified?
+  #
+  # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
+  # @version LayOut 2020.1
+  def reset_effects
+  end
+
+  # The {#reset_layers} method resets the {Layout::SketchUpModel}'s layers to
+  # the scene's setting.
+  #
+  #
+  # @note: In SketchUp 2020, SketchUp "layers" were renamed to "tags". For
+  #   consistency with the SketchUp API, this will continue to refer to
+  #   "tags" as "layers".
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   model.reset_layers if model.layers_modified?
+  #
+  # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
+  # @version LayOut 2020.1
+  def reset_layers
+  end
+
+  # The {#reset_style} method resets the {Layout::SketchUpModel}'s style to
+  # the scene's setting.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   model.reset_style if model.style_modified?
+  #
+  # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
+  # @version LayOut 2020.1
+  def reset_style
+  end
+
   # The {#scale} method returns the scale of the {Layout::SketchUpModel}.
   #
   # @example
@@ -492,6 +621,20 @@ class Layout::SketchUpModel < Layout::Entity
   def scenes
   end
 
+  # The {#style_modified?} method returns whether the style of the
+  # {Layout::SketchUpModel} has been modified.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   modified = model.style_modified?
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2020.1
+  def style_modified?
+  end
+
   # The {#view} method returns the standard view of the {Layout::SketchUpModel}.
   #
   # The standard view can be one of the following values: