sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Sketchup/Texture.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Texture class contains methods for obtaining information about textures

data/SketchUp/Sketchup/TextureWriter.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The TextureWriter class is used primarily for writing the textures used in a
@@ -74,14 +74,14 @@ class Sketchup::TextureWriter
   # texture in the texture writer.
   #
   # @example
+  #   tw.load(texturable_entities[0])
+  #   handle = tw.handle(texturable_entities[0])
+  #
+  # @example
   #   load_front_face = true
   #   tw.load(faces[0], load_front_face)
   #   handle = tw.handle(faces[0], load_front_face)
   #
-  # @example
-  #   tw.load(texturable_entities[0])
-  #   handle = tw.handle(texturable_entities[0])
-  #
   # @overload handle(entity)
   #
   #   @param [Sketchup::Entity] entity  A image, component instance, group, or
@@ -122,10 +122,10 @@ class Sketchup::TextureWriter
   # for writing out to a file.
   #
   # @example
-  #   index = tw.load(faces[0], true)
+  #   index = tw.load(texturable_entities[0])
   #
   # @example
-  #   index = tw.load(texturable_entities[0])
+  #   index = tw.load(faces[0], true)
   #
   # @note If you are passing a face in as the entity argument when loading a
   #   texture you will have to specify the second boolean argument, side.
@@ -164,6 +164,12 @@ class Sketchup::TextureWriter
   #   - 2 = FILE_WRITE_FAILED_UNKNOWN
   #
   # @example
+  #   tw.load(texturable_entities[0])
+  #   if tw.write(texturable_entities[0], "C:\\textures\\A.jpg") == FILE_WRITE_OK
+  #     puts("JPEG file successfully written.")
+  #   end
+  #
+  # @example
   #   tw.load(faces[0], true)
   #   if tw.write(faces[0], true, "C:\\textures\\Face.png") == FILE_WRITE_OK
   #     puts("PNG file successfully written.")
@@ -175,12 +181,6 @@ class Sketchup::TextureWriter
   #     puts("TIFF file successfully written.")
   #   end
   #
-  # @example
-  #   tw.load(texturable_entities[0])
-  #   if tw.write(texturable_entities[0], "C:\\textures\\A.jpg") == FILE_WRITE_OK
-  #     puts("JPEG file successfully written.")
-  #   end
-  #
   # @note If you are passing a face in as the entity argument when writing a
   #   texture you will have to specify the boolean argument, side. The argument
   #   side controls the side of the face from which the texture will be sampled

data/SketchUp/Sketchup/Tool.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Tool is the interface that you implement to create a SketchUp tool.
@@ -101,10 +101,10 @@ class Sketchup::Tool
   #
   # @return nil
   #
-  # @see Sketchup::View#draw
-  #
   # @see getExtents
   #
+  # @see Sketchup::View#draw
+  #
   # @version SketchUp 6.0
   def draw(view)
   end
@@ -214,34 +214,34 @@ class Sketchup::Tool
   #    end
   #   end
   #
+  # @param menu
+  #   A Menu object.
+  #
   # @param [optional] flags
   #   A bit mask that tells the state of the
   #   modifier keys and other mouse buttons at the time.
   #   Added in SU2015.
   #
-  # @param menu
-  #   A Menu object.
-  #
   # @param [optional] x
   #   The X coordinate on the screen where the
   #   event occurred. Added in SU2015.
   #
-  # @param [optional] view
-  #   A View object where the method was invoked.
-  #   Added in SU2015.
-  #
   # @param [optional] y
   #   The Y coordinate on the screen where the
   #   event occurred. Added in SU2015.
   #
+  # @param [optional] view
+  #   A View object where the method was invoked.
+  #   Added in SU2015.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
   def getMenu(menu, flags, x, y, view)
   end
 
-  # The onCancel method is called by SketchUp to cancel the current operation of
-  # the tool. The typical response will be to reset the tool to its initial
+  # The {#onCancel} method is called by SketchUp to cancel the current operation
+  # of the tool. The typical response will be to reset the tool to its initial
   # state.
   #
   # The reason identifies the action that triggered the call. The reason can be
@@ -256,13 +256,16 @@ class Sketchup::Tool
   #     puts "MyTool was canceled for reason ##{reason} in view: #{view}"
   #   end
   #
-  # @param reason
+  # @note When something is undone {#onCancel} is called before the undo is
+  #   actually executed. If you need to do something with the model after an undo
+  #   use {Sketchup::ModelObserver#onTransactionUndo}.
+  #
+  # @param [Integer] reason
   #   A reason value (see comments).
   #
