sketchup-api-stubs 0.1.2 → 0.2.0

data/SketchUp/_top_level.rb

@@ -5,15 +5,12 @@
 
   # Constants
 
-  ALeaderModel = nil # Stub value.
-  ALeaderNone = nil # Stub value.
-  ALeaderView = nil # Stub value.
-
   ALT_MODIFIER_KEY = nil # Stub value.
   ALT_MODIFIER_MASK = nil # Stub value.
 
-  CONSTRAIN_MODIFIER_KEY = nil # Stub value.
-  CONSTRAIN_MODIFIER_MASK = nil # Stub value.
+  ALeaderModel = nil # Stub value.
+  ALeaderNone = nil # Stub value.
+  ALeaderView = nil # Stub value.
 
   CMD_ARC = nil # Stub value.
   CMD_CAMERA_UNDO = nil # Stub value.
@@ -86,6 +83,9 @@
   COPY_MODIFIER_KEY = nil # Stub value.
   COPY_MODIFIER_MASK = nil # Stub value.
 
+  CONSTRAIN_MODIFIER_KEY = nil # Stub value.
+  CONSTRAIN_MODIFIER_MASK = nil # Stub value.
+
   DimensionArrowClosed = nil # Stub value.
   DimensionArrowDot = nil # Stub value.
   DimensionArrowNone = nil # Stub value.
@@ -107,6 +107,10 @@
   GL_TRIANGLE_FAN = nil # Stub value.
   GL_TRIANGLE_STRIP = nil # Stub value.
 
+  IDENTITY = nil # Stub value.
+
+  IDENTITY_2D = nil # Stub value.
+
   IDABORT = nil # Stub value.
   IDCANCEL = nil # Stub value.
   IDIGNORE = nil # Stub value.
@@ -115,14 +119,18 @@
   IDRETRY = nil # Stub value.
   IDYES = nil # Stub value.
 
-  IDENTITY = nil # Stub value.
-
   LAYER_HIDDEN_BY_DEFAULT = nil # Stub value.
   LAYER_IS_HIDDEN_ON_NEW_PAGES = nil # Stub value.
   LAYER_IS_VISIBLE_ON_NEW_PAGES = nil # Stub value.
   LAYER_USES_DEFAULT_VISIBILITY_ON_NEW_PAGES = nil # Stub value.
   LAYER_VISIBLE_BY_DEFAULT = nil # Stub value.
 
+  MF_CHECKED = nil # Stub value.
+  MF_DISABLED = nil # Stub value.
+  MF_ENABLED = nil # Stub value.
+  MF_GRAYED = nil # Stub value.
+  MF_UNCHECKED = nil # Stub value.
+
   MB_ABORTRETRYIGNORE = nil # Stub value.
   MB_MULTILINE = nil # Stub value.
   MB_OK = nil # Stub value.
@@ -131,13 +139,8 @@
   MB_YESNO = nil # Stub value.
   MB_YESNOCANCEL = nil # Stub value.
 
-  MF_CHECKED = nil # Stub value.
-  MF_DISABLED = nil # Stub value.
-  MF_ENABLED = nil # Stub value.
-  MF_GRAYED = nil # Stub value.
-  MF_UNCHECKED = nil # Stub value.
-
   ORIGIN = nil # Stub value.
+  ORIGIN_2D = nil # Stub value.
 
   PAGE_NO_CAMERA = nil # Stub value.
   PAGE_USE_ALL = nil # Stub value.
@@ -149,10 +152,6 @@
   PAGE_USE_SHADOWINFO = nil # Stub value.
   PAGE_USE_SKETCHCS = nil # Stub value.
 
-  SB_PROMPT = nil # Stub value.
-  SB_VCB_LABEL = nil # Stub value.
-  SB_VCB_VALUE = nil # Stub value.
-
   SnapTo_Arbitrary = nil # Stub value.
   SnapTo_Horizontal = nil # Stub value.
   SnapTo_Sloped = nil # Stub value.
@@ -160,14 +159,24 @@
 
   SKETCHUP_CONSOLE = nil # Stub value.
 
