sketchup-api-stubs 0.1.2 → 0.2.0

data/SketchUp/Sketchup/Group.rb

@@ -25,10 +25,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.entities.add_line([0,0,0],[100,100,100])
   #   status = group.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)
@@ -43,7 +43,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.entities.add_line([0,0,0],[100,100,100])
   #   group2 = group.copy
   #
-  # @return group - a new Group object
+  # @return [Sketchup::Group] a new Group object
   #
   # @version SketchUp 6.0
   def copy
@@ -56,7 +56,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group = Sketchup.active_model.entities.add_group
   #   definition = group.definition
   #
-  # @return componentdefinition - a ComponentDefinition object if
+  # @return [Sketchup::ComponentDefinition] a ComponentDefinition object if
   #   successful
   #
   # @version SketchUp 2015
@@ -86,7 +86,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.description = "This is a Group with a 2d Face"
   #   description = group.description
   #
-  # @return description - a string description if successful
+  # @return [String] a string description if successful
   #
   # @version SketchUp 6.0
   def description
@@ -121,10 +121,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #     UI.messagebox "Failure"
   #   end
   #
-  # @param description
+  # @param [String] description
   #   A string description.
   #
-  # @return description - the new description if successful
+  # @return [String] the new description if successful
   #
   # @version SketchUp 6.0
   def description=(description)
@@ -158,7 +158,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #     UI.messagebox "Failure"
   #   end
   #
-  # @return entities - an Entities object if successful
+  # @return [Sketchup::Entities] an Entities object if successful
   #
   # @version SketchUp 6.0
   def entities
@@ -173,11 +173,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   status = group1.equals?(group2)
   #
-  # @param group
+  # @param [Sketchup::Group] group
   #   The group to compare this group with.
   #
-  # @return status - true if the groups are geometrically
-  #   equivalent. Otherwise false.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -199,7 +198,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #     UI.messagebox "Failure"
   #   end
   #
-  # @return An array of entity objects if successful, false if
+  # @return [Array<Sketchup::Drawingelement>] An array of entity objects if successful, false if
   #   unsuccessful.
   #
   # @version SketchUp 6.0
@@ -215,7 +214,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.entities.add_line([0,0,0],[100,100,100])
   #   guid = group.guid
   #
-  # @return guid - a unique 22 character string
+  # @return [String] a unique 22 character string
   #
   # @version SketchUp 2014
   def guid
@@ -231,10 +230,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   result = group1.intersect(group2)
   #
-  # @param group
+  # @param [Sketchup::Group, Sketchup::ComponentInstance] group
   #   The group to intersect this group with.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds. Otherwise nil is returned.
   #
@@ -260,7 +259,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.transform! transformation
   #   local_bounds_2 = group.local_bounds
   #
-  # @return bounds - a BoundingBox object
+  # @return [Geom::BoundingBox] a BoundingBox object
   #
   # @version SketchUp 7.0
   def local_bounds
@@ -276,7 +275,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #
   # @param [Boolean] lock
   #
-  # @return status - true if the group is locked, false if not
+  # @return [Boolean] true if the group is locked, false if not
   #
   # @version SketchUp 6.0
   def locked=(lock)
@@ -300,7 +299,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   status = group.locked?
   #   UI.messagebox status
   #
-  # @return status - true if the group is locked, false if not.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -325,7 +324,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #     puts "This should not happen since we made the groups unique"
   #   end
   #
-  # @return group - the unique group
+  # @return [Sketchup::Group] the unique group
   #
   # @version SketchUp 6.0
   def make_unique
@@ -340,8 +339,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group = entities.add_instance(definition, transformation)
   #   status = group.manifold?
   #
-  # @return status - true if the group is manifold.
-  #   false if the group is not manifold.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -385,10 +383,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #     UI.messagebox "Failure"
   #   end
   #
-  # @param transform
+  # @param [Geom::Transformation] transform
   #   A Transformation object.
   #
-  # @return group - the transformed Group object if successful
+  # @return [Sketchup::Group] the transformed Group object if successful
   #
   # @version SketchUp 6.0
   def move!(transform)
@@ -403,7 +401,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.name = "A Line"
   #   name = group.name
   #
-  # @return name - The name of the group if successful
+  # @return [String] The name of the group if successful
   #
   # @version SketchUp 6.0
   def name
@@ -418,10 +416,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.name = "A Line"
   #   name = group.name
   #
-  # @param name
+  # @param [String] name
   #   A string name.
   #
-  # @return name - a new name if successful
+  # @return [String] a new name if successful
   #
   # @version SketchUp 6.0
   def name=(name)
@@ -437,10 +435,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   result = group1.outer_shell(group2)
   #
-  # @param group
+  # @param [Sketchup::Group, Sketchup::ComponentInstance] group
   #   The group to outer shell this group with.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds otherwise nil is returned.
   #
@@ -459,10 +457,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #     end
   #   end
   #
