sketchup-api-stubs 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d86e54229a57ebb19147e5205870f8fe3145754609c969ce71b427b308c12c5
-  data.tar.gz: 9b38cf484d344ed8339a669c53d7094e3516cbae7e18180db4aa950706041187
+  metadata.gz: 3ddc727e8b70fc96911cd671ce1e7b2b8a2d44722d5b22799c75b8d2c6adfd3b
+  data.tar.gz: d34bf87fa30222d20dd603784a24c8eb0eb2d9b7736a264e64cb767c5aec39be
 SHA512:
-  metadata.gz: a594517036b927e330b114a0337ab953f4de1b629f94a7cb910179233055a67a6fcf929dd14ee32f1dacb63607c15486bfa008d3d546d3c8a7a7e20ae71fc583
-  data.tar.gz: 0c21036a0ab3dc68b1f36a3ef6b5fbc942ef359c991fcbc2eb9d1e96aa064f44a457ca5aad6074093f3c43c1ef3a309b52ca49c304c36ff9c383dfdc790fe78d
+  metadata.gz: ddc5bf5358352f5a15b9dc148a7d820bbb89509173a31444602f29ed7885b373201d927d47d5e21d80ff1bb4676d701d1b69c1d8b86359b4796b99dba6b54822
+  data.tar.gz: c8756870501af4a053a6f64d231f9fcc3545945181aed1239e756a8f6663ec3b4b30f7476014efbe3f56952a7f6c44d69add8a239542ddf2f25306294f5e4356

data/lib/sketchup-api-stubs/{autoload.rb → sketchup.rb}

@@ -1,3 +1,5 @@
+# This file is auto-generated by the `thor stubs` command.
+require 'sketchup-api-stubs/stubs/_top_level.rb'
 require 'sketchup-api-stubs/stubs/Array.rb'
 require 'sketchup-api-stubs/stubs/Geom.rb'
 require 'sketchup-api-stubs/stubs/Geom/BoundingBox.rb'
@@ -47,10 +49,9 @@ require 'sketchup-api-stubs/stubs/Layout/TableRow.rb'
 require 'sketchup-api-stubs/stubs/Length.rb'
 require 'sketchup-api-stubs/stubs/Numeric.rb'
 require 'sketchup-api-stubs/stubs/Sketchup.rb'
-require 'sketchup-api-stubs/stubs/Sketchup/Entity.rb'
-require 'sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Animation.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/AppObserver.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/Entity.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Curve.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb'
@@ -58,9 +59,10 @@ require 'sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Axes.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Behavior.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Camera.rb'
-require 'sketchup-api-stubs/stubs/Sketchup/Classifications.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/Classifications.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Color.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Console.rb'
@@ -141,4 +143,3 @@ require 'sketchup-api-stubs/stubs/UI/HtmlDialog.rb'
 require 'sketchup-api-stubs/stubs/UI/Notification.rb'
 require 'sketchup-api-stubs/stubs/UI/Toolbar.rb'
 require 'sketchup-api-stubs/stubs/UI/WebDialog.rb'
-require 'sketchup-api-stubs/stubs/_top_level.rb'

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

@@ -9,10 +9,6 @@ class Layout::Path < Layout::Entity
 
   # Constants
 
-  PATH_WINDING_CLOCKWISE = nil # Stub value.
-  PATH_WINDING_COUNTER_CLOCKWISE = nil # Stub value.
-  PATH_WINDING_NONE = nil # Stub value.
-
   POINT_TYPE_ARC_CENTER = nil # Stub value.
   POINT_TYPE_BEZIER_CONTROL = nil # Stub value.
   POINT_TYPE_BEZIER_TO = nil # Stub value.
@@ -20,6 +16,10 @@ class Layout::Path < Layout::Entity
   POINT_TYPE_LINE_TO = nil # Stub value.
   POINT_TYPE_MOVE_TO = nil # Stub value.
 
+  PATH_WINDING_CLOCKWISE = nil # Stub value.
+  PATH_WINDING_COUNTER_CLOCKWISE = nil # Stub value.
+  PATH_WINDING_NONE = nil # Stub value.
+
   # Class Methods
 
   # The {.new_arc} method creates a new arc-shaped {Layout::Path}.

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

