sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/Dimension.rb

@@ -0,0 +1,167 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Dimension class provides base functionality for classes DimensionLinear
+# and DimensionRadial. It's not instantiable.
+#
+# @version SketchUp 2014
+class Sketchup::Dimension < Sketchup::Drawingelement
+
+  # Constants
+
+  ARROW_CLOSED = nil # Stub value.
+  ARROW_DOT = nil # Stub value.
+  ARROW_NONE = nil # Stub value.
+  ARROW_OPEN = nil # Stub value.
+  ARROW_SLASH = nil # Stub value.
+
+  # Instance Methods
+
+  # The add_observer method is used to add a DimensionObserver to the dimension.
+  #
+  # @example
+  #   observer = MyDimObserver.new
+  #   dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
+  #         [100, 10, 0], [0, 20, 0])
+  #   status = dim.add_observer(observer)
+  #
+  # @note If the given observer responds to +onTextChanged+, it will be
+  #   added as a {Sketchup::DimensionObserver}. If not, the base
+  #   {Sketchup::Entity#add_observer} will be called.
+  #
+  # @param observer
+  #   A DimensionObserver.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 2014
+  def add_observer(observer)
+  end
+
+  # The arrow_type method retrieves the current arrow type of the dimension.
+  # Valid arrow types are class constants:
+  # - +Dimension::ARROW_NONE,+
+  # - +Dimension::ARROW_SLASH+
+  # - +Dimension::ARROW_DOT+
+  # - +Dimension::ARROW_CLOSED+
+  # - +Dimension::ARROW_OPEN+
+  #
+  # @example
+  #   type = dim.arrow_type
+  #   if type == Sketchup::Dimension::ARROW_CLOSED
+  #     puts "Arrow type is closed"
+  #   end
+  #
+  # @return a numerical representation of the arrow type
+  #
+  # @version SketchUp 2014
+  def arrow_type
+  end
+
+  # The arrow_type= method sets the arrow type of the dimension.
+  # Valid arrow types are class constants:
+  # - +Dimension::ARROW_NONE,+
+  # - +Dimension::ARROW_SLASH+
+  # - +Dimension::ARROW_DOT+
+  # - +Dimension::ARROW_CLOSED+
+  # - +Dimension::ARROW_OPEN+
+  #
+  # @example
+  #   dim.arrow_type = Sketchup::Dimension::ARROW_CLOSED
+  #
+  # @param type
+  #   a numerical representation of the arrow type.
+  #
+  # @return the arrow type that was set.
+  #
+  # @version SketchUp 2014
+  def arrow_type=(type)
+  end
+
+  # The has_aligned_text= method accepts true or false indicating whether the
+  # dimension's text is aligned to the dimension or to the screen.
+  #
+  # @example
+  #   dim.has_aligned_text = true
+  #
+  # @param [Boolean] value
+  #
+  # @return the alignment flag that was set
+  #
+  # @version SketchUp 2014
+  def has_aligned_text=(value)
+  end
+
+  # The has_aligned_text method is used to determine whether the dimension's text
+  # is aligned to the dimension or to the screen.
+  #
+  # @example
+  #   aligned = dim.has_aligned_text?
+  #
+  # @return status - true if text is aligned to the dimension.
+  #   False if dimension text is aligned to the screen.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2014
+  def has_aligned_text?
+  end
+
+  # The plane method is used to retrieve the plane of the dimension. Refer to the
+  # Geom module for information on how planes are represented.
+  #
+  # @example
+  #   plane = dim.plane
+  #
+  # @return the plane of the dimension
+  #
+  # @version SketchUp 2014
+  def plane
+  end
+
+  # The remove_observer method is used to remove a DimensionObserver from the
+  # dimension. Note that, if the given observer responds to 'onTextChanged', it
+  # will be removed as a DimensionObserver. If not, the base
+  # Entity.remove_observer will be called.
+  #
+  # @example
+  #   observer = MyDimObserver.new
+  #   dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
+  #         [100, 10, 0], [0, 20, 0])
+  #   status = dim.add_observer(observer)
+  #   status = dim.remove_observer(observer)
+  #
+  # @param observer
+  #   A DimensionObserver.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 2014
+  def remove_observer(observer)
+  end
+
+  # The text method is used to retrieve the dimension text.
+  #
+  # @example
+  #   dimtext = dim.text
+  #
+  # @return the dimension text
+  #
+  # @version SketchUp 2014
+  def text
+  end
+
+  # The text= method is used to set an override on the dimension text.
+  #
+  # @example
+  #   dim.text= "text"
+  #
+  # @param [String] text
+  #
+  # @return the newly set text override
+  #
+  # @version SketchUp 2014
+  def text=(text)
+  end
+
+end

