sketchup-api-stubs 0.1.2 → 0.2.0

data/SketchUp/Sketchup/Page.rb

@@ -129,6 +129,38 @@ class Sketchup::Page < Sketchup::Entity
   def hidden_entities
   end
 
+  # The {#include_in_animation=} method controls whether the page should be
+  # included when exporting an animation from the model.
+  #
+  # @example Turn off animation for all pages.
+  #   model = Sketchup.active_model
+  #   model.pages.each { |page|
+  #     page.include_in_animation = false
+  #   }
+  #
+  # @param [Boolean] include
+  #
+  # @return [Sketchup::Page]
+  #
+  # @version SketchUp 2018
+  def include_in_animation=(include)
+  end
+
+  # The {#include_in_animation?} method determines whether the page should be
+  # included when exporting an animation from the model.
+  #
+  # @example Toggle inclusion in animation for all pages.
+  #   model = Sketchup.active_model
+  #   in_animation = model.pages.select { |page| page.include_in_animation? }
+  #
+  # @return [Boolean]
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2018
+  def include_in_animation?
+  end
+
   # The label method retrieves the label for a page from the page tab.
   #
   # @example

data/SketchUp/Sketchup/Pages.rb

@@ -201,16 +201,15 @@ class Sketchup::Pages < Sketchup::Entity
   def each
   end
 
-  # The erase method is used to remove a page from the collection.
+  # The {#erase} method is used to remove a page from the collection.
   #
   # @example
   #   page = Sketchup.active_model.pages.add('Hello World')
   #   Sketchup.active_model.pages.erase(page)
   #
-  # @param page
-  #   The page you wish to delete.
+  # @param [Sketchup::Page] page
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def erase(page)

data/SketchUp/Sketchup/RenderingOptions.rb

@@ -75,6 +75,10 @@
 # - +DrawBackEdges+
 # - +SectionCutDrawEdges+
 #
+# Added in SketchUp 2018:
+# - +SectionCutFilled+
+# - +SectionDefaultFillColor+
+#
 # @version SketchUp 6.0
 class Sketchup::RenderingOptions < Sketchup::Entity
 
@@ -134,8 +138,10 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   ROPSetProfilesOnlyEdges = nil # Stub value.
   ROPSetRenderMode = nil # Stub value.
   ROPSetSectionActiveColor = nil # Stub value.
+  ROPSetSectionCutFilled = nil # Stub value.
   ROPSetSectionCutWidth = nil # Stub value.
   ROPSetSectionDefaultCutColor = nil # Stub value.
+  ROPSetSectionDefaultFillColor = nil # Stub value.
   ROPSetSectionDisplayMode = nil # Stub value.
   ROPSetSectionInactiveColor = nil # Stub value.
   ROPSetSkyColor = nil # Stub value.
@@ -153,7 +159,7 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   #     puts key
   #   }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
@@ -166,7 +172,7 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   # @example
   #   keys = Sketchup.active_model.rendering_options.keys
   #
-  # @return keys - an array of keys
+  # @return [Array<String>] an array of keys
   #
   # @version SketchUp 6.0
   def self.keys
@@ -174,16 +180,15 @@ class Sketchup::RenderingOptions < Sketchup::Entity
 
   # Instance Methods
 
-  # The set value [] method is used to get the value in the array of
-  # rendering options.
+  # The {#[]} method is used to get the value of a rendering option.
   #
   # @example
   #   result = Sketchup.active_model.rendering_options["DisplayInstanceAxes"]
   #
-  # @param key
-  #   The key of the rendering option value to set.
+  # @param [String] key
+  #   The key of the rendering option value to get.
   #
-  # @return value - the value that was found.
+  # @return [Object, nil]
   #
   # @version SketchUp 6.0
   def [](key)
@@ -195,13 +200,13 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   # @example
   #   Sketchup.active_model.rendering_options["DisplayInstanceAxes"] = false
   #
-  # @param key
+  # @param [String] key
   #   The key of the rendering option value to set.
   #
-  # @param value
+  # @param [Object] value
   #   The value to be set.
   #
-  # @return value - the value that was set
+  # @return [Object] the value that was set
   #
   # @version SketchUp 6.0
   def []=(key, value)