@@ -18,11 +18,11 @@ class Layout::SketchUpModel < Layout::Entity
 
   # Constants
 
-  BACK_VIEW = nil # Stub value.
-
   BOTTOM_RELATIVE_VIEW = nil # Stub value.
   BOTTOM_VIEW = nil # Stub value.
 
+  BACK_VIEW = nil # Stub value.
+
   CUSTOM_VIEW = nil # Stub value.
 
   FRONT_VIEW = nil # Stub value.

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

@@ -15,6 +15,14 @@ class Layout::Style
 
   # Constants
 
+  ALIGN_CENTER = nil # Stub value.
+  ALIGN_LEFT = nil # Stub value.
+  ALIGN_RIGHT = nil # Stub value.
+
+  ANCHOR_BOTTOM = nil # Stub value.
+  ANCHOR_CENTER = nil # Stub value.
+  ANCHOR_TOP = nil # Stub value.
+
   ARCHITECTURAL_INCHES = nil # Stub value.
 
   ARROW_FILLED_CIRCLE = nil # Stub value.
@@ -37,23 +45,18 @@ class Layout::Style
   ARROW_T = nil # Stub value.
   ARROW_UNDERRUN = nil # Stub value.
 
-  ALIGN_CENTER = nil # Stub value.
-  ALIGN_LEFT = nil # Stub value.
-  ALIGN_RIGHT = nil # Stub value.
-
-  ANCHOR_BOTTOM = nil # Stub value.
-  ANCHOR_CENTER = nil # Stub value.
-  ANCHOR_TOP = nil # Stub value.
-
   CAP_STYLE_FLAT = nil # Stub value.
   CAP_STYLE_ROUND = nil # Stub value.
   CAP_STYLE_SQUARE = nil # Stub value.
 
-  DIMENSION_END_EXTENSION_LINE = nil # Stub value.
-  DIMENSION_LEADER_LINE = nil # Stub value.
-  DIMENSION_LINE = nil # Stub value.
-  DIMENSION_START_EXTENSION_LINE = nil # Stub value.
-  DIMENSION_TEXT = nil # Stub value.
+  DIMENSION_TEXT_ABOVE = nil # Stub value.
+  DIMENSION_TEXT_BELOW = nil # Stub value.
+  DIMENSION_TEXT_CENTER = nil # Stub value.
+  DIMENSION_TEXT_HORIZONTAL = nil # Stub value.
+  DIMENSION_TEXT_OFFSET = nil # Stub value.
+  DIMENSION_TEXT_PARALLEL = nil # Stub value.
+  DIMENSION_TEXT_PERPENDICULAR = nil # Stub value.
+  DIMENSION_TEXT_VERTICAL = nil # Stub value.
 
   DECIMAL_CENTIMETERS = nil # Stub value.
   DECIMAL_FEET = nil # Stub value.
@@ -64,14 +67,11 @@ class Layout::Style
 
   DEGREES = nil # Stub value.
 
-  DIMENSION_TEXT_ABOVE = nil # Stub value.
-  DIMENSION_TEXT_BELOW = nil # Stub value.
-  DIMENSION_TEXT_CENTER = nil # Stub value.
-  DIMENSION_TEXT_HORIZONTAL = nil # Stub value.
-  DIMENSION_TEXT_OFFSET = nil # Stub value.
-  DIMENSION_TEXT_PARALLEL = nil # Stub value.
-  DIMENSION_TEXT_PERPENDICULAR = nil # Stub value.
-  DIMENSION_TEXT_VERTICAL = nil # Stub value.
+  DIMENSION_END_EXTENSION_LINE = nil # Stub value.
+  DIMENSION_LEADER_LINE = nil # Stub value.
+  DIMENSION_LINE = nil # Stub value.
+  DIMENSION_START_EXTENSION_LINE = nil # Stub value.
+  DIMENSION_TEXT = nil # Stub value.
 
   ENGINEERING_FEET = nil # Stub value.
 