-  # @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)
@@ -486,14 +484,14 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   status = group1.show_differences(group2, true)
   #
-  # @param group
+  # @param [Sketchup::Group, Sketchup::ComponentInstance] group
   #   The group to be compared with.
   #
-  # @param verbose
+  # @param [Boolean] verbose
   #   A boolean flag indicating whether to display a textural
   #   report of the found differences to the Ruby console.
   #
-  # @return status - true if the groups are geometrically
+  # @return [Boolean] true if the groups are geometrically
   #   equivalent. Otherwise false.
   #
   # @version SketchUp 8.0
@@ -511,11 +509,11 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   result = group1.split(group2)
   #
-  # @param group
+  # @param [Sketchup::Group, Sketchup::ComponentInstance] group
   #   The group to split this group with.
   #
-  # @return result - A vector (array) of the three resultant groups
-  #   if the two objects (this and arg) represent manifold
+  # @return [Array(Sketchup::Group, Sketchup::Group, Sketchup::Group), nil] A vector (array) of the three resultant groups
+  #   If the two objects (this and arg) represent manifold
   #   solids and the operation succeeds otherwise nil is
   #   returned. The 3 groups are as follows:
   #   The intersection of volume 1 & volume 2,
@@ -536,10 +534,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   result = group1.subtract(group2)
   #
-  # @param group
+  # @param [Sketchup::Group, Sketchup::ComponentInstance] group
   #   The group to subtract this group from.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds. Otherwise nil is returned.
   #
@@ -558,7 +556,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   # change the group to a component instance
   #   group.to_component
   #
-  # @return instance - the new ComponentInstance object
+  # @return [Sketchup::ComponentInstance] the new ComponentInstance object
   #
   # @version SketchUp 6.0
   def to_component
@@ -596,10 +594,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #     UI.messagebox "Failure"
   #   end
   #
-  # @param transform
+  # @param [Geom::Transformation] transform
   #   A Transformation object.
   #
-  # @return group - a transformed group object if successful
+  # @return [Sketchup::Group] a transformed group object if successful
   #
   # @version SketchUp 6.0
   def transform!(transform)
@@ -615,7 +613,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #
   #   trans = group.transformation
   #
-  # @return transformation - a Transformation object if successful
+  # @return [Geom::Transformation] a Transformation object if successful
   #
   # @version SketchUp 6.0
   def transformation
@@ -632,10 +630,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   new_transform = Geom::Transformation.new([100,0,0])
   #   group.transformation = new_transform
   #
-  # @param transform
+  # @param [Geom::Transformation] transform
   #   The Transformation object to apply
   #
-  # @return group - the newly trasformed group
+  # @return [Geom::Transformation] the applied transformation
   #
   # @version SketchUp 6.0
   def transformation=(transform)
@@ -652,10 +650,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   result = group1.trim(group2)
   #
-  # @param group
+  # @param [Sketchup::Group, Sketchup::ComponentInstance] group
   #   The group to trim this group against.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds otherwise nil is returned.
   #
@@ -673,10 +671,10 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   result = group1.union(group2)
   #
-  # @param group
+  # @param [Sketchup::Group, Sketchup::ComponentInstance] group
   #   The group to union this group with.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds. Otherwise nil is returned.
   #
@@ -694,7 +692,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group = entities.add_instance(definition, transformation)
   #   volume = group.volume
   #
-  # @return volume - If the group represents a manifold volume,
+  # @return [Float] If the group represents a manifold volume,
   #   volume will be a positive value. If volume is negative,
   #   the group is not manifold.
   #

data/SketchUp/Sketchup/Image.rb

@@ -81,6 +81,22 @@ class Sketchup::Image < Sketchup::Drawingelement
   def height=(height)
   end
 
+  # The {#image_rep} method returns a copy of a {Sketchup::ImageRep} object
+  # representing the pixel data.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = "Plugins/su_dynamiccomponents/images"
+  #   image_file = Sketchup.find_support_file("report_tool.png", path)
+  #   image = model.active_entities.add_image(image_file, ORIGIN, 300)
+  #   image_rep = image.image_rep
+  #
+  # @return [Sketchup::ImageRep]
+  #
+  # @version SketchUp 2018
+  def image_rep
+  end
+
   # The normal method is used to retrieve the 3D Vector that is perpendicular to
   # the plane of the image.
   #

data/SketchUp/Sketchup/ImageRep.rb

