sketchup-api-stubs 0.7.4 → 0.7.8

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

@@ -1,61 +1,75 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The UV Helper class contains methods allowing you to determine the location
-# (UV coordinates) of a texture on a face. This class is particularly useful
-# in determining how textures that have been manipulated using the Texture
-# Tweaker should appear when exported to another file type
-#
-# Use the Face.get_UVHelper method to create a UVHelper for a given face.
-# See the TextureWriter class as well.
-#
-# @version SketchUp 6.0
-class Sketchup::UVHelper
-
-  # Instance Methods
-
-  # The get_back_UVQ method is used to get the UV coordinates for the back of a
-  # face.
-  #
-  # @example
-  #   uv_helper = face.get_UVHelper true, true, my_texture_writer
-  #   face.outer_loop.vertices.each do |vert|
-  #     uvq = uv_help.get_back_UVQ(vert.position)
-  #     puts "u=" + uvq.x.to_s + " v=" + uvq.y.to_s
-  #   end
-  #
-  # @param point
-  #   A Point3d object containing one of the 3D vertexes of
-  #   the face.
-  #
-  # @return point - a Point3d containing the UV coordinates where
-  #   the X value is the U value, the Y value is the V value
-  #   and the Z value is a Q value (which is not used).
-  #
-  # @version SketchUp 6.0
-  def get_back_UVQ(point)
-  end
-
-  # The get_front_UVQ method is used to get the UV coordinates for a front of a
-  # face.
-  #
-  # @example
-  #   uv_helper = face.get_UVHelper true, true, my_texture_writer
-  #   face.outer_loop.vertices.each do |vert|
-  #     uvq = uv_helper.get_front_UVQ(vert.position)
-  #     puts "u=" + uvq.x.to_s + " v=" + uvq.y.to_s
-  #   end
-  #
-  # @param point
-  #   A Point3d object containing one of the 3D vertexes of
-  #   the face.
-  #
-  # @return point - a Point3d containing the UV coordinates where
-  #   the X value is the U value, the Y value is the V value
-  #   and the Z value is a Q value (which is not used).
-  #
-  # @version SketchUp 6.0
-  def get_front_UVQ(point)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The UV Helper class contains methods allowing you to determine the location
+# (UV coordinates) of a texture on a face. This class is particularly useful
+# in determining how textures that have been manipulated using the Texture
+# Tweaker should appear when exported to another file type
+#
+# Use the Face.get_UVHelper method to create a UVHelper for a given face.
+# See the TextureWriter class as well.
+#
+# @version SketchUp 6.0
+class Sketchup::UVHelper
+
+  # Instance Methods
+
+  # The {#get_back_UVQ} method is used to get the UV texture coordinates on the
+  # back of a face.
+  #
+  # @example
+  #   uv_helper = face.get_UVHelper(true, true, my_texture_writer)
+  #   face.outer_loop.vertices.each do |vert|
+  #     uvq = uv_helper.get_back_UVQ(vert.position)
+  #     # "Normalize" UVQ to UV.
+  #     # #x, #y and #z corresponds to U, V and Q respectively,
+  #     # as SketchUp re-uses the normal Point3d objects for UVQs
+  #     u = uvq.x / uvq.z
+  #     v = uvq.y / uvq.z
+  #     puts "u=#{u} v=#{v}""
+  #   end
+  #
+  # @note To convert UVQ coordinates to UV,
+  #   divide U and V by Q.
+  #       u = uvq.u / uvq.q
+  #       v = uvq.v / uvq.q
+  #
+  # @param [Geom::Point3d] point
+  #   A point on the face.
+  #
+  # @return [Geom::Point3d] Point where X represents U, Y represents V and Z represents Q.
+  #
+  # @version SketchUp 6.0
+  def get_back_UVQ(point)
+  end
+
+  # The {#get_front_UVQ} method is used to get the UV texture coordinates on the
+  # front of a face.
+  #
+  # @example
+  #   uv_helper = face.get_UVHelper(true, true, my_texture_writer)
+  #   face.outer_loop.vertices.each do |vert|
+  #     uvq = uv_helper.get_front_UVQ(vert.position)
+  #     # "Normalize" UVQ to UV.
+  #     # #x, #y and #z corresponds to U, V and Q respectively,
+  #     # as SketchUp re-uses the normal Point3d objects for UVQs
+  #     u = uvq.x / uvq.z
+  #     v = uvq.y / uvq.z
+  #     puts "u=#{u} v=#{v}""
+  #   end
+  #
+  # @note To convert UVQ coordinates to UV,
+  #   divide U and V by Q.
+  #       u = uvq.u / uvq.q
+  #       v = uvq.v / uvq.q
+  #
+  # @param [Geom::Point3d] point
+  #   A point on the face.
+  #
+  # @return [Geom::Point3d] Point where X represents U, Y represents V and Z represents Q.
+  #
+  # @version SketchUp 6.0
+  def get_front_UVQ(point)
+  end
+
+end

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