data/SketchUp/Sketchup/DimensionLinear.rb

@@ -0,0 +1,232 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The DimensionLinear class represents linear dimensions.
+#
+# @version SketchUp 2014
+class Sketchup::DimensionLinear < Sketchup::Dimension
+
+  # Constants
+
+  ALIGNED_TEXT_ABOVE = nil # Stub value.
+  ALIGNED_TEXT_CENTER = nil # Stub value.
+  ALIGNED_TEXT_OUTSIDE = nil # Stub value.
+
+  TEXT_CENTERED = nil # Stub value.
+  TEXT_OUTSIDE_END = nil # Stub value.
+  TEXT_OUTSIDE_START = nil # Stub value.
+
+  # Instance Methods
+
+  # The aligned_text_position method returns the text position for dimensions
+  # with aligned text (i.e. has_aligned_text? returns true).
+  # Valid values are class constants:
+  # - DimensionLinear::ALIGNED_TEXT_ABOVE
+  # - DimensionLinear::ALIGNED_TEXT_CENTER
+  # - DimensionLinear::ALIGNED_TEXT_OUTSIDE
+  #
+  # @example
+  #   pos = dim.aligned_text_position
+  #   if pos == Sketchup::DimensionLinear::ALIGNED_TEXT_ABOVE
+  #     puts 'Text is above'
+  #   elsif pos == Sketchup::DimensionLinear::ALIGNED_TEXT_CENTER
+  #     puts 'Text is centered'
+  #   elsif pos == Sketchup::DimensionLinear::ALIGNED_TEXT_OUTSIDE
+  #     puts 'Text is outside'
+  #   end
+  #
+  # @return an integer specifying the text position
+  #
+  # @version SketchUp 2014
+  def aligned_text_position
+  end
+
+  # The aligned_text_position= method is used to set the text position for
+  # dimensions with aligned text (i.e. has_aligned_text? returns true).
+  # Valid values are class constants:
+  # - DimensionLinear::ALIGNED_TEXT_ABOVE
+  # - DimensionLinear::ALIGNED_TEXT_CENTER
+  # - DimensionLinear::ALIGNED_TEXT_OUTSIDE
+  #
+  # @example
+  #   dim.aligned_text_position = Sketchup::DimensionLinear::ALIGNED_TEXT_CENTER
+  #
+  # @param pos
+  #   an integer specifying the text position
+  #
+  # @return the text position that was set.
+  #
+  # @version SketchUp 2014
+  def aligned_text_position=(pos)
+  end
+
+  # The end method returns the point or entity the dimension is referencing at
+  # its end.
+  #
+  # @example
+  #   arr = dim.end
+  #   if arr[0].nil?
+  #     puts "No attached entity. Point is #{arr[1]}"
+  #   else
+  #     puts "Attached entity: #{arr[0]}, at point #{arr[1]}"
+  #   end
+  #
+  # @return Array - An array of size 2:
+  #   - Entity being referenced or nil if not associated.
+  #   - Point3d that contains the referenced location.
+  #
+  # @version SketchUp 2014
+  def end
+  end
+
+  # The end= method is used to set the end point of the dimension and/or the
+  # entity it is referencing.
+  #
+  # @example
+  #   # Reference a point
+  #   dim.end = [50, 10, 0]
+  #   # Reference end vertex of an edge
+  #   dim.end = edge.end
+  #   # Attach to an edge's midpoint
+  #   p0 = edge.start.position
+  #   p1 = edge.end.position
+  #   mp = Geom::Point3d.new((p0.x+p1.x)/2.0, (p0.y+p1.y)/2.0, (p0.z+p1.z)/2.0)
+  #   dim.end = [edge, mp]
+  #
+  # @param pt_or_entity
+  #   This parameter can take several forms:
+  #   - an InputPoint
+  #   - a Point3d
+  #   - a Vertex
+  #   - a ConstructionPoint
+  #   - an array of size 2: [Edge, Point3d along the edge]
+  #   - an array of size 2: [ConstructionLine, Point3d along the line]
+  #
+  # @return self
+  #
+  # @version SketchUp 2014
+  def end=(pt_or_entity)
+  end
+
+  # The offset_vector method returns the parallel offset vector from the
+  # reference line to the dimension line measured from the 'start' reference
+  # point.
+  #
+  # @example
+  #   vec = dim.offset_vector
+  #   puts "Offset vector is #{vec.to_s}"
+  #
+  # @return offset vector as a Vector3d
+  #
+  # @version SketchUp 2014
+  def offset_vector
+  end
+
+  # The offset_vector= method is used to set the parallel offset vector from the
+  # reference line to the dimension line measured from the 'start' reference
+  # point.
+  #
+  # @example
+  #   dim.offset_vector = Geom::Vector3d.new(0, 0, 10)
+  #   # or
+  #   dim.offset_vector = [0, 0, 10]
+  #
+  # @param vec
+  #   the offset vector to be set, either a Vector3d or in
+  #   array form.
+  #
+  # @return the offset vector that was set
+  #
+  # @version SketchUp 2014
+  def offset_vector=(vec)
+  end
+
+  # The start method returns the point or entity the dimension is referencing at
+  # its start.
+  #
+  # @example
+  #   arr = dim.start
+  #   if arr[0].nil?
+  #     puts "No attached entity. Point is #{arr[1]}"
+  #   else
+  #     puts "Attached entity: #{arr[0]}, at point #{arr[1]}"
+  #   end
+  #
+  # @return Array - An array of size 2:
+  #   - Entity being referenced or nil if not associated.
+  #   - Point3d that contains the referenced location.
+  #
+  # @version SketchUp 2014
+  def start
+  end
+
+  # The start= method is used to set the start point of the dimension and/or
+  # the entity it is referencing.
+  #
+  # @example
+  #   # Reference a point
+  #   dim.start = [50, 10, 0]
+  #   # Reference end vertex of an edge
+  #   dim.start = edge.end
+  #   # Attach to an edge's midpoint
+  #   p0 = edge.start.position
+  #   p1 = edge.end.position
+  #   mp = Geom::Point3d.new((p0.x+p1.x)/2.0, (p0.y+p1.y)/2.0, (p0.z+p1.z)/2.0)
+  #   dim.start = [edge, mp]
+  #
+  # @param pt_or_entity
+  #   This parameter can take several forms:
+  #   - an InputPoint
+  #   - a Point3d
+  #   - a Vertex
+  #   - a ConstructionPoint
+  #   - an array of size 2: [Edge, Point3d along the edge]
+  #   - an array of size 2: [ConstructionLine, Point3d along the line]
+  #
+  # @return self
+  #
+  # @version SketchUp 2014
+  def start=(pt_or_entity)
+  end
+
+  # The text_position method returns the position of the text along the dimension
+  # line. Valid values are class constants:
+  # - DimensionLinear::TEXT_OUTSIDE_START
+  # - DimensionLinear::TEXT_CENTERED
+  # - DimensionLinear::TEXT_OUTSIDE_END
+  #
+  # @example
+  #   pos = dim.text_position
+  #   if pos == Sketchup::DimensionLinear::TEXT_OUTSIDE_START
+  #     puts 'Text position is Outside start'
+  #   elsif pos == Sketchup::DimensionLinear::TEXT_CENTERED
+  #     puts 'Text position is Centered'
+  #   elsif pos == Sketchup::DimensionLinear::TEXT_OUTSIDE_END
+  #     puts 'Text position is Outside end'
+  #   end
+  #
+  # @return an integer specifying the text position
+  #
+  # @version SketchUp 2014
+  def text_position
+  end
+
+  # The text_position= method is used to set the position of the text along the
+  # dimension line. Valid values are class constants:
+  # - DimensionLinear::TEXT_OUTSIDE_START
+  # - DimensionLinear::TEXT_CENTERED
+  # - DimensionLinear::TEXT_OUTSIDE_END
+  #
+  # @example
+  #   dim.text_position = Sketchup::DimensionLinear::TEXT_CENTERED
+  #
+  # @param pos
+  #   an integer specifying the text position
+  #
+  # @return the text position that was set.
+  #
+  # @version SketchUp 2014
+  def text_position=(pos)
+  end
+
+end