-  TB_HIDDEN = nil # Stub value.
-  TB_NEVER_SHOWN = nil # Stub value.
-  TB_VISIBLE = nil # Stub value.
+  SB_PROMPT = nil # Stub value.
+  SB_VCB_LABEL = nil # Stub value.
+  SB_VCB_VALUE = nil # Stub value.
 
   TextAlignCenter = nil # Stub value.
   TextAlignLeft = nil # Stub value.
   TextAlignRight = nil # Stub value.
 
+  TB_HIDDEN = nil # Stub value.
+  TB_NEVER_SHOWN = nil # Stub value.
+  TB_VISIBLE = nil # Stub value.
+
+  VK_ALT = nil # Stub value.
+  VK_COMMAND = nil # Stub value.
+  VK_CONTROL = nil # Stub value.
+  VK_MENU = nil # Stub value.
+  VK_SHIFT = nil # Stub value.
+
   VK_DELETE = nil # Stub value.
   VK_DOWN = nil # Stub value.
   VK_END = nil # Stub value.
@@ -180,14 +189,117 @@
   VK_SPACE = nil # Stub value.
   VK_UP = nil # Stub value.
 
-  VK_ALT = nil # Stub value.
-  VK_COMMAND = nil # Stub value.
-  VK_CONTROL = nil # Stub value.
-  VK_MENU = nil # Stub value.
-  VK_SHIFT = nil # Stub value.
-
   X_AXIS = nil # Stub value.
   Y_AXIS = nil # Stub value.
   Z_AXIS = nil # Stub value.
 
+  X_AXIS_2D = nil # Stub value.
+
+  Y_AXIS_2D = nil # Stub value.
+
+  # Instance Methods
+
+  # This function will add a separator to a given menu the first
+  # time it is called.  It is useful for adding a separator before
+  # the first plugin that is added to a given menu.
+  #
+  # @deprecated Avoid adding separators to top level menus. If you require
+  #   grouping use a sub-menu instead.
+  #
+  # @param [String] menu_name
+  #
+  # @version SketchUp 6.0
+  def add_separator_to_menu(menu_name)
+  end
+
+  # Call this function at the end of a file that you are loading to
+  # let the system know that you have loaded it.
+  #
+  # @example
+  #   module Example
+  #     unless file_loaded?(__FILE__)
+  #       menu = UI.menu('Plugins')
+  #       menu.add_item('Example') { self.hello }
+  #       file_loaded(__FILE__)
+  #     end
+  #
+  #     def self.hello
+  #       puts 'Hello World'
+  #     end
+  #
+  #   end
+  #
+  # @param [String] filename
+  #
+  # @see #file_loaded?
+  #
+  # @version SketchUp 6.0
+  def file_loaded(filename)
+  end
+
+  # Use in combination with {#file_loaded} to create load guards for code you
+  # don't want to reload. Especially useful to protect your UI setup from creating
+  # duplicate menus and toolbars.
+  #
+  # @example
+  #   module Example
+  #     unless file_loaded?(__FILE__)
+  #       menu = UI.menu('Plugins')
+  #       menu.add_item('Example') { self.hello }
+  #       file_loaded(__FILE__)
+  #     end
+  #
+  #     def self.hello
+  #       puts 'Hello World'
+  #     end
+  #
+  #   end
+  #
+  # @param [String] filename
+  #
+  # @return [Boolean]
+  #
+  # @see #file_loaded
+  #
+  # @version SketchUp 6.0
+  def file_loaded?(filename)
+  end
+
+  # This is a wrapper for {UI.inputbox}.  You call it exactly the same
+  # as {UI.inputbox}.  {UI.inputbox} will raise an exception if it can't
+  # convert the string entered for one of the values into the right type.
+  # This method will trap the exception and display an error dialog and
+  # then prompt for the values again.
+  #
+  # @see UI.inputbox
+  #
+  # @version SketchUp 6.0
+  def inputbox(*args)
+  end
+
+  # By default, SketchUp automatically loads (using require) all files with
+  # the .rb extension in the plugins directory.  This function can be used
+  # to automatically load all .rb files from a different directory also.  to
+  # use this add a call like the following to a file in the plugins directory
+  # <code>require_all "MyRubyScripts"</code>
+  #
+  # @deprecated This adds the path given to +$LOAD_PATH+ which can affect
+  #   other extensions.
+  #
+  # @param [String] dirname
+  #
+  # @version SketchUp 6.0
+  def require_all(dirname)
+  end
+
+  # This global method is called by the Ruby Console menu item. We call this
+  # instead of directly calling <code>Sketchup.send_action("showRubyPanel:")</code>
+  # so that other Ruby Console implementations can hijack this method.
+  #
+  # @deprecated Use +SKETCHUP_CONSOLE.show+ instead.
+  #
+  # @version SketchUp 6.0
+  def show_ruby_panel
+  end
+
 

