sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/Tools.rb

@@ -0,0 +1,120 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Tools class contains methods to manipulate a collection of SketchUp
+# tools. You access this collection by calling the Model.tools method.
+#
+# @example
+#   tools = Sketchup.active_model.tools
+#
+# @version SketchUp 6.0
+class Sketchup::Tools
+
+  # Instance Methods
+
+  # The active_tool_id method is used to retrieve the active tool's id.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   id = tools.active_tool_id
+  #
+  # @return id - the active tool's id.
+  #
+  # @version SketchUp 6.0
+  def active_tool_id
+  end
+
+  # The active_tool_name method is used to retrieve the active tool's name.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   if tools.active_tool_id.equal? 0
+  #     puts "Tools collection is empty"
+  #   else
+  #     name = tools.active_tool_name
+  #   end
+  #
+  # @return name = the active tool's name.
+  #
+  # @version SketchUp 6.0
+  def active_tool_name
+  end
+
+  # The add_observer method is used to add an observer to the current object.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   observer = Sketchup::ToolsObserver.new
+  #   status = tools.add_observer observer
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return status - true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def add_observer(observer)
+  end
+
+  # The model method is used to get the model associated with this tools object.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   model = tools.model
+  #
+  # @return model - the Model object associated with this tools
+  #   collection.
+  #
+  # @version SketchUp 6.0
+  def model
+  end
+
+  # The pop_tool method is used to pop the last pushed tool on the tool stack.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   tool = tools.pop_tool
+  #
+  # @return the last pushed Tool object, if it is a Ruby tool. If a
+  #   native tool is active, selects the default native tool
+  #   and returns nil.
+  #
+  # @version SketchUp 6.0
+  def pop_tool
+  end
+
+  # The push_tool method is used to push (aka activate) a user-defined tool.
+  # See the Tool interface for details on creating your own SketchUp tool.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   status = tools.push_tool tool
+  #
+  # @param tool
+  #   A user.
+  #
+  # @return status - true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def push_tool(tool)
+  end
+
+  # The remove_observer method is used to remove an observer from the current
+  # object.
+  #
+  # @example
+  #   tools = Sketchup.active_model.tools
+  #   observer = Sketchup::ToolsObserver.new
+  #   tools.add_observer observer
+  #   status = tools.remove_observer observer
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def remove_observer(observer)
+  end
+
+end

data/SketchUp/Sketchup/ToolsObserver.rb

