sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/AttributeDictionaries.rb

@@ -0,0 +1,146 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The AttributeDictionaries class is a collection of all of the
+# AttributeDictionary objects that are attached to a given Entity object.
+#
+# The Entity class is a popular parent class in SketchUp, meaning you can
+# attach AttributeDictionaries to almost anything, from geometric items
+# like edges and faces and components to more conceptual things like pages
+# or materials.
+#
+# You access this class not by performing an AttributeDictionaries.new but
+# by grabbing a handle from an existing entity.
+#
+# @example
+#   # Grab the first entity from the model.
+#   my_layer = Sketchup.active_model.entities[0]
+#
+#   # Grab a handle to its attribute dictionaries.
+#   attrdicts = my_layer.attribute_dictionaries
+#
+# @version SketchUp 6.0
+class Sketchup::AttributeDictionaries < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # Get an AttributeDictionary by name. Returns nil if there is none with the
+  # given name.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   attrdicts = model.attribute_dictionaries
+  #   # Iterates through all dictionaries and prints to screen.
+  #   dict = attrdicts['my_dictionary']
+  #   if dict
+  #     UI.messagebox("Found: " + dict.to_s)
+  #   else
+  #     UI.messagebox("No dictionary found.")
+  #   end
+  #
+  # @param key
+  #   The name of the attribute dictionary.
+  #
+  # @return dictionary - the dictionary
+  #
+  # @version SketchUp 6.0
+  def [](key)
+  end
+
+  # The count method is inherited from the Enumerable mix-in module.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionaries = model.attribute_dictionaries
+  #   number = dictionaries.count
+  #
+  # @return [Integer] the number of attribute dictionary objects
+  #   in the collection.
+  #
+  # @see #length
+  #
+  # @version SketchUp 2014
+  def count
+  end
+
+  # The delete method destroys a given AttributeDictionary. This
+  # AttributeDictionary can be passed directly or identified by its
+  # string name.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   attrdicts = model.attribute_dictionaries
+  #   # Deletes a dictionary called 'my_dictionary'
+  #   attrdicts.delete 'my_dictionary'
+  #
+  # @param key_or_dict
+  #   The name of the attribute dictionary to delete, or
+  #   the dictionary object itself.
+  #
+  # @return dictionaries - the modified AttributeDictionaries object
+  #
+  # @version SketchUp 6.0
+  def delete(key_or_dict)
+  end
+
+  # The each method is used to iterate through all of the attributes
+  # dictionaries.
+  #
+  # Throws an exception if there are no keys.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   attrdicts = model.attribute_dictionaries
+  #   # Iterates through all dictionaries and prints to screen.
+  #   attrdicts.each { | dict | UI.messagebox dict }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [dict] Each AttributeDictionary as it is found.
+  def each
+  end
+
+  # The {#length} method returns the number of attribute dictionary objects in
+  # the collection.
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionaries = model.attribute_dictionaries
+  #   number = dictionaries.length
+  #
+  # @return [Integer] the number of attribute dictionary objects in the
+  #   collection.
+  #
+  # @version SketchUp 2014
+  def length
+  end
+
+  # The {#length} method returns the number of attribute dictionary objects in
+  # the collection.
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionaries = model.attribute_dictionaries
+  #   number = dictionaries.length
+  #
+  # @return [Integer] the number of attribute dictionary objects in the
+  #   collection.
+  #
+  # @version SketchUp 2014
+  def size
+  end
+
+end

data/SketchUp/Sketchup/AttributeDictionary.rb