@@ -102,10 +102,10 @@ class Layout::Style
   STROKE_PATTERN_SHORT_DASH = nil # Stub value.
   STROKE_PATTERN_SOLID = nil # Stub value.
 
-  SUB_SCRIPT = nil # Stub value.
-
   SUPER_SCRIPT = nil # Stub value.
 
+  SUB_SCRIPT = nil # Stub value.
+
   UNDERLINE_DOUBLE = nil # Stub value.
   UNDERLINE_NONE = nil # Stub value.
   UNDERLINE_SINGLE = nil # Stub value.

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

@@ -74,7 +74,7 @@ class Sketchup::Behavior < Sketchup::Entity
   #     UI.messagebox "Failure"
   #   end
   #
-  # @return behavior - true if the component is set to always face
+  # @return [Boolean] behavior - true if the component is set to always face
   #   the camera, false if the component is not set to always
   #   face camera.
   #
@@ -119,7 +119,7 @@ class Sketchup::Behavior < Sketchup::Entity
   #     # if status is false, do something else
   #   end
   #
-  # @return status - the status of the cuts_opening behavior
+  # @return [Boolean] status - the status of the cuts_opening behavior
   #   (either true or false)
   #
   # @version SketchUp 6.0
@@ -162,7 +162,7 @@ class Sketchup::Behavior < Sketchup::Entity
   #     # if status is false, do something else
   #   end
   #
-  # @return status - the status of the 2D behavior (either true or
+  # @return [Boolean] status - the status of the 2D behavior (either true or
   #   false)
   #
   # @version SketchUp 6.0
@@ -216,7 +216,7 @@ class Sketchup::Behavior < Sketchup::Entity
   #   behavior = definition.behavior
   #   no_scale_mask = behavior.no_scale_mask?
   #
-  # @return scale_mask - an integer describing which scale tool
+  # @return [Boolean] scale_mask - an integer describing which scale tool
   #   handles are hidden.
   #
   # @version SketchUp 7.0
@@ -262,7 +262,7 @@ class Sketchup::Behavior < Sketchup::Entity
   #     UI.messagebox $!.message
   #   end
   #
-  # @return status - true if the component's is to be cast from the
+  # @return [Boolean] status - true if the component's is to be cast from the
   #   component's current position as though the component
   #   were facing the sun. False to cause the shadow to be
   #   cast from the component's current position.

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

@@ -256,7 +256,7 @@ class Sketchup::Camera
   #     # Compute the vertical FOV.
   #   end
   #
-  # @return bool - true if vertical, false otherwise
+  # @return [Boolean] bool - true if vertical, false otherwise
   #
   # @version SketchUp 2015
   def fov_is_height?
@@ -385,7 +385,7 @@ class Sketchup::Camera
   # @example
   #   Sketchup.active_model.active_view.camera.is_2d?
   #
-  # @return Boolean - true if camera is in 2d mode, false otherwise
+  # @return [Boolean] Boolean - true if camera is in 2d mode, false otherwise
   #
   # @version SketchUp 2015
   def is_2d?
@@ -424,7 +424,7 @@ class Sketchup::Camera
   #     UI.messagebox "Orthographic"
   #   end
   #
-  # @return status - true if perspective, false if orthographic
+  # @return [Boolean] status - true if perspective, false if orthographic
   #
   # @version SketchUp 6.0
   def perspective?

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

@@ -67,7 +67,7 @@ class Sketchup::Console
   # @example
   #   puts SKETCHUP_CONSOLE.visible?
   #
-  # @return true if visible, false if not.
+  # @return [Boolean] true if visible, false if not.
   #
   # @version SketchUp 2014
   def visible?

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

@@ -109,7 +109,7 @@ class Sketchup::Curve < Sketchup::Entity
   #   ents.each { |e| curve = e.curve if e.is_a? Sketchup::Edge }
   #   is_poly = curve.is_polygon?
   #
-  # @return True if this edge was originally created by the polygon
+  # @return [Boolean] True if this edge was originally created by the polygon
   #   tool, otherwise false.
   #
   # @version SketchUp 7.1 M1

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

