sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Sketchup/Layer.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Layer class contains methods modifying and extracting information for a
@@ -103,6 +103,32 @@ class Sketchup::Layer < Sketchup::Entity
   def color=(color)
   end
 
+  # The {#line_style} method retrieves the line style on this layer.
+  #
+  # @example
+  #   line_style = Sketchup.active_model.layers[0].line_style
+  #
+  # @return [Sketchup::LineStyle, nil] The line style retrieved.
+  #
+  # @version SketchUp 2019
+  def line_style
+  end
+
+  # The {#line_style=} method lets you set a specific line style to a layer
+  #
+  # @example
+  #   line_style = Sketchup.active_model.line_styles["Dot"]
+  #   Sketchup.active_model.layers[0].line_style = line_style
+  #
+  # @param [Sketchup::LineStyle, nil] line_style
+  #   The line style to set on this layer.
+  #
+  # @return [Sketchup::Layer] The layer that the line style was applied on.
+  #
+  # @version SketchUp 2019
+  def line_style=(line_style)
+  end
+
   # The name method is used to retrieve the name of the layer.
   #
   # @example

data/SketchUp/Sketchup/Layers.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Layers collection allows you to see and manage all of the layers in a

data/SketchUp/Sketchup/LayersObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to layers events. To

data/SketchUp/Sketchup/Licensing.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The +Sketchup::Licensing+ module contains methods for

data/SketchUp/Sketchup/Licensing/ExtensionLicense.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Sketchup::Licensing::ExtensionLicense class is used to store extension

data/SketchUp/Sketchup/LineStyle.rb

@@ -0,0 +1,24 @@
+# Copyright:: Copyright 2019 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This provides a way for SketchUp to customize a line style and be set on a
+# layer.
+#
+# @version SketchUp 2019
+class Sketchup::LineStyle < Sketchup::Entity
+
+  # Instance Methods
+
+  # The {#name} method retrieves the name of the line style object.
+  #
+  # @example
+  #   line_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style.name # returns "Solid Basic"
+  #
+  # @return [String] The name of the line style.
+  #
+  # @version SketchUp 2019
+  def name
+  end
+
+end

data/SketchUp/Sketchup/LineStyles.rb

