sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/ShadowInfoObserver.rb

@@ -0,0 +1,57 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to changes to the shadow
+# settings. 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::ShadowInfo} object.
+#
+# @example
+#   # This is an example of an observer that watches the selection for
+#   # changes.
+#   class MyShadowInfoObserver < Sketchup::ShadowInfoObserver
+#     def onShadowInfoChanged(shadow_info, type)
+#       puts "onShadowInfoChanged: #{type}"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   Sketchup.active_model.shadow_info.add_observer(MyShadowInfoObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::ShadowInfoObserver
+
+  # Instance Methods
+
+  # The {#onShadowInfoChanged} method is invoked whenever the user alters a
+  # setting inside the Shadows and Model Info dialogs. The type parameter
+  # contains a number identifying which option was altered. Here are the types to
+  # expect:
+  #
+  # - 0 = Time/Date sliders
+  # - 1 = Display Shadows checkbox
+  # - 2 = Light/Dark sliders
+  # - 3 = Geographic Location (in Model Info > Location)
+  # - 4 = Solar Orientation (in Model Info > Location)
+  # - 7 = Use Sun for Shading checkbox
+  # - 8 = Display from Edges checkbox
+  # - 9 = Display on Ground checkbox
+  # - 10 = Display on Faces checkbox
+  #
+  # @example
+  #   def onShadowInfoChanged(shadow_info, type)
+  #     puts "onShadowInfoChanged: #{type}"
+  #   end
+  #
+  # @param [Sketchup::ShadowInfo] shadow_info
+  #
+  # @param [Integer] type
+  #   A number identifying which setting was changed.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onShadowInfoChanged(shadow_info, type)
+  end
+
+end

data/SketchUp/Sketchup/Style.rb

@@ -0,0 +1,77 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Style class contains methods for modifying information about a specific
+# style. Styles are a collection of display settings that tell SketchUp how to
+# draw the model.
+#
+# @example
+#   # Get a handle to the styles collection.
+#   styles = Sketchup.active_model.styles
+#
+#   # Display the name of the first style.
+#   first_style = styles[0]
+#   UI.messagebox("Your first style is named " + first_style.name.to_s)
+#
+# @version SketchUp 6.0
+class Sketchup::Style < Sketchup::Entity
+
+  # Instance Methods
+
+  # The description method is used to retrieve the description for a style.
+  #
+  # @example
+  #   style = Sketchup.active_model.styles[0]
+  #   UI.messagebox("Your first style description is: " +
+  #                 style.description.to_s)
+  #
+  # @return description - the description for the style.
+  #
+  # @version SketchUp 6.0
+  def description
+  end
+
+  # The description= method is used to set a description for a style.
+  #
+  # @example
+  #   style = Sketchup.active_model.styles[0]
+  #   style.description = "My new style description."
+  #   UI.messagebox('My new style description is: ' + style.description)
+  #
+  # @param description
+  #   A textual description of the style.
+  #
+  # @return status - true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def description=(description)
+  end
+
+  # The name method is used to retrieve the name for a style.
+  #
+  # @example
+  #   name = style.name
+  #
+  # @return name - the name for the style.
+  #
+  # @version SketchUp 6.0
+  def name
+  end
+
+  # The name= method is used to set the name for a style.
+  #
+  # @example
+  #   style = Sketchup.active_model.styles[0]
+  #   style.name = 'My Very Own Style'
+  #   UI.messagebox('My new style name is: ' + style.name)
+  #
+  # @param name
+  #   - the new name for the style.
+  #
+  # @return name - the name that was set.
+  #
+  # @version SketchUp 6.0
+  def name=(name)
+  end
+
+end

data/SketchUp/Sketchup/Styles.rb