@@ -0,0 +1,226 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# References an image representation object.
+#
+# @version SketchUp 2018
+class Sketchup::ImageRep
+
+  # Instance Methods
+
+  # The {#bits_per_pixel} method gets the number of bits per pixel in the
+  # image.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   bpp = image_rep.bits_per_pixel
+  #
+  # @return [Integer]
+  #
+  # @version SketchUp 2018
+  def bits_per_pixel
+  end
+
+  # The {#color_at_uv} method returns a color corresponding to the UV texture
+  # coordinates
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   color = image_rep.color_at_uv(0.7, 0.5, false)
+  #
+  # @param [Float] v
+  #   The V texture coordinate.
+  #
+  # @param [Boolean] bilinear
+  #   Use bilinear texture filtering. This
+  #   interpolates the colors instead of picking
+  #   the nearest neighbor.
+  #
+  # @param [Float] u
+  #   The U texture coordinate.
+  #
+  # @return [Sketchup::Color, nil]
+  #
+  # @version SketchUp 2018
+  def color_at_uv(u, v, bilinear = false)
+  end
+
+  # The {#colors} method returns an array of {Sketchup::Color} for each pixel in
+  # the image.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   colors = image_rep.colors
+  #
+  # @return [Array<Sketchup::Color>, nil]
+  #
+  # @version SketchUp 2018
+  def colors
+  end
+
+  # The {#data} method gets the pixel data for an image in a string of bytes.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   byte_string = image_rep.data
+  #   byte_string.each_byte { |byte| puts byte, ' ' }
+  #
+  # @return [String, nil]
+  #
+  # @version SketchUp 2018
+  def data
+  end
+
+  # The {#height} method returns the height of an image.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   image_rep.height
+  #
+  # @return [Integer]
+  #
+  # @version SketchUp 2018
+  def height
+  end
+
+  # The {#initialize} method creates a new image object. The image object will
+  # have no data if a path to the image is not provided.
+  #
+  # @example Default constructor
+  #   image_rep = Sketchup::ImageRep.new
+  #
+  # @example Construct from file
+  #   image_rep = Sketchup::ImageRep.new("/path/to/image.jpg")
+  #
+  # @overload initialize(filepath)
+  #
+  #   @param [String] filepath
+  #
+  # @overload initialize
+  #
+  #
+  # @raise [ArgumentError] if the file path or image is invalid.
+  #
+  # @return [Sketchup::ImageRep]
+  #
+  # @version SketchUp 2018
+  def initialize(*args)
+  end
+
+  # The {#load_file} method loads image data from the specified file.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #
+  # @param [String] filepath
+  #
+  # @raise [ArgumentError] if the filepath or image is invalid.
+  #
+  # @version SketchUp 2018
+  def load_file(filepath)
+  end
+
+  # The {#row_padding} method returns the size of the row padding of an image
+  # in bytes.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   image_rep.row_padding
+  #
+  # @return [Integer]
+  #
+  # @version SketchUp 2018
+  def row_padding
+  end
+
+  # The {#save_file} method saves an image data object to an image file
+  # specified by a path.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image1.jpg")
+  #   # do stuff with the image representation
+  #   image_rep.save_file("/path/to/save/image2.jpg")
+  #
+  # @param [String] filepath
+  #
+  # @version SketchUp 2018
+  def save_file(filepath)
+  end
+
+  # The {#set_data} method sets the pixel data of the {Sketchup::ImageRep}.
+  #
+  # @example Setting new data
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   new_image_rep = image_rep.set_data(800, 600, 24, 0, pixel_data)
+  #
+  # @note The encoding of the pixel_data {String} parameter should be ASCII-8BIT.
+  #   Any other encoding could corrupt the binary data.
+  #
+  # @param [Integer] height
+  #   The height of the pixel data.
+  #   Must be greater than 0.
+  #
+  # @param [Integer] width
+  #   The width of the pixel data. Must be greater than 0.
+  #
+  # @param [Integer] row_padding
+  #   The row padding for the pixel data which is
+  #   sized in bytes. Row padding is used to pad each row with zeros so that each
+  #   scanline on the pixel data will end on the data-type boundry.
+  #
+  # @param [Integer] bits_per_pixel
+  #   The bits per pixel for the pixel data.
+  #   Must be either 8/24/32.
+  #
+  # @param [String] pixel_data
+  #   The binary string containing the pixel data
+  #   representing the new image.
+  #
+  # @raise [TypeError] If width, height, bits_per_pixel or pixel_data are wrong
+  #   data types.
+  #
+  # @raise [ArgumentError] If width, height, bits_per_pixel or pixel_data are
+  #   invalid.
+  #
+  # @return [Sketchup::ImageRep]
+  #
+  # @version SketchUp 2018
+  def set_data(width, height, bits_per_pixel, row_padding, pixel_data)
+  end
+
+  # The {#size} method gets the total size of the image data in bytes.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   data_size = image_rep.size
+  #
+  # @return [Integer]
+  #
+  # @version SketchUp 2018
+  def size
+  end
+
+  # The {#width} method returns the width of an image.
+  #
+  # @example
+  #   image_rep = Sketchup::ImageRep.new
+  #   image_rep.load_file("/path/to/image.jpg")
+  #   image_rep.width
+  #
+  # @return [Integer]
+  #
+  # @version SketchUp 2018
+  def width
+  end
+
+end