sketchup-api-stubs 0.7.0 → 0.7.5

data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb

@@ -1,9 +1,7 @@
 # Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# This observer interface is implemented to react to model events. To
-# implement this observer, create a Ruby class of this type, override the
-# desired methods, and add an instance of the observer to the model.
+# This observer interface is implemented to react to model events.
 #
 # Note that the observers related to transactions (aka undoable operations)
 # are primarily for reporting and debugging. Performing any edit operations
@@ -15,6 +13,9 @@
 # SketchUp's native undo operations. You can set up an observer set to watch
 # precisely what is going on.
 #
+# @abstract To implement this observer, create a Ruby class of this type, override the
+#   desired methods, and add an instance of the observer to the model.
+#
 # @example
 #   # This is an example of an observer that watches the
 #   # component placement event.

data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb

@@ -70,8 +70,7 @@ class Sketchup::OptionsManager
   # @example
   #   model = Sketchup.active_model
   #   manager = model.options
-  #   # Retrieves each provider
-  #   manager.each { |provider| UI.messagebox provider.name }
+  #   manager.each { |provider| puts provider.name }
   #
   # @return nil
   #

data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb

@@ -101,7 +101,7 @@ class Sketchup::OptionsProvider
   # The {#each} method is used to iterate through all of the options.
   #
   # @example
-  #   model = Sketchup.active_model.options
+  #   model = Sketchup.active_model
   #   provider = model.options['UnitsOptions']
   #   provider.each { |key, value| puts "#{key} = #{value}" }
   #
@@ -122,7 +122,7 @@ class Sketchup::OptionsProvider
   # The {#each_key} method is used to iterate through all of the attribute keys.
   #
   # @example
-  #   provider.each_key { |key| UI.messagebox key }
+  #   provider.each_key { |key| puts key }
   #
   # @return [nil]
   #
@@ -137,7 +137,7 @@ class Sketchup::OptionsProvider
   # The {#each} method is used to iterate through all of the options.
   #
   # @example
-  #   model = Sketchup.active_model.options
+  #   model = Sketchup.active_model
   #   provider = model.options['UnitsOptions']
   #   provider.each { |key, value| puts "#{key} = #{value}" }
   #
@@ -161,7 +161,7 @@ class Sketchup::OptionsProvider
   # Throws an exception if there are no keys.
   #
   # @example
-  #   provider.each_value { |value| UI.messagebox value }
+  #   provider.each_value { |value| puts value }
   #
   # @return nil
   #
@@ -174,7 +174,7 @@ class Sketchup::OptionsProvider
   # The {#has_key?} method is an alias for {#key?}.
   #
   # @example
-  #   model = Sketchup.active_model.options
+  #   model = Sketchup.active_model
   #   provider = model.options['UnitsOptions']
   #   p provider.has_key?("LengthFormat")
   #
@@ -193,7 +193,7 @@ class Sketchup::OptionsProvider
   # specific key.
   #
   # @example
-  #   model = Sketchup.active_model.options
+  #   model = Sketchup.active_model
   #   provider = model.options['UnitsOptions']
   #   p provider.key?("LengthFormat")
   #

data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb

@@ -16,9 +16,9 @@
 # {Sketchup::OptionsManager} and {Sketchup::OptionsProvider} classes for more
 # details.
 #
-# To implement this observer, create a Ruby class of this type,
-# override the desired methods, and add an instance of the observer to the
-# objects of interests.
+# @abstract To implement this observer, create a Ruby class of this type,
+#   override the desired methods, and add an instance of the observer to the
+#   objects of interests.
 #
 # @example
 #   class MyOptionsProviderObserver < Sketchup::OptionsProviderObserver

data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb

@@ -193,17 +193,42 @@ class Sketchup::Page < Sketchup::Entity
   def label
   end
 
-  # The layers method retrieves the non-visible layers associated with a page.
+  # The {#layer_folders} method retrieves the hidden layer folders
+  # associated with a page.
   #
   # @example
   #   model = Sketchup.active_model
   #   pages = model.pages