@@ -213,10 +218,10 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   #   observer = Sketchup::RenderingOptionsObserver.new # Dummy observer.
   #   result = Sketchup.active_model.rendering_options.add_observer(observer)
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def add_observer(observer)
@@ -265,7 +270,7 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   #     puts key
   #   }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
@@ -293,7 +298,7 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   # @example
   #   keys = Sketchup.active_model.rendering_options.keys
   #
-  # @return keys - an array of keys
+  # @return [Array<String>] an array of keys
   #
   # @version SketchUp 6.0
   def keys
@@ -323,10 +328,10 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   #   options.add_observer(observer)
   #   result = options.remove_observer(observer)
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def remove_observer(observer)

data/SketchUp/Sketchup/SectionPlane.rb

@@ -66,6 +66,37 @@ class Sketchup::SectionPlane < Sketchup::Drawingelement
   def get_plane
   end
 
+  # The {#name} method is used to retrieve the name of the section plane.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   # Grab the first section plane from the model.
+  #   section_plane = entities.grep(Sketchup::SectionPlane).first
+  #   name = section_plane.name
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2018
+  def name
+  end
+
+  # The {#name=} method is used to set the name of a section plane.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = Sketchup.active_model.entities
+  #   # Grab the first section plane from the model.
+  #   section_plane = entities.grep(Sketchup::SectionPlane).first
+  #   section_plane.name = "my section plane"
+  #
+  # @param [String] name
+  #   The new name for the section plane object.
+  #
+  # @version SketchUp 2018
+  def name=(name)
+  end
+
   # The set_plane method is used to set the plane that the section plane is
   # on.
   #
@@ -85,4 +116,37 @@ class Sketchup::SectionPlane < Sketchup::Drawingelement
   def set_plane(plane)
   end
 
+  # The {#symbol} method is used to retrieve the symbol of the section plane.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   # Grab the first section plane from the model.
+  #   section_plane = entities.grep(Sketchup::SectionPlane).first
+  #   symbol = section_plane.symbol
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2018
+  def symbol
+  end
+
+  # The {#symbol=} method is used to set the symbol of a section plane.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = Sketchup.active_model.entities
+  #   # Grab the first section plane from the model.
+  #   section_plane = entities.grep(Sketchup::SectionPlane).first
+  #   section_plane.symbol = "AB1"
+  #
+  # @note The symbol must be three characters or less.
+  #
+  # @param [String] symbol
+  #   The new symbol for the section plane object.
+  #
+  # @version SketchUp 2018
+  def symbol=(symbol)
+  end
+
 end

data/SketchUp/Sketchup/Selection.rb

@@ -67,10 +67,10 @@ class Sketchup::Selection
   #   entity = entities[0]
   #   status = selection.add entity
   #
-  # @param ents_or_array
+  # @param [Array<Sketchup::Entity>] ents_or_array
   #   List or Array of Entity objects.
   #
-  # @return status - the number of Entity objects added
+  # @return [Integer] the number of Entity objects added
   #
   # @version SketchUp 6.0
   def add(ents_or_array)
@@ -82,10 +82,10 @@ class Sketchup::Selection
   #   selection = Sketchup.active_model.selection
   #   status = selection.add_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def add_observer(observer)
@@ -119,7 +119,7 @@ class Sketchup::Selection
   #   UI.messagebox "Ready to Clear"
   #   selection.clear
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def clear
@@ -171,11 +171,11 @@ class Sketchup::Selection
   # @example
   #   selection.each { |entity| UI.messagebox(entity) }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
-  # @yield [entity] A variable that will hold each Entity object as they
+  # @yield [Sketchup::Entity] A variable that will hold each Entity object as they
   #   are found.
   def each
   end
@@ -187,8 +187,7 @@ class Sketchup::Selection
   #   status = selection.add entity
   #   status = selection.empty
   #
-  # @return status - true if the selection is empty. False if the
-  #   selection is not empty.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -206,7 +205,7 @@ class Sketchup::Selection
   #   status = selection.add entity
   #   entity = selection.first
   #
-  # @return entity - the first selected Entity object if successful
+  # @return [Sketchup::Entity] the first selected Entity object if successful
   #
   # @version SketchUp 6.0
   def first
@@ -241,9 +240,7 @@ class Sketchup::Selection
   #   selection.add entity
   #   status = selection.is_curve?
   #