data/SketchUp/{Array.rb → array.rb}

@@ -35,15 +35,32 @@ class Array
 
   # The {#cross} method is used to compute the cross product between two vectors.
   #
-  # @example
+  # @example With 2d array
+  #   vector1 = Geom::Vector2d.new(0, 1)
+  #   array = [1, 0]
+  #   vector2 = array.cross(vector1)
+  #
+  #   vector1 = Geom::Vector3d.new(0, 1, 0)
+  #   array = [1, 0]
+  #   vector2 = array.cross(vector1) # This will force array to be [1, 0, 0]
+  #
+  # @example With 3d array
   #   vector1 = Geom::Vector3d.new(0, 1, 0)
   #   array = [1, 0, 0]
   #   # This will return a new Vector3d
   #   vector2 = array.cross(vector1)
   #
-  # @param [Geom::Vector3d] vector
+  # @overload cross(vector)
   #
-  # @return [Geom::Vector3d]
+  #   @param [Geom::Vector3d] vector
+  #   @return [Geom::Vector3d]
+  #
+  # @overload cross(vector)
+  #
+  #   @param [Geom::Vector2d] vector
+  #   @return [Geom::Vector2d]
+  #
+  # @raise ArgumentError if the argument is the wrong vector type
   #
   # @version SketchUp 6.0
   def cross(vector)
@@ -51,15 +68,31 @@ class Array
 
   # The {#distance} method is used to compute the distance between two points.
   #
-  # @example
+  # @example With 2d array
+  #   point = Geom::Point2d.new(10, 10)
+  #   array = [1, 2]
+  #   distance = array.distance(point)
+  #
+  #   point = Geom::Point3d.new(10, 10, 10)
+  #   distance = array.distance(point)
+  #
+  # @example With 3d array
   #   point = Geom::Point3d.new(10, 10, 10)
   #   array = [1, 1, 1]
   #   # This will return a Length
   #   distance = array.distance(point)
   #
-  # @param [Geom::Point3d] point
+  # @overload distance(point)
+  #
+  #   @param [Geom::Point3d] point
+  #   @return [Length]
+  #
+  # @overload distance(point)
+  #
+  #   @param [Geom::Point2d] point
+  #   @return [Length]
   #
-  # @return [Length]
+  # @raise ArgumentError if the argument is the wrong point type
   #
   # @version SketchUp 6.0
   def distance(point)
@@ -155,15 +188,29 @@ class Array
 
   # The {#dot} method is used to compute the dot product between two vectors.
   #
-  # @example
+  # @example With 2d array
+  #   vector = Geom::Vector2d.new(12, 12)
+  #   array = [12, 0]
+  #   # This will return a float
+  #   dot_product = array.dot(vector)
+  #
+  # @example With 3d array
   #   vector = Geom::Vector3d.new(12, 12, 0)
   #   array = [12, 0, 0]
   #   # This will return a Float, in this case 144.0
   #   dot_product = array.dot(vector)
   #
-  # @param [Geom::Vector3d] vector
+  # @overload dot(vector)
+  #
+  #   @param [Geom::Vector3d] vector
+  #   @return [Float]
+  #
+  # @overload dot(vector)
+  #
+  #   @param [Geom::Vector2d] vector
+  #   @return [Float]
   #