-  #   page = pages.add "My Page"
+  #   page = pages.add("My Page")
+  #   folders = page.layer_folders
+  #
+  # @return [Array<Sketchup::LayerFolder>, nil] Returns +nil+ if {#use_hidden?}
+  #   returns +false+
+  #
+  # @version SketchUp 2021.0
+  def layer_folders
+  end
+
+  # The {#layers} method retrieves layers that don't use their default visibility
+  # on this page.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add("My Page")
   #   layers = page.layers
-  #   # layers now contains the layers in the model that are
-  #   # set to non-visible on the page
   #
-  # @return layers - an array with zero or more Layers objects.
+  # @example Test layer visibility
+  #   def visible_in_scene?(layer, scene)
+  #     scene.layers.include?(layer) == hidden_by_default?(layer)
+  #   end
+  #
+  #   def hidden_by_default?(layer)
+  #     layer.page_behavior & LAYER_HIDDEN_BY_DEFAULT == LAYER_HIDDEN_BY_DEFAULT
+  #   end
+  #
+  # @return [Array<Sketchup::Layer>, nil] Returns +nil+ if {#use_hidden?} returns
+  #   +false+
   #
   # @version SketchUp 6.0
   def layers
@@ -279,26 +304,31 @@ class Sketchup::Page < Sketchup::Entity
   def set_drawingelement_visibility(element, visibility)
   end
 
-  # The set_visibility method sets the visibility for a layer on a page.
+  # The {#set_visibility} method sets the visibility for a layer or
+  # layer folder on a page.
   #
   # @example
   #   model = Sketchup.active_model
   #   pages = model.pages
-  #   page = pages.add "My Page"
-  #   layer = page.layers[0]
-  #   visibility = true
-  #   page = page.set_visibility layer, visibility
+  #   page = pages.add("My Page")
+  #   layer = model.layers.add("My Layer")
+  #   page.set_visibility(layer, false)
+  #
+  # @overload set_visibility(layer, visible_for_page)
+  #
+  #   @param [Sketchup::Layer] layer
+  #   @param [Boolean] visible_for_page
   #
-  # @param layer
-  #   The layer whose visibility you are setting.
+  # @overload set_visibility(layer_folder, visible_for_page)
   #
-  # @param visibility
-  #   true if you want items on the layer to be visible, false if you do not want items visible.
+  #   @version SketchUp 20201.0
+  #   @param [Sketchup::LayerFolder] layer_folder
+  #   @param [Boolean] visible_for_page
   #
-  # @return page - the page whose visibility was set.
+  #   @return [Sketchup::Page] the page whose visibility was set.
   #
   # @version SketchUp 6.0
-  def set_visibility(layer, visibility)
+  def set_visibility(arg1, arg2)
   end
 
   # The shadow_info method retrieves the ShadowInfo object for the page.
@@ -365,22 +395,21 @@ class Sketchup::Page < Sketchup::Entity
   def transition_time=(trans_time)
   end
 
-  # The update method performs an update on the page properties based on the
-  # current view that the user has. Which parts of the Page get updated are
-  # controlled via an integer whose bits represent which parts to update. You
-  # can determine the integer you need to pass by adding these numbers together:
+  # The {#update} method performs an update on the page properties based on the
+  # current view that the user has. What properties of the Page get updated are
+  # controlled via an integer whose bits corresponds to different properties.
+  # These flags can be used individually or combined using bitwise OR.
   #