-  # @return status - true if the selection contains all edges that
-  #   belong to a single curve. False if the selection does
-  #   not contain all edges that belong to a single curve.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -258,10 +255,7 @@ class Sketchup::Selection
   #   selection.add entity
   #   status = selection.is_surface
   #
-  # @return status - true if the selection contains all faces that
-  #   belong to a single curved surface. False if the
-  #   selection does not contain all faces that belong to a
-  #   single curved surface.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -290,7 +284,7 @@ class Sketchup::Selection
   # @example
   #   model = selection.model
   #
-  # @return model - the model that includes the selection if
+  # @return [Sketchup::Model] the model that includes the selection if
   #   successful
   #
   # @version SketchUp 6.0
@@ -331,10 +325,10 @@ class Sketchup::Selection
   #   entity = entities[0]
   #   status = selection.add entity
   #
-  # @param ents_or_array
+  # @param [Array<Sketchup::Entity>] ents_or_array
   #   List or Array of Entity objects.
   #
-  # @return status - the number of Entity objects removed
+  # @return [Integer] the number of Entity objects removed
   #
   # @version SketchUp 6.0
   def remove(ents_or_array)
@@ -347,10 +341,10 @@ class Sketchup::Selection
   #   selection = Sketchup.active_model.selection
   #   status = object.remove_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def remove_observer(observer)
@@ -364,7 +358,7 @@ class Sketchup::Selection
   #   UI.messagebox "Ready to remove item from selection set"
   #   entity = selection.shift
   #
-  # @return entity - the first Entity object in the selection set
+  # @return [Sketchup::Entity] the first Entity object in the selection set
   #   if successful
   #
   # @version SketchUp 6.0
@@ -380,9 +374,7 @@ class Sketchup::Selection
   # @example
   #   status = selection.single_object
   #
-  # @return status - true if the selection contains a single
-  #   object. False if the selection does not contain a
-  #   single object.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -426,10 +418,10 @@ class Sketchup::Selection
   #   entity = entities[0]
   #   status = selection.add entity
   #
-  # @param ents_or_array
+  # @param [Array<Sketchup::Entity>] ents_or_array
   #   List or Array of Entity objects.
   #
-  # @return status - the number of Entity objects changed
+  # @return [Integer] the number of Entity objects changed
   #
   # @version SketchUp 6.0
   def toggle(ents_or_array)

data/SketchUp/Sketchup/ShadowInfo.rb

@@ -52,7 +52,7 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @example
   #   shadowinfo.each_key { |key| UI.messagebox(key) }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
@@ -66,7 +66,7 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @example
   #   keys = Sketchup::ShadowInfo.keys
   #
-  # @return keys - an array of keys
+  # @return [Array<String>] an array of keys
   #
   # @version SketchUp 6.0
   def self.keys
@@ -79,10 +79,10 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @example
   #   value = shadowinfo["key"]
   #
-  # @param key
+  # @param [String] key
   #   The key of the shadowinfo value to retrieve.
   #
-  # @return value - the value that is retrieved.
+  # @return [Object, nil] the value that is retrieved.
   #
   # @version SketchUp 6.0
   def [](key)
@@ -99,13 +99,13 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   #   value = shadowinfo["City"]="Denver, CO"
   #   UI.messagebox value
   #
-  # @param key
+  # @param [String] key
   #   The key of the shadowinfo value to set.
   #
-  # @param value
+  # @param [Object] value
   #   The value to be set.
   #
-  # @return value - the value that was set if successful, or false
+  # @return [Object] the value that was set if successful, or false
   #   if unsuccessful.
   #
   # @version SketchUp 6.0
@@ -117,10 +117,10 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @example
   #   status = object.add_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def add_observer(observer)
@@ -132,7 +132,7 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   #   shadow_info = Sketchup.active_model.shadow_info
   #   number = shadow_info.count
   #
-  # @return integer
+  # @return [Integer]
   #
   # @version SketchUp 2014
   def count
@@ -167,7 +167,7 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @example
   #   shadowinfo.each_key { |key| UI.messagebox(key) }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
@@ -204,7 +204,7 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @example
   #   keys = Sketchup::ShadowInfo.keys
   #
-  # @return keys - an array of keys
+  # @return [Array<String>] an array of keys
   #
   # @version SketchUp 6.0
   def keys
@@ -231,10 +231,10 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @example
   #   status = object.remove_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def remove_observer(observer)