sketchup-api-stubs 0.7.4 → 0.7.8

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

@@ -1,32 +1,32 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# A construction point represents a point in the model that can be used to aid
-# in other modeling operations. For example, you may put a construction point
-# at the center of a circle to make it easier to locate that point for
-# performing other operations.
-#
-# @version SketchUp 6.0
-class Sketchup::ConstructionPoint < Sketchup::Drawingelement
-
-  # Instance Methods
-
-  # The position method is used to retrieve a Point3d used to create a
-  # construction point.
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   entities = model.active_entities
-  #   point1 = Geom::Point3d.new(10,0,0)
-  #   constpoint = entities.add_cpoint point1
-  #   # Returns 10,0,0
-  #   position = constpoint.position
-  #
-  # @return point - the Point3d object used to create the
-  #   ConstructionPoint
-  #
-  # @version SketchUp 6.0
-  def position
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# A construction point represents a point in the model that can be used to aid
+# in other modeling operations. For example, you may put a construction point
+# at the center of a circle to make it easier to locate that point for
+# performing other operations.
+#
+# @version SketchUp 6.0
+class Sketchup::ConstructionPoint < Sketchup::Drawingelement
+
+  # Instance Methods
+
+  # The position method is used to retrieve a Point3d used to create a
+  # construction point.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   point1 = Geom::Point3d.new(10,0,0)
+  #   constpoint = entities.add_cpoint point1
+  #   # Returns 10,0,0
+  #   position = constpoint.position
+  #
+  # @return point - the Point3d object used to create the
+  #   ConstructionPoint
+  #
+  # @version SketchUp 6.0
+  def position
+  end
+
+end

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