-  #   - 1 - Camera Location,
-  #   - 2 - Drawing Style,
-  #   - 4 - Shadow Settings,
-  #   - 8 - Axes Location,
-  #   - 16 - Hidden Geometry,
-  #   - 32 - Visible Layers,
-  #   - 64 - Active Section Planes.
-  #
-  # The bit code values are added together to provide the flags value.  For
-  # example, to update the Camera Location, Axes Location, and Active Section
-  # Planes properties, the flag would be 73 (1 + 8 + 64).
+  #   PAGE_USE_CAMERA            # Camera Location
+  #   PAGE_USE_RENDERING_OPTIONS # Drawing Style
+  #   PAGE_USE_SHADOWINFO        # Shadow Setting
+  #   PAGE_USE_SKETCHCS          # Axes Location
+  #   PAGE_USE_HIDDEN            # Hidden Geometry & Objects (Up 2019 and older)
+  #   PAGE_USE_HIDDEN_GEOMETRY   # Hidden Geometry (SU 2020 and later)
+  #   PAGE_USE_HIDDEN_OBJECTS    # Hidden Objects (SU 2020 and later)
+  #   PAGE_USE_LAYER_VISIBILITY  # Visible Layers
+  #   PAGE_USE_SECTION_PLANES    # Active Section Planes
+  #   PAGE_USE_ALL               # All possible scene properties
   #
   # @example
   #   model = Sketchup.active_model
@@ -388,14 +417,14 @@ class Sketchup::Page < Sketchup::Entity
   #   page = pages.add "My Page"
   #   status = page.update
   #
-  #   # Updates Camera Location (+1), Shadow Settings(+4),
-  #   # and Visible Layers (+32).
-  #   status = page.update(37)
+  #   # Updates Camera Location, Shadow Settings and Visible Layers.
+  #   flags = PAGE_USE_CAMERA | PAGE_USE_SHADOWINFO | PAGE_USE_LAYER_VISIBILITY
+  #   status = page.update(flags)
   #
-  # @param flags
-  #   Integer representing the sum of the bit flags.
+  # @param [Integer] flags
+  #   The bitwise OR of the bit flags.
   #
-  # @return status - true if successful, false if unsuccessful
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def update(flags)
@@ -476,11 +505,14 @@ class Sketchup::Page < Sketchup::Entity
 
   # The use_hidden= method sets the page's hidden property.
   #
+  # @deprecated The functionality is replaced by {use_hidden_geometry=}
+  #   and {use_hidden_objects=} in SketchUp 2020.1.
+  #
   # @example
   #   model = Sketchup.active_model
   #   pages = model.pages
   #   page = pages.add "My Page"
-  #   status = page.use_hidden=false
+  #   status = page.use_hidden = false
   #
   # @param setting
   #   true if you want your page to save this property, false
@@ -489,6 +521,10 @@ class Sketchup::Page < Sketchup::Entity
   # @return status - true if you are saving the property, false if
   #   you are not saving the property.
   #
+  # @see #use_hidden_geometry=
+  #
+  # @see #use_hidden_objects=
+  #
   # @version SketchUp 6.0
   def use_hidden=(setting)
   end
@@ -496,20 +532,57 @@ class Sketchup::Page < Sketchup::Entity
   # The use_hidden? method determines whether you are storing the hidden
   # property with the page.
   #
+  # @deprecated The functionality is replaced by {use_hidden_geometry?}
+  #   and {use_hidden_objects?} in SketchUp 2020.1.
+  #
   # @example
   #   model = Sketchup.active_model
   #   pages = model.pages
-  #   page = pages.add "My Page"
+  #   page = pages.add("My Page")
   #   status = page.use_hidden?
   #
   # @return [Boolean] status - true if you are storing the this property with
   #   the page, false if you are not storing this property
   #   with the page.
   #
+  # @see #use_hidden_geometry?
+  #
+  # @see #use_hidden_objects?
+  #
   # @version SketchUp 6.0
   def use_hidden?
   end
 
+  # Sets the page's use hidden geometry property.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add("My Page")
+  #   status = page.use_hidden_geometry = false
+  #
+  # @param [Boolean] setting
+  #   `true` if you want your page to save this property,
+  #   `false` if you do not want your page to save this property.
+  #
+  # @version SketchUp 2020.1
+  def use_hidden_geometry=(setting)
+  end
+
+  # Returns the use hidden geometry property from the page.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add("My Page")
+  #   status = page.use_hidden_geometry?
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2020.1
+  def use_hidden_geometry?
+  end
+
   # The use_hidden_layers= method sets the page's hidden layers
   # property.
   #