-  # @return [Float]
+  # @raise ArgumentError if the argument is the wrong vector type
   #
   # @version SketchUp 6.0
   def dot(vector)
@@ -173,7 +220,11 @@ class Array
   # length to 1). It returns a new array rather than changing the original in
   # place.
   #
-  # @example
+  # @example With 2d array
+  #   array = [1, 2]
+  #   normal_vector = array.normalize
+  #
+  # @example With 3d array
   #   array = [1, 2, 3]
   #   # This will return a new Vector3d
   #   normal_vector = array.normalize
@@ -181,7 +232,13 @@ class Array
   # @note The arguments and return value will be converted to a floating point
   #   value. (Unlike in the {Geom::Vector3d#normalize!} method.)
   #
-  # @return [Array(Float, Float, Float)] An array object representing a vector
+  # @overload normalize
+  #
+  #   @return [Array(Float, Float, Float)] an array object representing a vector
+  #
+  # @overload normalize
+  #
+  #   @return [Array(Float, Float)] an array object representing a vector
   #
   # @version SketchUp 6.0
   def normalize
@@ -190,12 +247,22 @@ class Array
   # The {#normalize!} method is used to normalize a vector in place (setting its
   # length to 1).
   #
-  # @example
+  # @example With 2d array
+  #   array = [1, 2]
+  #   array.normalize!
+  #
+  # @example With 3d array
   #   array = [1, 2, 3]
   #   # This will modify 'array' in place
   #   array.normalize!
   #
-  # @return [Array]
+  # @overload normalize!
+  #
+  #   @return [Array(Float, Float, Float)] an array object representing a vector
+  #
+  # @overload normalize!
+  #
+  #   @return [Array(Float, Float)] an array object representing a vector
   #
   # @version SketchUp 6.0
   def normalize!
@@ -204,22 +271,49 @@ class Array
   # The {#offset} method is used to offset a point by a vector. it returns a new
   # array rather than modifying the original in place.
   #
-  # @example
+  # @example With 3d array
   #   array = [10, 10, 10]
   #   vector = Geom::Vector3d.new(0, 0, 1)
-  #   # This will return a new Array
-  #   point = array.offset(vector)
+  #   # This will modify 'array' in place
+  #   length_array = array.offset(vector)
   #
-  # @overload offset!(vector)
+  # @example With 2d array
+  #   array = [10, 10]
+  #   vector = Geom::Vector2d.new(0, 1)
+  #   length_array = array.offset(vector)
+  #
+  #   # Using Vector3d with a 2d array
+  #   array = [10, 10]
+  #   vector = Geom::Vector3d.new(0, 0, 1)
+  #   length_array = array.offset(vector)
+  #
+  # @overload offset(vector, length)
   #
   #   @param [Geom::Vector3d] vector A Vector3d object used to offset the point.
-  #   @return [Array(Length, Length, Length)] The newly offset point or vector.
+  #   @param [Length] length An overriding distance for how far to offset.
+  #   @return [Array(Length, Length, Length)] The newly offset array representing
+  #     a point or vector.
   #
-  # @overload offset!(vector, length)
+  # @overload offset(vector)
+  #
+  #   @param [Geom::Vector2d] vector A Vector2d object used to offset the point.
+  #   @return [Array(Length, Length)] The newly offset array representing a point
+  #     or vector.
+  #
+  # @overload offset(vector)
   #
   #   @param [Geom::Vector3d] vector A Vector3d object used to offset the point.
+  #   @return [Array(Length, Length, Length)] The newly offset array representing
+  #     a point or vector.
+  #
+  # @overload offset(vector, length)
+  #
+  #   @param [Geom::Vector2d] vector A Vector2d object used to offset the point.
   #   @param [Length] length An overriding distance for how far to offset.