@@ -1,194 +1,201 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The Curve class is used by SketchUp to unite a series of Edge objects into
-# one conceptual entity. Since SketchUp is a surface modeler, all circles,
-# arcs, and arbitrary curves are really just edges that are bound together in
-# sequence.
-#
-# There is a subclass of Curve called ArcCurve, which is any curve that makes
-# up part of a circle. You can think of ArcCurves as entities that were created
-# with SketchUp's Arc or Circle drawing tools and Curves as entities that were
-# created with the Freehand drawing tool.
-#
-# @version SketchUp 6.0
-class Sketchup::Curve < Sketchup::Entity
-
-  # Instance Methods
-
-  # The count_edges method is used to retrieve the number of Edge objects that
-  # make up the Curve.
-  #
-  # @example
-  #   centerpoint = Geom::Point3d.new
-  #   # Create a circle perpendicular to the normal or Z axis
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = vector.normalize!
-  #   model = Sketchup.active_model
-  #   entities = model.entities
-  #   edgearray = entities.add_circle centerpoint, vector2, 10
-  #   edge = edgearray[0]
-  #   curve = edge.curve
-  #   number = curve.count_edges
-  #
-  # @return num_edges - the number of edges in the curve
-  #
-  # @version SketchUp 6.0
-  def count_edges
-  end
-
-  # The each_edge method is used to iterate through all of the Edge objects in
-  # the curve.
-  #
-  # @example
-  #   centerpoint = Geom::Point3d.new
-  #   # Create a circle perpendicular to the normal or Z axis
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = vector.normalize!
-  #   model = Sketchup.active_model
-  #   entities = model.entities
-  #   edgearray = entities.add_circle centerpoint, vector2, 10
-  #   edge = edgearray[0]
-  #   curve = edge.curve
-  #   curve.each_edge {|e| UI.messagebox e}
-  #
-  # @return edge - a variable that will hold each Edge object as
-  #   they are found.
-  #
-  # @version SketchUp 6.0
-  def each_edge
-  end
-
-  # The edges method is used to retrieve an array of Edge objects that make up
-  # the Curve.
-  #
-  # @example
-  #   centerpoint = Geom::Point3d.new
-  #   # Create a circle perpendicular to the normal or Z axis
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = vector.normalize!
-  #   model = Sketchup.active_model
-  #   entities = model.entities
-  #   edgearray = entities.add_circle centerpoint, vector2, 10
-  #   edge = edgearray[0]
-  #   curve = edge.curve
-  #   edges = curve.edges
-  #
-  # @return edges - an array of Edge objects if successful
-  #
-  # @version SketchUp 6.0
-  def edges
-  end
-
-  # The first_edge method is used to retrieve the first edge of the curve.
-  #
-  # @example
-  #   centerpoint = Geom::Point3d.new
-  #   # Create a circle perpendicular to the normal or Z axis
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = vector.normalize!
-  #   model = Sketchup.active_model
-  #   entities = model.entities
-  #   edgearray = entities.add_circle centerpoint, vector2, 10
-  #   edge = edgearray[0]
-  #   curve = edge.curve
-  #   firstedge = curve.first_edge
-  #
-  # @return edge - the first Edge object in the curve if successful
-  #
-  # @version SketchUp 6.0
-  def first_edge
-  end
-
-  #
-  # @example
-  #   # Create a polygon and check its edge
-  #   ents = Sketchup.active_model.entities
-  #   ents.add_ngon [0, 0, 0], [0, 0, 1], 10, 6
-  #   curve = nil
-  #   ents.each { |e| curve = e.curve if e.is_a? Sketchup::Edge }
-  #   is_poly = curve.is_polygon?
-  #
-  # @return [Boolean] True if this edge was originally created by the polygon
-  #   tool, otherwise false.
-  #
-  # @version SketchUp 7.1 M1
-  def is_polygon?
-  end
-
-  # The last_edge method is used to retrieve the last edge of the curve.
-  #
-  # @example
-  #   centerpoint = Geom::Point3d.new
-  #   # Create a circle perpendicular to the normal or Z axis
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = vector.normalize!
-  #   model = Sketchup.active_model
-  #   entities = model.entities
-  #   edgearray = entities.add_circle centerpoint, vector2, 10
-  #   edge = edgearray[7]
-  #   curve = edge.curve
-  #   lastedge = curve.last_edge
-  #
-  # @return edge - the last Edge object in the curve if successful
-  #
-  # @version SketchUp 6.0
-  def last_edge
-  end
-
-  # The length method retrieves the length of the curve.
-  #
-  # @example
-  #   centerpoint = Geom::Point3d.new
-  #   # Create a circle perpendicular to the normal or Z axis
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = vector.normalize!
-  #   model = Sketchup.active_model
-  #   entities = model.entities
-  #   edgearray = entities.add_circle centerpoint, vector2, 10
-  #   edge = edgearray[7]
-  #   curve = edge.curve
-  #   length = curve.length
-  #
-  # @return length - the length of the curve in current units if
-  #   successful
-  #
-  # @version SketchUp 6.0
-  def length
-  end
-
-  # The vertices method retrieves a collection of all vertices in a curve.
-  #
-  # @example
-  #   # Need example ruby code here.
-  #
-  # @param point_array
-  #   Array of Point3d objects to move each vertex to match.
-  #
-  # @return success - true or false
-  #
-  # @version SketchUp 6.0
-  def move_vertices(point_array)
-  end
-
-  # The vertices method retrieves a collection of all vertices in a curve.
-  #
-  # @example
-  #   centerpoint = Geom::Point3d.new
-  #   # Create a circle perpendicular to the normal or Z axis
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = vector.normalize!
-  #   model = Sketchup.active_model
-  #   entities = model.entities
-  #   edgearray = entities.add_circle centerpoint, vector2, 10
-  #   edge = edgearray[7]
-  #   curve = edge.curve
-  #   vertices = curve.vertices
-  #
-  # @return vertices - a collection of the vertices
-  #
-  # @version SketchUp 6.0
-  def vertices
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Curve class is used by SketchUp to unite a series of Edge objects into
+# one conceptual entity. Since SketchUp is a surface modeler, all circles,
+# arcs, and arbitrary curves are really just edges that are bound together in
+# sequence.
+#
+# There is a subclass of Curve called ArcCurve, which is any curve that makes
+# up part of a circle. You can think of ArcCurves as entities that were created
+# with SketchUp's Arc or Circle drawing tools and Curves as entities that were
+# created with the Freehand drawing tool.
+#
+# @version SketchUp 6.0
+class Sketchup::Curve < Sketchup::Entity
+
+  # Instance Methods
+
+  # The count_edges method is used to retrieve the number of Edge objects that
+  # make up the Curve.
+  #
+  # @example
+  #   centerpoint = Geom::Point3d.new
+  #   # Create a circle perpendicular to the normal or Z axis
+  #   vector = Geom::Vector3d.new 0,0,1
+  #   vector2 = vector.normalize!
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   edgearray = entities.add_circle centerpoint, vector2, 10
+  #   edge = edgearray[0]
+  #   curve = edge.curve
+  #   number = curve.count_edges
+  #
+  # @return num_edges - the number of edges in the curve
+  #
+  # @version SketchUp 6.0
+  def count_edges
+  end
+
+  # The each_edge method is used to iterate through all of the Edge objects in
+  # the curve.
+  #
+  # @example
+  #   centerpoint = Geom::Point3d.new
+  #   # Create a circle perpendicular to the normal or Z axis
+  #   vector = Geom::Vector3d.new 0,0,1
+  #   vector2 = vector.normalize!
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   edgearray = entities.add_circle centerpoint, vector2, 10
+  #   edge = edgearray[0]
+  #   curve = edge.curve
+  #   curve.each_edge {|edge| puts "Edge {edge.entityID}: {edge.length}" }
+  #
+  # @return edge - a variable that will hold each Edge object as
+  #   they are found.
+  #
+  # @version SketchUp 6.0
+  def each_edge
+  end
+
+  # The edges method is used to retrieve an array of Edge objects that make up
+  # the Curve.
+  #
+  # @example
+  #   centerpoint = Geom::Point3d.new
+  #   # Create a circle perpendicular to the normal or Z axis
+  #   vector = Geom::Vector3d.new 0,0,1
+  #   vector2 = vector.normalize!
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   edgearray = entities.add_circle centerpoint, vector2, 10
+  #   edge = edgearray[0]
+  #   curve = edge.curve
+  #   edges = curve.edges
+  #
+  # @return edges - an array of Edge objects if successful
+  #
+  # @version SketchUp 6.0
+  def edges
+  end
+
+  # The first_edge method is used to retrieve the first edge of the curve.
+  #
+  # @example
+  #   centerpoint = Geom::Point3d.new
+  #   # Create a circle perpendicular to the normal or Z axis
+  #   vector = Geom::Vector3d.new 0,0,1
+  #   vector2 = vector.normalize!
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   edgearray = entities.add_circle centerpoint, vector2, 10
+  #   edge = edgearray[0]
+  #   curve = edge.curve
+  #   firstedge = curve.first_edge
+  #
+  # @return edge - the first Edge object in the curve if successful
+  #
+  # @version SketchUp 6.0
+  def first_edge
+  end
+
+  #
+  # @example
+  #   # Create a polygon and check its edge
+  #   ents = Sketchup.active_model.entities
+  #   ents.add_ngon [0, 0, 0], [0, 0, 1], 10, 6
+  #   curve = nil
+  #   ents.each { |e| curve = e.curve if e.is_a? Sketchup::Edge }
+  #   is_poly = curve.is_polygon?
+  #
+  # @return [Boolean] True if this edge was originally created by the polygon
+  #   tool, otherwise false.
+  #
+  # @version SketchUp 7.1 M1
+  def is_polygon?
+  end
+
+  # The last_edge method is used to retrieve the last edge of the curve.
+  #
+  # @example
+  #   centerpoint = Geom::Point3d.new
+  #   # Create a circle perpendicular to the normal or Z axis
+  #   vector = Geom::Vector3d.new 0,0,1
+  #   vector2 = vector.normalize!
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   edgearray = entities.add_circle centerpoint, vector2, 10
+  #   edge = edgearray[7]
+  #   curve = edge.curve
+  #   lastedge = curve.last_edge
+  #
+  # @return edge - the last Edge object in the curve if successful
+  #
+  # @version SketchUp 6.0
+  def last_edge
+  end
+
+  # The length method retrieves the length of the curve.
+  #
+  # @example
+  #   centerpoint = Geom::Point3d.new
+  #   # Create a circle perpendicular to the normal or Z axis
+  #   vector = Geom::Vector3d.new 0,0,1
+  #   vector2 = vector.normalize!
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   edgearray = entities.add_circle centerpoint, vector2, 10
+  #   edge = edgearray[7]
+  #   curve = edge.curve
+  #   length = curve.length
+  #
+  # @return [Length]
+  #
+  # @version SketchUp 6.0
+  def length
+  end
+
+  # The {#move_vertices} method moves the vertices in the curve to points.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   new_edges = entities.add_arc(ORIGIN, X_AXIS, Z_AXIS, 20.cm, 0, 270.degrees, 32)
+  #   curve = new_edges.first.curve
+  #   points = curve.vertices.map(&:position)
+  #   points.each_with_index { |pt, i| pt.z = i * 1.cm }
+  #   curve.move_vertices(points)
+  #
+  # @param [Array<Geom::Point3d>] point_array
+  #
+  # @raise ArgumentError if the number of points doesn't match number of vertices
+  #   in curve
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def move_vertices(point_array)
+  end
+
+  # The vertices method retrieves a collection of all vertices in a curve.
+  #
+  # @example
+  #   centerpoint = Geom::Point3d.new
+  #   # Create a circle perpendicular to the normal or Z axis
+  #   vector = Geom::Vector3d.new 0,0,1
+  #   vector2 = vector.normalize!
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   edgearray = entities.add_circle centerpoint, vector2, 10
+  #   edge = edgearray[7]
+  #   curve = edge.curve
+  #   vertices = curve.vertices
+  #
+  # @return vertices - a collection of the vertices
+  #
+  # @version SketchUp 6.0
+  def vertices
+  end
+
+end