@@ -0,0 +1,280 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The AttributeDictionary class allows you to attach arbitrary collections of
+# attributes to a SketchUp entity. The attributes are defined by key/value
+# pairs where the keys are strings.  An Entity or Model object can have any
+# number of AttributeDictionary objects (see the AttributeDictionaries class).
+#
+# The Entity class is a popular parent class in SketchUp, meaning you can
+# attach attribute dictionaries to almost anything, from geometric items
+# like edges and faces and components to more conceptual things like pages
+# or materials.
+#
+# @version SketchUp 6.0
+class Sketchup::AttributeDictionary < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The [] method is used to retrieve the attribute with a given key.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   value = model.set_attribute "testdictionary", "test", 115
+  #   attrdicts = model.attribute_dictionaries
+  #   attrdict = attrdicts["testdictionary"]
+  #
+  #   # value will contain 115
+  #   value = attrdict["test"]
+  #
+  # @param key
+  #   The name of the attribute.
+  #
+  # @return attribute - the attribute stored under your key, or
+  #   nil if not found
+  #
+  # @version SketchUp 6.0
+  def [](key)
+  end
+
+  # The set value ([]=) method is used to set the value of an attribute with a
+  # given key.
+  #
+  # Creates a new attribute for the given key if needed.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   value = model.set_attribute "testdictionary", "test", 110
+  #   attrdicts = model.attribute_dictionaries
+  #   attrdict = attrdicts["testdictionary"]
+  #   value = attrdict["test2"] = 120
+  #   if (value)
+  #     UI.messagebox value
+  #   end
+  #
+  # @param key
+  #   The valid key.
+  #
+  # @param value
+  #   The value to be set.
+  #
+  # @return value - the value that was set if successful, or false
+  #   if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def []=(key, value)
+  end
+
+  # The count method is inherited from the Enumerable mix-in module.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionary = model.attribute_dictionary('Example')
+  #   number = dictionary.count
+  #
+  # @return [Integer] the size of the attribute dictionary.
+  #
+  # @version SketchUp 2014
+  def count
+  end
+
+  # The delete_key method is used to delete an attribute with a given key.
+  #
+  # @example
+  #   create_if_nil = true
+  #   model = Sketchup.active_model
+  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict["attr_one"] = "one"
+  #   attrdict["attr_two"] = "two"
+  #
+  #   # Gets an array of values
+  #   attrdict = model.attribute_dictionaries['test_dict']
+  #   value = attrdict.delete_key("attr_one")
+  #
+  # @param key
+  #   The key to be deleted.
+  #
+  # @return value - the value of the key
+  #
+  # @version SketchUp 6.0
+  def delete_key(key)
+  end
+
+  # An alias for each. See AttributeDictionary.each.
+  #
+  # Throws an exception if there are no keys.
+  #
+  # @example
+  #   create_if_nil = true
+  #   model = Sketchup.active_model
+  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict["attr_one"] = "one"
+  #   attrdict["attr_two"] = "two"
+  #
+  #   # iterates through all attributes and prints the key to the screen
+  #   attrdict = model.attribute_dictionaries['test_dict']
+  #   attrdict.each_pair { | key, value |
+  #     UI.messagebox key.to_s + '=' + value.to_s
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key, value] @yieldparam key           The key of each attribute as it is found.
+  #   @yieldparam value         The value of each attribute as it is found.
+  def each
+  end
+
+  # The each_key method is used to iterate through all of the attribute keys.
+  # This is the same method as AttributeDictionary.each.
+  #
+  # Throws an exception if there are no keys.
+  #
+  # @example
+  #   create_if_nil = true
+  #   model = Sketchup.active_model
+  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict["attr_one"] = "one"
+  #   attrdict["attr_two"] = "two"
+  #
+  #   # iterates through all attributes and prints the key to the screen
+  #   attrdict = model.attribute_dictionaries['test_dict']
+  #   attrdict.each_key { | key | UI.messagebox key }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key] A variable that will hold each key as they are found.
+  def each_key
+  end
+
+  # An alias for each. See AttributeDictionary.each.
+  #
+  # Throws an exception if there are no keys.
+  #
+  # @example
+  #   create_if_nil = true
+  #   model = Sketchup.active_model
+  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict["attr_one"] = "one"
+  #   attrdict["attr_two"] = "two"
+  #
+  #   # iterates through all attributes and prints the key to the screen
+  #   attrdict = model.attribute_dictionaries['test_dict']
+  #   attrdict.each_pair { | key, value |
+  #     UI.messagebox key.to_s + '=' + value.to_s
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key, value] @yieldparam key           The key of each attribute as it is found.
+  #   @yieldparam value         The value of each attribute as it is found.
+  def each_pair
+  end
+
+  # The keys method is used to retrieve an array with all of the attribute keys.
+  #
+  # @example
+  #   create_if_nil = true
+  #   model = Sketchup.active_model
+  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict["attr_one"] = "one"
+  #   attrdict["attr_two"] = "two"
+  #
+  #   # Gets an array of keys
+  #   attrdict = model.attribute_dictionaries['test_dict']
+  #   keys = attrdict.keys
+  #
+  # @return keys - an array of keys within the attribute dictionary
+  #   if successful
+  #
+  # @version SketchUp 6.0
+  def keys
+  end
+
+  # The {#length} method is used to retrieve the size (number of elements) of an
+  # attribute dictionary.
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionary = model.attribute_dictionary('Example')
+  #   number = dictionary.length
+  #
+  # @return [Integer] the size of the attribute dictionary if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def length
+  end
+
+  # The name method is used to retrieve the name of an attribute dictionary.
+  #
+  # @example
+  #   create_if_nil = true
+  #   model = Sketchup.active_model
+  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict["attr_one"] = "one"
+  #   attrdict["attr_two"] = "two"
+  #
+  #   # Show the name.
+  #   UI.messagebox attrdict.name
+  #
+  # @return name - the name of the attribute dictionary if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def name
+  end
+
+  # The {#length} method is used to retrieve the size (number of elements) of an
+  # attribute dictionary.
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionary = model.attribute_dictionary('Example')
+  #   number = dictionary.length
+  #
+  # @return [Integer] the size of the attribute dictionary if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def size
+  end
+
+  # The values method is used to retrieve an array with all of the attribute
+  # values.
+  #
+  # @example
+  #   create_if_nil = true
+  #   model = Sketchup.active_model
+  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict["attr_one"] = "one"
+  #   attrdict["attr_two"] = "two"
+  #
+  #   # Gets an array of values
+  #   attrdict = model.attribute_dictionaries['test_dict']
+  #   values = attrdict.values
+  #
+  # @return keys - an array of keys within the attribute dictionary
+  #   if successful
+  #
+  # @version SketchUp 6.0
+  def values
+  end
+
+end