@@ -0,0 +1,123 @@
+# Copyright:: Copyright 2019 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# Provides access to the different line style objects in the model.
+#
+# @version SketchUp 2019
+class Sketchup::LineStyles < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The {#[]} method lets you retrieve a line style by name or index.
+  #
+  # The {#at} method is an alias of {#[]}.
+  #
+  # @example
+  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style = Sketchup.active_model.line_styles[1]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The name of the line style to retrieve.
+  #
+  # @overload [](index)
+  #
+  #   @param [Index] index The index of the line style to retrieve.
+  #
+  #   @raise [IndexError] If index is out of bounds.
+  #
+  # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
+  #   couldn't be retrived.
+  #
+  # @version SketchUp 2019
+  def [](arg)
+  end
+
+  # The {#[]} method lets you retrieve a line style by name or index.
+  #
+  # The {#at} method is an alias of {#[]}.
+  #
+  # @example
+  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style = Sketchup.active_model.line_styles[1]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The name of the line style to retrieve.
+  #
+  # @overload [](index)
+  #
+  #   @param [Index] index The index of the line style to retrieve.
+  #
+  #   @raise [IndexError] If index is out of bounds.
+  #
+  # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
+  #   couldn't be retrived.
+  #
+  # @version SketchUp 2019
+  def at(arg)
+  end
+
+  # The {#each} method is used to iterate through all the line styles.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #   line_styles.each{ |line_style| p line_style.name }
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2019
+  def each
+  end
+
+  # The {#size} method returns the number of line styles that SketchUp supports.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #   line_styles.size
+  #
+  # @return [Integer] The count of line styles.
+  #
+  # @version SketchUp 2019
+  def length
+  end
+
+  # The {#names} method return the support line styles as strings.
+  #
+  # @example
+  #   Sketchup.active_model.line_styles.names
+  #
+  # @return [Array<String>]
+  #
+  # @version SketchUp 2019
+  def names
+  end
+
+  # The {#size} method returns the number of line styles that SketchUp supports.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #   line_styles.size
+  #
+  # @return [Integer] The count of line styles.
+  #
+  # @version SketchUp 2019
+  def size
+  end
+
+  # The {#to_a} method returns an array of all the line styles.
+  #
+  # @example
+  #   line_styles = Sketchup.active_active_model.line_styles.to_a
+  #
+  # @return [Array] Containing all the line style objects.
+  #
+  # @version SketchUp 2019
+  def to_a
+  end
+
+end

data/SketchUp/Sketchup/Loop.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Loop is a low level topology class that will not need to be used often. A

data/SketchUp/Sketchup/Material.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Material class represents a texture or color that can be applied to
@@ -266,12 +266,18 @@ class Sketchup::Material < Sketchup::Entity
   def name
   end
 
-  # Sets the name of the material.
+  # The {#name=} method sets the name of the material.
   #
-  # @example
+  # @example Safely change name without raising errors
   #   materials = Sketchup.active_model.materials
   #   material = materials.add("Joe")
-  #   material.name = 'Jeff'
+  #   material.name = materials.unique_name('Jeff')
+  #
+  # @note Since SketchUp 2018 this method will raise an `ArgumentError` if the
+  #   name is not unique.
+  #
+  # @note SketchUp 2018 would raise an error if you named material the name it
+  #   already had.
   #
   # @param [String] str
   #   the new material name
@@ -337,18 +343,18 @@ class Sketchup::Material < Sketchup::Entity
   #   @param filename [String] The file path to the texture the material should use.
   #   @return [String]
   #
-  # @overload texture=(image_rep)
-  #
-  #   @param [Sketchup::ImageRep] image_rep The pixel data representing the
-  #     texture. (Added in SketchUp 2018)
-  #   @return [Sketchup::ImageRep]
-  #
   # @overload texture=(properties)
   #
   #   @param properties [Array(String, Integer, Integer)] An array with the
   #     texture filename and optionally the width and height in model units.
   #   @return [Array(String, Integer, Integer)]
   #
+  # @overload texture=(image_rep)
+  #
+  #   @param [Sketchup::ImageRep] image_rep The pixel data representing the
+  #     texture. (Added in SketchUp 2018)
+  #   @return [Sketchup::ImageRep]
+  #
   # @version SketchUp 6.0
   def texture=(arg)
   end

data/SketchUp/Sketchup/Materials.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A collection of Materials objects. Each model contains a Materials collection
@@ -170,6 +170,10 @@ class Sketchup::Materials < Sketchup::Entity
   #   materials = Sketchup.active_model.materials
   #   number = materials.length
   #
+  # @note The returned number includes {Sketchup::Image} materials as well.
+  #   It will not reflect the number of materials yielded by {#each}. To get
+  #   the number of non-image materials use {#count} or +materials.to_a.size+.
+  #
   # @return [Integer]
   #
   # @see #size
@@ -274,6 +278,10 @@ class Sketchup::Materials < Sketchup::Entity
   #   materials = Sketchup.active_model.materials
   #   number = materials.size
   #
+  # @note The returned number includes {Sketchup::Image} materials as well.
+  #   It will not reflect the number of materials yielded by {#each}. To get
+  #   the number of non-image materials use {#count} or +materials.to_a.size+.
+  #
   # @return [Integer]
   #
   # @see #length

data/SketchUp/Sketchup/MaterialsObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to materials events. To
@@ -128,10 +128,10 @@ class Sketchup::MaterialsObserver
   #   the {Sketchup::ModelObserver#onTransactionStart} to capture all undo
   #   events.
   #
-  # @param [Sketchup::Material] material
-  #
   # @param [Sketchup::Materials] materials
   #
+  # @param [Sketchup::Material] material
+  #
   # @return [nil]
   #
   # @version SketchUp 6.0

data/SketchUp/Sketchup/Menu.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An interface to a menu.

data/SketchUp/Sketchup/Model.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a SketchUp model. The model is the 3D drawing that
@@ -36,6 +36,9 @@
 #
 #   new_edge = entities.add_line([0,0,0], [500,500,0])
 #
+# @note Prior to SketchUp 2019 this class would yield +TypeError+ for all
+#   method calls if +#singleton_class+ was called on the model object.
+#
 # @version SketchUp 6.0
 class Sketchup::Model
 
@@ -52,6 +55,7 @@ class Sketchup::Model
   VERSION_2016 = nil # Stub value.
   VERSION_2017 = nil # Stub value.
   VERSION_2018 = nil # Stub value.
+  VERSION_2019 = nil # Stub value.
   VERSION_3 = nil # Stub value.
   VERSION_4 = nil # Stub value.
   VERSION_5 = nil # Stub value.
@@ -174,12 +178,12 @@ class Sketchup::Model
   # @param [String] note
   #   A string note.
   #
-  # @param [Numeric] y
-  #   A distance along the y axis between 0 and 1.
-  #
   # @param [Numeric] x
   #   A distance along the x axis between 0 and 1.
   #
+  # @param [Numeric] y
+  #   A distance along the y axis between 0 and 1.
+  #
   # @return [Sketchup::Text] a note object or an exception if it is
   #   unsuccessful.
   #
@@ -459,7 +463,7 @@ class Sketchup::Model
   # See the {file:pages/exporter_options.md Exporter Options} file for information
   # on creating a valid hash for the various exporters.
   #
-  # @example
+  # @example General use
   #   model = Sketchup.active_model
   #   show_summary = true
   #
@@ -486,6 +490,14 @@ class Sketchup::Model
   #                    :preserve_instancing => true }
   #   status = model.export('c:/my_export.dae', options_hash)
   #
+  # @example IFC Example
+  #   model = Sketchup.active_model
+  #   # If no IFC types are passed in, then no geometry will be exported.
+  #   options_hash = { :hidden_geometry => true,
+  #                    :ifc_mapped_items => true,
+  #                    :ifc_types => ['IfcBuilding', 'IfcDoor']}
+  #   status = model.export('c:/my_export.ifc', options_hash)
+  #
   # @overload export(filename, show_summary = false)
   #
   #   @param [String] filename The name of the file to export.
@@ -600,13 +612,13 @@ class Sketchup::Model
   # @param [String] dictname
   #   The name of the dictionary containing the value.
   #
+  # @param [String] key
+  #   The key containing the value.
+  #
   # @param [Object] defaultvalue
   #   default value that will be returned if a
   #   value does not exist.
   #
-  # @param [String] key
-  #   The key containing the value.
-  #
   # @return [Object, nil] the value for a given key in the given
   #   dictionary if a value exists; the default value if a
   #   defaultvalue is provided and the value does not exist;
@@ -688,7 +700,7 @@ class Sketchup::Model
   # @example Import for SketchUp 2018+ and newer
   #   model = Sketchup.active_model
   #   options = { :units => "model",
-  #               :merge_coplaner_faces => true,
+  #               :merge_coplanar_faces => true,
   #               :show_summary => true }
   #   status = model.import("filename", options)
   #
@@ -777,6 +789,17 @@ class Sketchup::Model
   def layers
   end
 
+  # The {#line_styles} method returns the line styles manager.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #
+  # @return [Sketchup::LineStyles] The line styles manager.
+  #
+  # @version SketchUp 2019
+  def line_styles
+  end
+
   # This method retrieves an Array of all of the datums recognized by SketchUp.
   #
   # @example
@@ -1089,6 +1112,9 @@ class Sketchup::Model
   #   filename = File.join(ENV['Home'], 'Desktop', 'mysketchup_v8.skp')
   #   status = model.save("filename", Sketchup::Model::VERSION_8)
   #
+  # @note A bug in SketchUp 2016 and older caused the +.skb+ backup file
+  #   written during save to be empty. The +.skp+ file was however valid.
+  #
   # @overload save
   #
   #   Starting with SketchUp 2014, this parameter is optional.
@@ -1239,12 +1265,12 @@ class Sketchup::Model
   #   The name of the attribute dictionary whose attribute
   #   you wish to set.
   #
-  # @param [Object] value
-  #   The value to set.
-  #
   # @param [String] key
   #   The attribute name.
   #
+  # @param [Object] value
+  #   The value to set.
+  #
   # @return [Object] the value that was set
   #
   # @version SketchUp 6.0
@@ -1321,6 +1347,15 @@ class Sketchup::Model
   #   new Ruby operation while another is still open, you will implicitly close
   #   the first one.
   #
+  # @param [String] op_name
+  #   name of the operation visible in the UI
+  #
+  # @param [Boolean] disable_ui
+  #   if set to true, then SketchUp's tendency to
+  #   update the user interface after each geometry change will be
+  #   suppressed. This can result in much faster Ruby code execution if the
+  #   operation involves updating the model in any way.
+  #
   # @param [Boolean] next_transparent
   #   <b>Deprecated!</b> if set to true, then
   #   whatever operation comes after this one will be appended into one
@@ -1330,15 +1365,6 @@ class Sketchup::Model
   #   with one of their own. <b>Use extreme caution</b> and test thoroughly
   #   when setting this to true.
   #
-  # @param [Boolean] disable_ui
-  #   if set to true, then SketchUp's tendency to
-  #   update the user interface after each geometry change will be
-  #   suppressed. This can result in much faster Ruby code execution if the
-  #   operation involves updating the model in any way.
-  #
-  # @param [String] op_name
-  #   name of the operation visible in the UI
-  #
   # @param [Boolean] transparent
   #   if set to true, then this operation will
   #   append to the previous operation. This is particularly useful for