-  #   @return [Array(Length, Length, Length)] The newly offset point or vector.
+  #   @return [Array(Length, Length)] The newly offset array representing a point
+  #     or vector.
+  #
+  # @raise ArgumentError if the argument is the wrong vector type
   #
   # @version SketchUp 6.0
   def offset(*args)
@@ -228,7 +322,17 @@ class Array
   # The {#offset!} method is used to offset a point by a vector. The array is
   # modified in place.
   #
-  # @example
+  # @example With 2d array
+  #   array = [10, 10]
+  #   vector = Geom::Vector2d.new(0, 1)
+  #   array.offset!(vector)
+  #
+  #   # Using Vector3d with a 2d array
+  #   array = [10, 10]
+  #   vector = Geom::Vector3d.new(0, 0, 1)
+  #   array.offset!(vector)
+  #
+  # @example With 3d array
   #   array = [10, 10, 10]
   #   vector = Geom::Vector3d.new(0, 0, 1)
   #   # This will modify 'array' in place
@@ -247,6 +351,21 @@ class Array
   #   @return [Array(Length, Length, Length)] The newly offset array representing
   #     a point or vector.
   #
+  # @overload offset!(vector)
+  #
+  #   @param [Geom::Vector2d] vector A Vector2d object used to offset the point.
+  #   @return [Array(Length, Length)] The newly offset array representing a point
+  #     or vector.
+  #
+  # @overload offset!(vector, length)
+  #
+  #   @param [Geom::Vector2d] vector A Vector2d object used to offset the point.
+  #   @param [Length] length An overriding distance for how far to offset.
+  #   @return [Array(Length, Length)] The newly offset array representing a point
+  #     or vector.
+  #
+  # @raise ArgumentError if the argument is the wrong vector type
+  #
   # @version SketchUp 6.0
   def offset!(*args)
   end
@@ -471,15 +590,33 @@ class Array
   # The {#vector_to} method is used to create an array as a vector from one point
   # to a second point.
   #
-  # @example
+  # @example With 2d array
+  #   point = Geom::Point2d.new(10, 20)
+  #   array = [1, 2]
+  #   # This will return a new Vector2d
+  #   vector = array.vector_to(point)
+  #
+  #   point = Geom::Point3d.new(10, 20)
+  #   # This will return a new Vector3d
+  #   vector = array.vector_to(point)
+  #
+  # @example With 3d array
   #   point = Geom::Point3d.new(10, 20, 30)
   #   array = [1, 2, 3]
   #   # This will return a new Vector3d
   #   vector = array.vector_to(point)
   #
-  # @param [Geom::Point3d] point
+  # @overload vector_to(point)
+  #
+  #   @param [Geom::Point3d] point
+  #   @return [Geom::Vector3d]
+  #
+  # @overload vector_to(point)
+  #
+  #   @param [Geom::Point2d] point
+  #   @return [Geom::Vector2d]
   #
-  # @return [Geom::Vector3d]
+  # @raise ArgumentError if the argument is the wrong point type
   #
   # @version SketchUp 6.0
   def vector_to(point)
@@ -511,10 +648,10 @@ class Array
   #   # This will initialize the x value as a Fixnum
   #   array.x = 5
   #
-  # @param x
+  # @param [Object] x
   #   The new x position.
   #
-  # @return The new x coordinate if successful
+  # @return [Object] The new x coordinate if successful
   #
   # @version SketchUp 6.0
   def x=(x)
@@ -546,10 +683,10 @@ class Array
   #   # This will initialize the y value as a Fixnum
   #   array.y = 5
   #
-  # @param y
+  # @param [Object] y
   #   The new y position.
   #
-  # @return The new y coordinate if successful
+  # @return [Object] The new y coordinate if successful
   #
   # @version SketchUp 6.0
   def y=(y)
@@ -581,10 +718,10 @@ class Array
   #   # This will initialize the z value as a Fixnum
   #   array.z = 5
   #
-  # @param z
+  # @param [Object] z
   #   The new z position.
   #
-  # @return The new z coordinate if successful
+  # @return [Object] The new z coordinate if successful
   #
   # @version SketchUp 6.0
   def z=(z)