data/SketchUp/Sketchup/Axes.rb

@@ -0,0 +1,149 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# SketchUp's drawing axes consist of three colored lines (red, green, blue),
+# usually perpendicular to each other, displayed in the drawing area. The
+# exception is when the user open an instance with a non-orthogonal
+# transformation. The root model transformation is always orthogonal.
+#
+# The drawing axes are used by drawing tools to align the geometry it creates
+# as well as affecting the inference engine.
+#
+# The plane where the red and green axes lines lie is called the ground plane.
+# The term origin, is used to define the place where all of axes lines start or
+# originate.
+#
+# @version SketchUp 2016
+class Sketchup::Axes < Sketchup::Entity
+
+  # Instance Methods
+
+  # The axes method returns the vectors representing the directions of the axes.
+  #
+  # @example
+  #   xaxis, yaxis, zaxis = Sketchup.active_model.axes.axes
+  #
+  # @return Array - an array of three vectors.
+  #
+  # @version SketchUp 2016
+  def axes
+  end
+
+  # The origin method returns the origin of the axes.
+  #
+  # @example
+  #   point = Sketchup.active_model.axes.origin
+  #
+  # @return Point3d - the origin for the axes.
+  #
+  # @version SketchUp 2016
+  def origin
+  end
+
+  # The set method allows the axes to be manipulated. The axes must always be
+  # orthogonal, otherwise an error is thrown.
+  #
+  # @example
+  #   xaxis = Geom::Vector3d.new(3, 5, 0)
+  #   yaxis = xaxis * Z_AXIS
+  #   Sketchup.active_model.axes.set([10,0,0], xaxis, yaxis, Z_AXIS)
+  #
+  # @param origin
+  #   Point3d - The origin to set.
+  #
+  # @param xaxis
+  #   Vector3d - The x axis to set.
+  #
+  # @param zaxis
+  #   Vector3d - The z axis to set.
+  #
+  # @param yaxis
+  #   Vector3d - The y axis to set.
+  #
+  # @return Axes - the axes object being set.
+  #
+  # @version SketchUp 2016
+  def set(origin, xaxis, yaxis, zaxis)
+  end
+
+  # The sketch_plane method returns a plane representing the ground plane of the
+  # axes.
+  #
+  # @example
+  #   plane = Sketchup.active_model.axes.sketch_plane
+  #
+  # @return Array - of 4 numbers that give the coefficients of a
+  #   plane equation.
+  #
+  # @version SketchUp 2016
+  def sketch_plane
+  end
+
+  # The axes method returns the origin and vectors representing the axes.
+  #
+  # @example
+  #   point, xaxis, yaxis, zaxis = Sketchup.active_model.axes.to_a
+  #
+  # @return Array - an array of a point and three vectors.
+  #
+  # @version SketchUp 2016
+  def to_a
+  end
+
+  # The transformation method returns the transformation of the axes. This is
+  # useful when creating tools that respect the model's drawing axes.
+  #
+  # @example
+  #   # Point for a rectangle.
+  #   points = [
+  #     Geom::Point3d.new( 0,  0, 0),
+  #     Geom::Point3d.new(10,  0, 0),
+  #     Geom::Point3d.new(10, 20, 0),
+  #     Geom::Point3d.new( 0, 20, 0)
+  #   ]
+  #   # Transform the points so they are local to the model axes. Otherwise
+  #   # they would be local to the model origin.
+  #   tr = Sketchup.active_model.axes.transformation
+  #   points.each { |point| point.transform!(tr) }
+  #   Sketchup.active_model.active_entities.add_face(points)
+  #
+  # @return Transformation - the transformation for the axes.
+  #
+  # @version SketchUp 2016
+  def transformation
+  end
+
+  # The xaxis method returns the x axis of the axes.
+  #
+  # @example
+  #   vector = Sketchup.active_model.axes.xaxis
+  #
+  # @return Vector3d - the x axis for the axes.
+  #
+  # @version SketchUp 2016
+  def xaxis
+  end
+
+  # The yaxis method returns the y axis of the axes.
+  #
+  # @example
+  #   vector = Sketchup.active_model.axes.yaxis
+  #
+  # @return Vector3d - the y axis for the axes.
+  #
+  # @version SketchUp 2016
+  def yaxis
+  end
+
+  # The zaxis method returns the z axis of the axes.
+  #
+  # @example
+  #   vector = Sketchup.active_model.axes.zaxis
+  #
+  # @return Vector3d - the z axis for the axes.
+  #
+  # @version SketchUp 2016
+  def zaxis
+  end
+
+end