@@ -98,7 +98,7 @@ class Sketchup::Dimension < Sketchup::Drawingelement
   # @example
   #   aligned = dim.has_aligned_text?
   #
-  # @return status - true if text is aligned to the dimension.
+  # @return [Boolean] status - true if text is aligned to the dimension.
   #   False if dimension text is aligned to the screen.
   #
   # @version SketchUp 2014

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

@@ -311,8 +311,6 @@ class Sketchup::Edge < Sketchup::Drawingelement
   # @param [Sketchup::Face] face
   #   The face that is bounded by the edge.
   #
-  # @return [Boolean]
-  #
   # @return [Boolean] +true+ if the edge is reversed, +false+ if it is not
   #   reversed. +nil+ if the edge and face is not connected.
   #

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

@@ -180,7 +180,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
   #   edgeuse = edgeuses[0]
   #   reversed = edgeuse.reversed?
   #
-  # @return boolean - true if reversed, false if not reversed.
+  # @return [Boolean] boolean - true if reversed, false if not reversed.
   #
   # @version SketchUp 6.0
   def reversed?

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

@@ -691,7 +691,7 @@ class Sketchup::Entities
   def add_section_plane(plane)
   end
 
-  # The {#add_text} method adds a note or label text entity to the entities
+  # The {#add_text} method adds a note or label text entity to the entities.
   #
   # @example
   #   coordinates = [10, 10, 10]
@@ -718,14 +718,17 @@ class Sketchup::Entities
   #
   # @overload add_text(text, point, vector)
   #
+  #   @bug SketchUp 2019.0 had a regression bug where an error was thrown if
+  #     +point+ was provided as a {Sketchup::Vertex} or {Sketchup::InputPoint}.
+  #     This was fixed in SketchUp 2019.1.
   #   @param [String] text The text string to add.
-  #   @param [Geom::Point3d] point A Point3d object representing the insertion
-  #     point.
+  #   @param [Geom::Point3d, Sketchup::Vertex, Sketchup::InputPoint] point
+  #     A Point3d object representing the insertion point.
   #   @param [Geom::Vector3d] vector The Vector representing an arrow leader.
   #
   # @overload add_text(text, instance_path_and_pt, vector)
   #
-  #   @note Added in SketchUp 2019.
+  #   @version SketchUp 2019
   #   @param [String] text The text to add.
   #   @param [Array<Sketchup::InstancePath, Geom::Point3d>] instance_path_and_pt
   #     The array containing a {Sketchup::InstancePath} and a {Geom::Point3d}.
@@ -733,7 +736,7 @@ class Sketchup::Entities
   #
   # @overload add_text(text, instance_array_and_pt, vector)
   #
-  #   @note Added in SketchUp 2019.
+  #   @version SketchUp 2019
   #   @param [String] text The text to add.
   #   @param [Array(Array<Sketchup::Entity>, Geom::Point3d)] instance_array_with_pt
   #     The array containing one or more {Sketchup::ComponentInstance}'s and a

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

@@ -127,6 +127,8 @@ class Sketchup::Entity
   # AttributeDictionary. Otherwise, {#delete_attribute} deletes the attribute with
   # the given key from the given dictionary.
   #
+  # @bug Prior to SketchUp 2019.0 the return values was always +true+.
+  #
   # @example
   #   depth = 100
   #   width = 100
@@ -151,8 +153,6 @@ class Sketchup::Entity
   #   The dictionaries cannot be deleted via ruby and an ArgumentError will be
   #   raised. The key/value pairs in the dictionary can be deleted safely.
   #
-  # @note The return values are fixed in SketchUp 2019 M0.
-  #
   # @overload delete_attribute(dictionary_name)
   #
   #   @param dictionary_name [String] The name of an attribute dictionary.

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

@@ -181,7 +181,7 @@ class Sketchup::Importer
   #     return true
   #   end
   #
-  # @return supports_options - a boolean
+  # @return [Boolean] supports_options - a boolean
   #
   # @version SketchUp 6.0
   def supports_options?

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

@@ -142,7 +142,7 @@ class Sketchup::InputPoint
   #   ip1 = view.inputpoint x,y
   #   status = ip1.display
   #