data/SketchUp/Sketchup/DimensionObserver.rb

@@ -0,0 +1,38 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to changes in dimension text.
+#
+# @example
+#   # This is an example of a DimensionObserver
+#   class MyDimensionObserver < Sketchup::DimensionObserver
+#     def onTextChanged(dimension)
+#       puts "onTextChanged: #{dimension}, new_text= #{dimension.text}"
+#     end
+#   end
+#
+#   # Attach the observer. (Assumes there is a dimension in the model root.)
+#   dim = Sketchup.active_model.entities.grep(Sketchup::Dimension).first
+#   dim.add_observer(MyDimensionObserver.new)
+#
+# @version SketchUp 2014
+class Sketchup::DimensionObserver
+
+  # Instance Methods
+
+  # The {#onTextChanged} method is invoked when your entity is erased.
+  #
+  # @example
+  #   def onTextChanged(dimension)
+  #     puts "onTextChanged: #{dimension}, new_text= #{dimension.text}"
+  #   end
+  #
+  # @param [Sketchup::Dimension] dimension
+  #   The dimension object whose text has
+  #   been changed.
+  #
+  # @version SketchUp 2014
+  def onTextChanged(dimension)
+  end
+
+end

data/SketchUp/Sketchup/DimensionRadial.rb

@@ -0,0 +1,87 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The DimensionRadial class represents radius and diameter dimensions on
+# arcs and circles.
+#
+# @version SketchUp 2014
+class Sketchup::DimensionRadial < Sketchup::Dimension
+
+  # Instance Methods
+
+  # The arc_curve method returns the ArcCurve object to which this dimension is
+  # attached.
+  #
+  # @example
+  #   arc = dim.arc_curve
+  #
+  # @return The ArcCurve object to which the dimension is attached.
+  #
+  # @version SketchUp 2014
+  def arc_curve
+  end
+
+  # The arc_curve= method is used to set the ArcCurve object to which this
+  # dimension is attached.
+  #
+  # @example
+  #   dim.arc_curve = arc
+  #
+  # @param arc_curve
+  #   The ArcCurve object to which the dimension is to be
+  #   attached.
+  #
+  # @return The ArcCurve object to which the dimension was attached.
+  #
+  # @version SketchUp 2014
+  def arc_curve=(arc_curve)
+  end
+
+  # The leader_break_point method returns the break point on the leader where the
+  # dimension text is attached.
+  #
+  # @example
+  #   pt = dim.leader_break_point
+  #   puts "Break point is #{pt}"
+  #
+  # @return the leader break point
+  #
+  # @version SketchUp 2014
+  def leader_break_point
+  end
+
+  # The leader_break_point= method is used to set the break point on the leader
+  # where the dimension text is attached.
+  #
+  # @example
+  #   dim.leader_break_point = [10, 0, 0]
+  #
+  # @param point
+  #   the point to be set
+  #
+  # @return the point that was set
+  #
+  # @version SketchUp 2014
+  def leader_break_point=(point)
+  end
+
+  # The leader_points method returns the 3 significant points along the dimension
+  # line in world coordinates.
+  #
+  # @example
+  #   pts = dim.leader_points
+  #   puts "Break point is #{pts[0]}"
+  #   puts "Attach point is #{pts[1]}"
+  #   puts "Opposite point is #{pts[2]}"
+  #
+  # @return Array of 3 Point3d objects. Point 0: leader break point,
+  #   where the text extension attaches. Point 1: attach point,
+  #   where leader touches the arc/circle. Point 2: opposite
+  #   point, where the diameter leader touches the circle on
+  #   the opposite side.
+  #
+  # @version SketchUp 2014
+  def leader_points
+  end
+
+end