@@ -547,6 +620,36 @@ class Sketchup::Page < Sketchup::Entity
   def use_hidden_layers?
   end
 
+  # Sets the page's use hidden objects property.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add("My Page")
+  #   status = page.use_hidden_objects = false
+  #
+  # @param [Boolean] setting
+  #   `true` if you want your page to save this property,
+  #   `false` if you do not want your page to save this property.
+  #
+  # @version SketchUp 2020.1
+  def use_hidden_objects=(setting)
+  end
+
+  # Returns the use hidden objects property from the page.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add("My Page")
+  #   status = page.use_hidden_objects?
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2020.1
+  def use_hidden_objects?
+  end
+
   # The use_rendering_optoins= method sets the page's display
   # settings property.
   #

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

@@ -2,7 +2,7 @@
 # License:: The MIT License (MIT)
 
 # The Pages class contains methods for manipulating a collection of Pages
-# (scenes) in a model.
+# (Named "scenes" in the UI.) in a model.
 #
 # You get a handle to this collection by calling Model.pages.
 #
@@ -17,6 +17,16 @@ class Sketchup::Pages < Sketchup::Entity
 
   include Enumerable
 
+  # Constants
+
+  ImageEmbedded = nil # Stub value.
+  ImageEmbeddedAndLinked = nil # Stub value.
+  ImageLinked = nil # Stub value.
+
+  UnitsNormalizedX = nil # Stub value.
+  UnitsNormalizedY = nil # Stub value.
+  UnitsPixels = nil # Stub value.
+
   # Class Methods
 
   # The {.add_frame_change_observer} method is used to add a new frame change
@@ -47,7 +57,7 @@ class Sketchup::Pages < Sketchup::Entity
   def self.add_frame_change_observer(object)
   end
 
-  # The #{remove_frame_change_observer} method is used to remove a frame change
+  # The {.remove_frame_change_observer} method is used to remove a frame change
   # observer
   #
   # @example
@@ -87,15 +97,15 @@ class Sketchup::Pages < Sketchup::Entity
   def [](index_or_name)
   end
 
-  # The add method is used to add an empty Page object to the collection.
+  # The {#add} method is used to add a new Page object to the collection.
   #
   # If no name is given, then a new name is generated using the default name for
   # new Pages. If a name is given, then a new Page with that name is
   # added.
   #
   # If the flags parameter is given, it controls which properties are saved with
-  # the Page. See the Page.update method for a description of the flags that can
-  # be set.
+  # the Page. See the {Page#update} method for a description of the flags that
+  # can be set.
   #
   # If index is given, it specifies the position in the page list that the new
   # page is added.  Otherwise the new page is added to the end.
@@ -111,19 +121,19 @@ class Sketchup::Pages < Sketchup::Entity
   #     UI.messagebox "Failure"
   #   end
   #
-  # @param name
+  # @param [String] name
   #   The name of the specific page.
   #
-  # @param [optional] flags
+  # @param [Integer] flags
   #   Bit flags in integer form.
   #
-  # @param [optional] index
+  # @param [Integer] index
   #   Index of where to inset.
   #
-  # @return nil
+  # @return [Sketchup::Page]
   #
   # @version SketchUp 6.0
-  def add(name, flags, index)
+  def add(name = nil, flags = PAGE_USE_ALL, index = self.size)
   end
 
   # The add_matchphoto_page method is used to add a photomatch page to the
@@ -191,7 +201,7 @@ class Sketchup::Pages < Sketchup::Entity
   #   pages = model.pages
   #   status = pages.add "Page 1"
   #   status = pages.add "Page 2"
-  #   pages.each {|page| UI.messagebox page}
+  #   pages.each {|page| puts page}
   #
   # @return nil
   #