@@ -0,0 +1,204 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Styles class contains methods for manipulating a collection of styles in
+# a model. Typically, you will access this via the active_model:
+#
+# @example
+#   styles = Sketchup.active_model.styles
+#   UI.messagebox "There are " + styles.count.to_s + " styles in your model."
+#
+# @version SketchUp 6.0
+class Sketchup::Styles < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The [] method is used to retrieves a style by either name or index.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style1 = styles[0]
+  #   style2 = styles["name"]
+  #
+  # @param name_or_index
+  #   The string name or index for a specific style.
+  #
+  # @return style - a Style object if successful
+  #
+  # @version SketchUp 6.0
+  def [](name_or_index)
+  end
+
+  # The active_style method is used to retrieve the active style.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.active_style
+  #   UI.messagebox('The active style is: ' + active_style.name)
+  #
+  # @return style - the active Style object.
+  #
+  # @version SketchUp 6.0
+  def active_style
+  end
+
+  # The active_style_changed method tells you if the active style has been
+  # edited by the user since it was last saved.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   user_made_change = styles.active_style_changed
+  #   UI.messagebox ('The active style was edited: ' + user_made_change.to_s)
+  #
+  # @return changed - true if the active style has been changed
+  #   from when it was last saved.
+  #
+  # @version SketchUp 6.0
+  def active_style_changed
+  end
+
+  # The add_style method is used to create and load a style from the given file.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   status = styles.add_style "c:\\MyStyle.style", true
+  #   UI.messagebox ('A style was added: ' + status.to_s)
+  #
+  # @param filename
+  #   The filename for the style.
+  #
+  # @param select
+  #   true if you want to set the style to be the active
+  #   style, false if not.
+  #
+  # @return status - true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def add_style(filename, select)
+  end
+
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   number = styles.count
+  #
+  # @note Since SketchUp 2014 the count method is inherited from Ruby's
+  #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
+  #   for {#length}.
+  #
+  # @return integer - the number of styles found.
+  #
+  # @version SketchUp 6.0
+  def count
+  end
+
+  # The each method is used to iterate through styles.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   styles.each {| style |
+  #     UI.messagebox('style: ' + style.name)
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [style] Variable that will hold each style as it is found.
+  def each
+  end
+
+  # The {#size} method is used to retrieve the number of styles in the
+  # collection.
+  #
+  # The {#length} method is an alias of {#size}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   number = styles.size
+  #
+  # @return integer - the number of styles found.
+  #
+  # @version SketchUp 6.0
+  def length
+  end
+
+  # parent pointer, so we can't use the normal "parent" method from Entity
+  def parent
+  end
+
+  # The purge_unused method is used to remove unused styles from the model.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   status = styles.purge_unused
+  #   UI.messagebox ('Purging Unused styles status: ' + status.to_s)
+  #
+  # @return status - true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def purge_unused
+  end
+
+  # The selected_style method is used to retrieve the currently selected style.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.selected_style
+  #   UI.messagebox ('The selected style is: ' + style.name)
+  #
+  # @return style - the selected Style object.
+  #
+  # @version SketchUp 6.0
+  def selected_style
+  end
+
+  # The selected_style= method is used to set the currently selected style.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   styles.selected_style = styles[styles.count -1]
+  #
+  # @param style
+  #   The style object to select.
+  #
+  # @return false
+  #
+  # @version SketchUp 6.0
+  def selected_style=(style)
+  end
+
+  # The {#size} method is used to retrieve the number of styles in the
+  # collection.
+  #
+  # The {#length} method is an alias of {#size}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   number = styles.size
+  #
+  # @return integer - the number of styles found.
+  #
+  # @version SketchUp 6.0
+  def size
+  end
+
+  # The update_selected_style method returns true if the selected style
+  # was changed (e.g. the user selected a different style).
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   success = styles.update_selected_style
+  #   UI.messagebox ('The selected style was switched: ' + success.to_s)
+  #
+  # @return status - true if the style was switched
+  #
+  # @version SketchUp 6.0
+  def update_selected_style
+  end
+
+end

data/SketchUp/Sketchup/Text.rb