@@ -1,142 +1,142 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# A Vertex. A Vertex represents the end of an Edge or a point inside a Face.
-#
-# @version SketchUp 6.0
-class Sketchup::Vertex < Sketchup::Entity
-
-  # Instance Methods
-
-  # The common_edge method is used to find a common edge that is defined by this
-  # vertex and another vertex
-  #
-  # @example
-  #   edge = entities[0]
-  #   # returns array of vertices that make up the line
-  #   verticies = edge.vertices
-  #   vertex1 = verticies[0]
-  #   vertex2 = verticies[1]
-  #   edge = vertex1.common_edge vertex2
-  #   if (edge)
-  #     UI.messagebox edge
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
-  #
-  # @param [Sketchup::Vertex] vertex2
-  #   A Vertex object.
-  #
-  # @return [Sketchup::Edge, nil] an Edge object common to both vertices if
-  #   successful. Returns nil if there is no edge between the
-  #   two vertices.
-  #
-  # @version SketchUp 6.0
-  def common_edge(vertex2)
-  end
-
-  # The {#curve_interior?} method is used to determine if this vertex is on the
-  # interior of a Curve.
-  #
-  # @example
-  #   edge = entities[0]
-  #   # returns array of vertices that make up the line
-  #   verticies = edge.vertices
-  #   vertex1 = verticies[0]
-  #   status = vertex1.curve_interior?
-  #   if (status)
-  #     UI.messagebox status
-  #   else
-  #     #returns nil if vertex is not on interior of a Curve
-  #     UI.messagebox "Failure"
-  #   end
-  #
-  # @note This method doesn't actually return a boolean as the question mark
-  #   post-fix would normally indicate. But the result still evaluates to
-  #   truthy or falsy.
-  #
-  # @return [Boolean]
-  #
-  # @version SketchUp 6.0
-  def curve_interior?
-  end
-
-  # The edges method is used to retrieve an Array of edges that use the Vertex.
-  #
-  # @example
-  #   edge = entities[0]
-  #   # Returns array of vertices that make up the line.
-  #   verticies = edge.vertices
-  #   vertex1 = verticies[0]
-  #   edges = vertex1.edges
-  #
-  # @return [Array<Sketchup::Edge>] an Array of edge objects if successful
-  #
-  # @version SketchUp 6.0
-  def edges
-  end
-
-  # The faces method is used to retrieve an Array of faces that use the vertex.
-  #
-  # @example
-  #   edge = entities[0]
-  #   # Returns array of vertices that make up the line.
-  #   verticies = edge.vertices
-  #   vertex1 = verticies[0]
-  #   faces = vertex1.faces
-  #
-  # @return [Array<Sketchup::Face>] an Array of faces that use the vertex if
-  #   successful
-  #
-  # @version SketchUp 6.0
-  def faces
-  end
-
-  # The loops method is used to retrieve an Array of loops that use the vertex.
-  #
-  # @example
-  #   edge = entities[0]
-  #   # Returns array of vertices that make up the line.
-  #   verticies = edge.vertices
-  #   vertex1 = verticies[0]
-  #   loops = vertex1.loops
-  #
-  # @return [Array<Sketchup::Loop>] an Array of loops that use the vertex if
-  #   successful
-  #
-  # @version SketchUp 6.0
-  def loops
-  end
-
-  # The position method is used to retrieve the Point3d position of a vertex.
-  #
-  # @example
-  #   edge = entities[0]
-  #   # Returns array of vertices that make up the line.
-  #   verticies = edge.vertices
-  #   vertex1 = verticies[0]
-  #   position = vertex1.position
-  #
-  # @return [Geom::Point3d] a Point3d object representing the position of
-  #   the vertex if successful
-  #
-  # @version SketchUp 6.0
-  def position
-  end
-
-  # The used_by? method is used to determine if the Vertex is used by a given
-  # Edge or Face.
-  #
-  # @example
-  #   used = vertex1.used_by? my_face
-  #
-  # @param [Sketchup::Edge, Sketchup::Face] face_or_edge
-  #   A Face or Edge ot test against.
-  #
-  # @return [Boolean]
-  #
-  # @version SketchUp 6.0
-  def used_by?(face_or_edge)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# A Vertex. A Vertex represents the end of an Edge or a point inside a Face.
+#
+# @version SketchUp 6.0
+class Sketchup::Vertex < Sketchup::Entity
+
+  # Instance Methods
+
+  # The common_edge method is used to find a common edge that is defined by this
+  # vertex and another vertex
+  #
+  # @example
+  #   edge = entities[0]
+  #   # returns array of vertices that make up the line
+  #   verticies = edge.vertices
+  #   vertex1 = verticies[0]
+  #   vertex2 = verticies[1]
+  #   edge = vertex1.common_edge vertex2
+  #   if (edge)
+  #     UI.messagebox edge
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param [Sketchup::Vertex] vertex2
+  #   A Vertex object.
+  #
+  # @return [Sketchup::Edge, nil] an Edge object common to both vertices if
+  #   successful. Returns nil if there is no edge between the
+  #   two vertices.
+  #
+  # @version SketchUp 6.0
+  def common_edge(vertex2)
+  end
+
+  # The {#curve_interior?} method is used to determine if this vertex is on the
+  # interior of a Curve.
+  #
+  # @example
+  #   edge = entities[0]
+  #   # returns array of vertices that make up the line
+  #   verticies = edge.vertices
+  #   vertex1 = verticies[0]
+  #   status = vertex1.curve_interior?
+  #   if (status)
+  #     UI.messagebox status
+  #   else
+  #     #returns nil if vertex is not on interior of a Curve
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @note This method doesn't actually return a boolean as the question mark
+  #   post-fix would normally indicate. But the result still evaluates to
+  #   truthy or falsy.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def curve_interior?
+  end
+
+  # The edges method is used to retrieve an Array of edges that use the Vertex.
+  #
+  # @example
+  #   edge = entities[0]
+  #   # Returns array of vertices that make up the line.
+  #   verticies = edge.vertices
+  #   vertex1 = verticies[0]
+  #   edges = vertex1.edges
+  #
+  # @return [Array<Sketchup::Edge>] an Array of edge objects if successful
+  #
+  # @version SketchUp 6.0
+  def edges
+  end
+
+  # The faces method is used to retrieve an Array of faces that use the vertex.
+  #
+  # @example
+  #   edge = entities[0]
+  #   # Returns array of vertices that make up the line.
+  #   verticies = edge.vertices
+  #   vertex1 = verticies[0]
+  #   faces = vertex1.faces
+  #
+  # @return [Array<Sketchup::Face>] an Array of faces that use the vertex if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def faces
+  end
+
+  # The loops method is used to retrieve an Array of loops that use the vertex.
+  #
+  # @example
+  #   edge = entities[0]
+  #   # Returns array of vertices that make up the line.
+  #   verticies = edge.vertices
+  #   vertex1 = verticies[0]
+  #   loops = vertex1.loops
+  #
+  # @return [Array<Sketchup::Loop>] an Array of loops that use the vertex if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def loops
+  end
+
+  # The position method is used to retrieve the Point3d position of a vertex.
+  #
+  # @example
+  #   edge = entities[0]
+  #   # Returns array of vertices that make up the line.
+  #   verticies = edge.vertices
+  #   vertex1 = verticies[0]
+  #   position = vertex1.position
+  #
+  # @return [Geom::Point3d] a Point3d object representing the position of
+  #   the vertex if successful
+  #
+  # @version SketchUp 6.0
+  def position
+  end
+
+  # The used_by? method is used to determine if the Vertex is used by a given
+  # Edge or Face.
+  #
+  # @example
+  #   used = vertex1.used_by? my_face
+  #
+  # @param [Sketchup::Edge, Sketchup::Face] face_or_edge
+  #   A Face or Edge ot test against.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def used_by?(face_or_edge)
+  end
+
+end