-  # @return status - true if the draw method will draw something,
+  # @return [Boolean] status - true if the draw method will draw something,
   #   false if the draw method has nothing to draw
   #
   # @version SketchUp 6.0
@@ -365,7 +365,7 @@ class Sketchup::InputPoint
   #   ip1 = view.inputpoint x,y
   #   status = ip1.valid?
   #
-  # @return status - true if the input point has valid data, false
+  # @return [Boolean] status - true if the input point has valid data, false
   #   if it does not have valid data.
   #
   # @version SketchUp 6.0

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

@@ -253,7 +253,7 @@ class Sketchup::Layer < Sketchup::Entity
   #   new_layer = layers.add "test layer"
   #   UI.messagebox(new_layer.visible?)
   #
-  # @return true if the layer is visible
+  # @return [Boolean] true if the layer is visible
   #
   # @version SketchUp 6.0
   def visible?

data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb

@@ -56,7 +56,7 @@ class Sketchup::Licensing::ExtensionLicense
   #      puts "Extension is licensed."
   #   end
   #
-  # @return Boolean - true if the extension is allowed to run, false
+  # @return [Boolean] Boolean - true if the extension is allowed to run, false
   #   if it is not licensed and should quit.
   #
   # @version SketchUp 2015

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

@@ -26,7 +26,7 @@ class Sketchup::Loop < Sketchup::Entity
   #     puts "Loop is not convex."
   #   end
   #
-  # @return status - true if convex, false if not convex.
+  # @return [Boolean] status - true if convex, false if not convex.
   #
   # @version SketchUp 6.0
   def convex?
@@ -108,7 +108,7 @@ class Sketchup::Loop < Sketchup::Entity
   #     puts "Loop is not an outer loop."
   #   end
   #
-  # @return status - true if the loop is an outer loop, false if it
+  # @return [Boolean] status - true if the loop is an outer loop, false if it
   #   is not an outer loop.
   #
   # @version SketchUp 6.0

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

@@ -31,6 +31,10 @@ class Sketchup::Material < Sketchup::Entity
   MATERIAL_SOLID = nil # Stub value.
   MATERIAL_TEXTURED = nil # Stub value.
 
+  OWNER_IMAGE = nil # Stub value.
+  OWNER_LAYER = nil # Stub value.
+  OWNER_MANAGER = nil # Stub value.
+
   # Instance Methods
 
   # The <=> method is used to compare two materials based on name. The number
@@ -291,6 +295,20 @@ class Sketchup::Material < Sketchup::Entity
   def name=(str)
   end
 
+  # The {#owner_type} method is used to determine if the material is owned
+  # by a {Sketchup::Materials}.
+  #
+  # Returned value is one of:
+  # * +Sketchup::Material::OWNER_MANAGER+
+  # * +Sketchup::Material::OWNER_IMAGE+
+  # * +Sketchup::Material::OWNER_LAYER+
+  #
+  # @return [Integer]
+  #
+  # @version SketchUp 2019.2
+  def owner_type
+  end
+
   # The {#save_as} method is used to write a material to a SKM file.
   #
   # You must remember to append ".skm" to the filename as this will not be done

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

@@ -1149,7 +1149,8 @@ class Sketchup::Model
   #     Sketchup::Model::VERSION_2015,
   #     Sketchup::Model::VERSION_2016,
   #     Sketchup::Model::VERSION_2017,
-  #     Sketchup::Model::VERSION_2018
+  #     Sketchup::Model::VERSION_2018,
+  #     Sketchup::Model::VERSION_2019
   #
   # @return [Boolean] true if successful, false if unsuccessful
   #
@@ -1184,7 +1185,8 @@ class Sketchup::Model
   #   Sketchup::Model::VERSION_2015,
   #   Sketchup::Model::VERSION_2016,
   #   Sketchup::Model::VERSION_2017,
-  #   Sketchup::Model::VERSION_2018
+  #   Sketchup::Model::VERSION_2018,
+  #   Sketchup::Model::VERSION_2019
   #
   # @return [Boolean] true if successful, false if unsuccessful
   #