@@ -0,0 +1,241 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Text class contains method to manipulate a Text entity object.
+#
+# @version SketchUp 6.0
+class Sketchup::Text < Sketchup::Drawingelement
+
+  # Instance Methods
+
+  # The arrow_type method retrieves the current arrow type used for the leader
+  # text.
+  #
+  # Valid arrow types are 0 for none, 2 for dot, 3 for closed arrow, 4 for open
+  # arrow.
+  #
+  # @example
+  #   type = text.arrow_type=0
+  #
+  # @return arrow - a numerical representation for the type of
+  #   arrow.
+  #
+  # @version SketchUp 6.0
+  def arrow_type
+  end
+
+  # The arrow_type= method sets the arrow type used for leader text.
+  #
+  # Valid arrow types are 0 for none, 2 for dot, 3 for closed arrow, 4 for open
+  # arrow.
+  #
+  # @example
+  #   arrow = text.arrow_type=type
+  #
+  # @param type
+  #   A numerical representation of the type of arrow to be
+  #   set.
+  #
+  # @return arrow - a numerical representation for the type of
+  #   arrow.
+  #
+  # @version SketchUp 6.0
+  def arrow_type=(type)
+  end
+
+  # The display_leader= method accepts true or false for whether to display the
+  # leader.
+  #
+  # Leader text that is not displayed is set to Hidden type.
+  #
+  # @example
+  #   leader = text.display_leader=true
+  #
+  # @param status
+  #   true if you want to display the leader text, false if
+  #   you do not want to display the leader text.
+  #
+  # @return status - the status that you set.
+  #
+  # @version SketchUp 6.0
+  def display_leader=(status)
+  end
+
+  # The display_leader? method returns the status of the leader.
+  #
+  # @example
+  #   status = text.display_leader
+  #
+  # @return status - true if the leader is being displayed, false
+  #   if it is not displayed.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def display_leader?
+  end
+
+  # The has_leader method is used to determine if the Text object has a leader.
+  #
+  # @example
+  #   status = text.has_leader
+  #
+  # @return status - true if the Text object has a leader. False if
+  #   the Text object does not have a leader.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def has_leader?
+  end
+
+  # The leader_type method retrieves the currently set leader type.
+  #
+  # @example
+  #   leader = text.leader_type
+  #
+  # @return leader - a numerical value representing the currently
+  #   set leader type.
+  #
+  # @version SketchUp 6.0
+  def leader_type
+  end
+
+  # The leader_type = method sets the leader type.
+  #
+  # Valid leader types are 0 for none, 1 for View-based, and 2 for Pushpin
+  #
+  # @example
+  #   leader = text.leader_type=1
+  #
+  # @param type
+  #   A numerical value representing the leader type to be
+  #   set.
+  #
+  # @return leader - a numerical value representing the leader type
+  #   you just set.
+  #
+  # @version SketchUp 6.0
+  def leader_type=(type)
+  end
+
+  # The line_weight method returns a line weight in number of pixels.
+  #
+  # Defalt line weight is 1.
+  #
+  # @example
+  #   weight = text.line_weight
+  #
+  # @return lineweight - the line weight in pixels
+  #
+  # @version SketchUp 6.0
+  def line_weight
+  end
+
+  # The line_weight= method sets the line weight in pixels.
+  #
+  # Default line weight is 1.
+  #
+  # @example
+  #   newweight = text.line_weight = 4
+  #
+  # @param weight
+  #   The line weight to be set (in pixels).
+  #
+  # @return The line weight that has been set.
+  #
+  # @version SketchUp 6.0
+  def line_weight=(weight)
+  end
+
+  # The point method is used to get the point associated with the text.
+  #
+  # @example
+  #   point3d = text.point
+  #
+  # @return point - a Point3d object.
+  #
+  # @version SketchUp 6.0
+  def point
+  end
+
+  # The point= method is used to set the point associated with the text.
+  #
+  # @example
+  #   status = text.point = point3d
+  #
+  # @param point3d
+  #   A Point3d object.
+  #
+  # @return status - true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def point=(point3d)
+  end
+
+  # The set_text method is used to set the text within a Text object without
+  # recording an Undo operation.
+  #
+  # @example
+  #   text = text.set_text "This is another text"
+  #
+  # @param textstring
+  #   The string to be set within the Text object.
+  #
+  # @return text - the Text object
+  #
+  # @version SketchUp 6.0
+  def set_text(textstring)
+  end
+
+  # The text method is used to retrieve the string version of a Text object.
+  #
+  # @example
+  #   textstring = text.text
+  #
+  # @return textstring - the string representation of the Text
+  #   object
+  #
+  # @version SketchUp 6.0
+  def text
+  end
+
+  # The text= method is used to set the string version of a Text object.
+  #
+  # @example
+  #   textstring = text.text= "text"
+  #
+  # @param textstring
+  #
+  # @return textstring - the newly set text
+  #
+  # @version SketchUp 6.0
+  def text=(textstring)
+  end
+
+  # The vector method is used to get the vector associated with the text.
+  #
+  # @example
+  #   vector = text.vector
+  #
+  # @return vector - a Vector3d object.
+  #
+  # @version SketchUp 6.0
+  def vector
+  end
+
+  # The vector= method is used to set the vector associated with the text.
+  #
+  # @example
+  #   vector = text.vector
+  #
+  # @param vector
+  #   A Vector3d object.
+  #
+  # @return success - true if successful.
+  #
+  # @version SketchUp 6.0
+  def vector=(vector)
+  end
+
+end