@@ -0,0 +1,154 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to tool events. To implement
+# this observer, create a Ruby class of this type, override the desired
+# methods, and add an instance of the observer to the {Sketchup::Tools} object.
+#
+# Some of the code below mentions +tool_names+ and +tool_ids+. Here is a list
+# of the common tool IDs and names:
+#
+# - +21013+ = 3DTextTool
+# - +21065+ = ArcTool
+# - +10523+ = CameraDollyTool
+# - +10508+ = CameraOrbitTool
+# - +10525+ = CameraPanTool
+# - +21169+ = PositionCameraTool
+# - +10520+ = CameraWalkTool
+# - +10509+ = CameraZoomTool
+# - +10526+ = CameraZoomWindowTool
+# - +21096+ = CircleTool
+# - +21013+ = ComponentTool
+# - +21126+ = ComponentCSTool
+# - +21410+ = DimensionTool
+# - +21019+ = EraseTool
+# - +21031+ = FreehandTool
+# - +21525+ = ExtrudeTool
+# - +21126+ = SketchCSTool
+# - +21048+ = MoveTool
+# - +21024+ = MeasureTool
+# - +21100+ = OffsetTool
+# - +21074+ = PaintTool
+# - +21013+ = PasteTool
+# - +21095+ = PolyTool
+# - +21515+ = PositionTextureTool
+# - +21041+ = PushPullTool
+# - +21057+ = ProtractorTool
+# - +21094+ = RectangleTool
+# - +21129+ = RotateTool
+# - +21236+ = ScaleTool
+# - +21022+ = SelectionTool
+# - +21337+ = SectionPlaneTool
+# - +21020+ = SketchTool
+# - +21405+ = TextTool
+#
+# @example
+#   # This is an example of an observer that watches tool interactions.
+#   class MyToolsObserver < Sketchup::ToolsObserver
+#     def onActiveToolChanged(tools, tool_name, tool_id)
+#       puts "onActiveToolChanged: #{tool_name}"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   Sketchup.active_model.tools.add_observer(MyToolsObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::ToolsObserver
+
+  # Instance Methods
+
+  # Once you subclass {Sketchup::ToolsObserver} with your unique class, you can
+  # override the {#onActiveToolChanged} method to receive tool change
+  # notifications.
+  #
+  # @example
+  #   def onActiveToolChanged(tools, tool_name, tool_id)
+  #     tool_name = fix_mac_tool_name(tool_name)
+  #     puts "onActiveToolChanged: #{tool_name}"
+  #   end
+  #
+  #   # Returns the "correct" tool name to account for mac API differences.
+  #   #
+  #   #   Args:
+  #   #     tool_name     The tool name to fix
+  #   #
+  #   #   Returns
+  #   #     string   corrected tool name
+  #   def fix_mac_tool_name(tool_name)
+  #     if tool_name == "eTool"
+  #       tool_name = "ScaleTool"
+  #     elsif tool_name == "ool"
+  #       tool_name = "MoveTool"
+  #     elsif tool_name == "onentCSTool"
+  #       tool_name = "ComponentCSTool"
+  #     elsif tool_name == "PullTool"
+  #       tool_name = "PushPullTool"
+  #     end
+  #     return tool_name
+  #   end
+  #
+  # @note In SketchUp 6 and SketchUp 7.0, tool names on the Mac have some of
+  #   their first characters truncated. For instance, on Windows, a tool is
+  #   +"CameraOrbit"+. On the Mac, is comes across as +"raOrbit"+.  Therefore,
+  #   use the +tool_id+ to keep track of which tool you need to watch for, or use
+  #   logic that corrects for the error. There is an example method of one way to
+  #   do this shown below. (This example is not a comprehensive list of the tool
+  #   names.)
+  #
+  # @param [Integer] tool_id
+  #   The ID of the tool. This is a predefined number
+  #   unique to a given tool. For example, the Materials Browser is tool_id
+  #   21074.
+  #
+  # @param [String] tool_name
+  #   The name of the tool.
+  #
+  # @param [Sketchup::Tools] tools
+  #   A Tools object.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onActiveToolChanged(tools, tool_name, tool_id)
+  end
+
+  # The {#onToolStateChanged} method is called each time the user performs an
+  # action with a tool. The actual state that is returned is an internal number
+  # that varies tool to tool. If you want to watch existing tools for every
+  # interaction, you will need to experiment with the tool state to determine
+  # which states you care about. There is little consistency tool to tool.
+  #
+  # @example
+  #   def onToolStateChanged(tools, tool_name, tool_id, tool_state)
+  #     puts "onToolStateChanged: #{tool_name}:#{tool_state}"
+  #   end
+  #
+  # @note In SketchUp 6 and SketchUp 7, tool names on the Mac have their first
+  #   few characters truncated. For instance, on Windows, a tool is
+  #   +"CameraOrbit".+ On the Mac, is comes across as +"raOrbit"+.  Therefore,
+  #   use the tool_id to keep track of which tool you need to watch for, or use
+  #   logic that corrects for the error. This bug was fixed in SketchUp 8.0.
+  #
+  # @param [Integer] tool_state
+  #   A number identifying the state the tool just
+  #   entered.
+  #
+  # @param [Sketchup::Tools] tools
+  #   A Tools object.
+  #
+  # @param [Integer] tool_id
+  #   The ID of the tool. This is a predefined number
+  #   unique to a given tool. For example, the Materials Browser is tool_id
+  #   21074.
+  #
+  # @param [String] tool_name
+  #   The name of the tool.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onToolStateChanged(tools, tool_name, tool_id, tool_state)
+  end
+
+end

data/SketchUp/Sketchup/UVHelper.rb

@@ -0,0 +1,61 @@
+# Copyright:: Copyright 2017 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

data/SketchUp/Sketchup/Vertex.rb

@@ -0,0 +1,143 @@
+# Copyright:: Copyright 2017 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 vertex2
+  #   A Vertex object.
+  #
+  # @return edge - 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
+  #
+  # @return status - true if it is used by exactly two edges which
+  #   are both part of the same curve.
+  #
+  # @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 edges - 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 faces - 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 loops - 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 point - 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 face_or_edge
+  #   A Face or Edge ot test against.
+  #
+  # @return used - true if the Vertex is used in the given entity.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def used_by?(face_or_edge)
+  end
+
+end