-  # @param view
-  #   A View object where the method was invoked.
+  # @param [Sketchup::View] view
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def onCancel(reason, view)
@@ -315,13 +318,13 @@ class Sketchup::Tool
   #   A value of 1 for a single press of a key.  A value of 2
   #   if the user has pressed a key and is holding it down.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param flags
   #   A bit mask that tells the state of the modifier keys at
   #   the time of the onKeyDown.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -346,13 +349,13 @@ class Sketchup::Tool
   #   A value of 1 for a single press of a key.  A value of 2
   #   if the user has pressed a key and is holding it down.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param flags
   #   A bit mask that tells the state of the modifier keys at
   #   the time of the onKeyUp.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -377,12 +380,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -407,12 +410,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -437,12 +440,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -475,12 +478,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -509,12 +512,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -544,12 +547,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -611,12 +614,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -641,12 +644,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -673,12 +676,12 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
@@ -703,31 +706,30 @@ class Sketchup::Tool
   # @param x
   #   The X coordinate on the screen where the event occurred.
   #
-  # @param view
-  #   A View object where the method was invoked.
-  #
   # @param y
   #   The Y coordinate on the screen where the event occurred.
   #
+  # @param view
+  #   A View object where the method was invoked.
+  #
   # @return nil
   #
   # @version SketchUp 6.0
   def onRButtonUp(flags, x, y, view)
   end
 
-  # The onReturn method is called by SketchUp when the user hit the Return key
+  # The {#onReturn} method is called by SketchUp when the user hit the Return key
   # to complete an operation in the tool. This method will rarely need to be
   # implemented.
   #
   # @example
-  #   def onMouseLeave(view)
-  #     puts "onMouseLeave: view = #{view}"
+  #   def onReturn(view)
+  #     puts "onReturn(#{view})"
   #   end
   #
-  # @param view
-  #   A View object where the method was invoked.
+  # @param [Sketchup::View] view
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def onReturn(view)
@@ -749,21 +751,23 @@ class Sketchup::Tool
   def onSetCursor
   end
 
-  # The onUserText method is called by SketchUp when the user has typed text
+  # The {#onUserText} method is called by SketchUp when the user has typed text
   # into the VCB and hit return.
   #
   # @example
   #   def onUserText(text, view)
-  #     puts "onSetCursor: text = #{text}, view = #{view}"
+  #     @distance = text.to_l
+  #   rescue ArgumentError
+  #     view.tooltop = 'Invalid length'
   #   end
   #
-  # @param text
+  # @param [String] text
   #   The text string that was typed into the VCB.
   #
-  # @param view
-  #   A View object where the method was invoked.
+  # @param [Sketchup::View] view
+  #   A view object where the method was invoked.
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def onUserText(text, view)

data/SketchUp/Sketchup/Tools.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Tools class contains methods to manipulate a collection of SketchUp
@@ -12,6 +12,18 @@ class Sketchup::Tools
 
   # Instance Methods
 
+  # The {#active_tool} method is used to obtain the active Ruby tool.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   tool = tools.current
+  #
+  # @return [Object, nil] Returns the active Ruby tool, or `nil` otherwise.
+  #
+  # @version SketchUp 2019
+  def active_tool
+  end
+
   # The active_tool_id method is used to retrieve the active tool's id.
   #
   # @example

data/SketchUp/Sketchup/ToolsObserver.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 tool events. To implement
@@ -96,16 +96,16 @@ class Sketchup::ToolsObserver
   #   do this shown below. (This example is not a comprehensive list of the tool
   #   names.)
   #
-  # @param [Integer] tool_id
-  #   The ID of the tool. This is a predefined number
-  #   unique to a given tool. For example, the Materials Browser is tool_id
-  #   21074.
+  # @param [Sketchup::Tools] tools
+  #   A Tools object.
   #
   # @param [String] tool_name
   #   The name of the tool.
   #
-  # @param [Sketchup::Tools] tools
-  #   A Tools object.
+  # @param [Integer] tool_id
+  #   The ID of the tool. This is a predefined number
+  #   unique to a given tool. For example, the Materials Browser is tool_id
+  #   21074.
   #
   # @return [nil]
   #
@@ -130,20 +130,20 @@ class Sketchup::ToolsObserver
   #   use the tool_id to keep track of which tool you need to watch for, or use
   #   logic that corrects for the error. This bug was fixed in SketchUp 8.0.
   #
-  # @param [Integer] tool_state
-  #   A number identifying the state the tool just
-  #   entered.
-  #
   # @param [Sketchup::Tools] tools
   #   A Tools object.
   #
+  # @param [String] tool_name
+  #   The name of the tool.
+  #
   # @param [Integer] tool_id
   #   The ID of the tool. This is a predefined number
   #   unique to a given tool. For example, the Materials Browser is tool_id
   #   21074.
   #
-  # @param [String] tool_name
-  #   The name of the tool.
+  # @param [Integer] tool_state
+  #   A number identifying the state the tool just
+  #   entered.
   #
   # @return [nil]
   #