sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/RegionalSettings.rb

@@ -0,0 +1,43 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The {Sketchup::RegionalSettings} module contains methods getting information about the
+# user's locale settings.
+#
+# Note that when you convert between units and strings you don't need to parse
+# it yourself and you can instead use {String#to_l} and {Length#to_s}.
+#
+# @version SketchUp 2016 M1
+module Sketchup::RegionalSettings
+
+  # Class Methods
+
+  # Returns the decimal character for the current user's locale.
+  #
+  # @example
+  #   # Format a Float using the user's locale settings.
+  #   # Ruby's Float.to_s always use period as decimal separator.
+  #   formatted = 0.123.to_s.tr('.', Sketchup::RegionalSettings.decimal_separator)
+  #
+  # @return [String] the decimal separator character
+  #
+  # @version SketchUp 2016 M1
+  def self.decimal_separator
+  end
+
+  # Returns the list separator character for the current user's locale.
+  #
+  # @example
+  #   # Format a CSV list in user's locale:
+  #   decimal = Sketchup::RegionalSettings.decimal_separator
+  #   list = Sketchup::RegionalSettings.list_separator
+  #   row = [3.14, 1.618, 2.718]
+  #   csv = row.map { |value| value.to_s.tr('.', decimal) }.join(list)
+  #
+  # @return [String] the list separator character
+  #
+  # @version SketchUp 2016 M1
+  def self.list_separator
+  end
+
+end

data/SketchUp/Sketchup/RenderingOptions.rb

@@ -0,0 +1,337 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The RenderingOptions class contains method to extract the rendering
+# information for a model. The majority of the rendering information returned
+# exists in the Styles dialog. The following
+# rendering information keys are maintained in SketchUp:
+#
+# - +BackgroundColor+
+# - +BandColor+
+# - +ConstructionColor+
+# - +DepthQueWidth+
+# - +DisplayColorByLayer+
+# - +DisplayFog+
+# - +DisplayInstanceAxes+
+# - +DisplayWatermarks+
+# - +DrawDepthQue+
+# - +DrawGround+
+# - +DrawHidden+
+# - +DrawHorizon+
+# - +DrawLineEnds+
+# - +DrawProfilesOnly+
+# - +DrawSilhouettes+
+# - +DrawUnderground+
+# - +EdgeColorMode+
+# - +EdgeDisplayMode+
+# - +EdgeType+
+# - +ExtendLines+
+# - +FaceBackColor+
+# - +FaceColorMode+
+# - +FaceFrontColor+
+# - +FogColor+
+# - +FogEndDist+
+# - +FogStartDist+
+# - +FogUseBkColor+
+# - +ForegroundColor+
+# - +GroundColor+
+# - +GroundTransparency+
+# - +HideConstructionGeometry+
+# - +HighlightColor+
+# - +HorizonColor+
+# - +InactiveHidden+
+# - +InstanceHidden+
+# - +JitterEdges+
+# - +LineEndWidth+
+# - +LineExtension+
+# - +LockedColor+
+# - +MaterialTransparency+
+# - +ModelTransparency+
+# - +RenderMode+
+# - +SectionActiveColor+
+# - +SectionCutWidth+
+# - +SectionDefaultCutColor+
+# - +SectionInactiveColor+
+# - +ShowViewName+
+# - +SilhouetteWidth+
+# - +SkyColor+
+# - +Texture+
+# - +TransparencySort+ SketchUp 2017 treats Medium transparency as Faster.
+#
+# Added in SketchUp 7:
+# - +DisplayDims+
+# - +DisplaySketchAxes+
+# - +DisplayText+
+#
+# Added in SketchUp 8:
+# - +InactiveFade+
+# - +InstanceFade+
+#
+# Added in SketchUp 2014:
+# - +DisplaySectionPlanes+
+#
+# Added in SketchUp 2015:
+# - +DisplaySectionCuts+
+# - +DrawBackEdges+
+# - +SectionCutDrawEdges+
+#
+# @version SketchUp 6.0
+class Sketchup::RenderingOptions < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Constants
+
+  ROPAssign = nil # Stub value.
+  ROPDrawHidden = nil # Stub value.
+  ROPEditComponent = nil # Stub value.
+  ROPSetBackgroundColor = nil # Stub value.
+  ROPSetConstructionColor = nil # Stub value.
+  ROPSetDepthQueEdges = nil # Stub value.
+  ROPSetDepthQueWidth = nil # Stub value.
+  ROPSetDisplayColorByLayer = nil # Stub value.
+  ROPSetDisplayDims = nil # Stub value.
+  ROPSetDisplayFog = nil # Stub value.
+  ROPSetDisplayInstanceAxes = nil # Stub value.
+  ROPSetDisplaySketchAxes = nil # Stub value.
+  ROPSetDisplayText = nil # Stub value.
+  ROPSetDisplayWatermarks = nil # Stub value.
+  ROPSetDrawBackEdges = nil # Stub value.
+  ROPSetDrawGround = nil # Stub value.
+  ROPSetDrawHorizon = nil # Stub value.
+  ROPSetDrawUnderground = nil # Stub value.
+  ROPSetEdgeColorMode = nil # Stub value.
+  ROPSetEdgeDisplayMode = nil # Stub value.
+  ROPSetEdgeType = nil # Stub value.
+  ROPSetExtendEdges = nil # Stub value.
+  ROPSetExtendLines = nil # Stub value.
+  ROPSetFaceColor = nil # Stub value.
+  ROPSetFaceColorMode = nil # Stub value.
+  ROPSetFogColor = nil # Stub value.
+  ROPSetFogDist = nil # Stub value.
+  ROPSetFogHint = nil # Stub value.
+  ROPSetFogUseBkColor = nil # Stub value.
+  ROPSetForegroundColor = nil # Stub value.
+  ROPSetGroundColor = nil # Stub value.
+  ROPSetGroundTransparency = nil # Stub value.
+  ROPSetHideConstructionGeometry = nil # Stub value.
+  ROPSetHighlightColor = nil # Stub value.
+  ROPSetJitterEdges = nil # Stub value.
+  ROPSetLineEndEdges = nil # Stub value.
+  ROPSetLineEndWidth = nil # Stub value.
+  ROPSetLineExtension = nil # Stub value.
+  ROPSetLockedColor = nil # Stub value.
+  ROPSetMaterialTransparency = nil # Stub value.
+  ROPSetModelTransparency = nil # Stub value.
+  ROPSetPhotomatchBackgroundOpacity = nil # Stub value.
+  ROPSetPhotomatchDrawBackground = nil # Stub value.
+  ROPSetPhotomatchDrawOverlay = nil # Stub value.
+  ROPSetPhotomatchOverlayOpacity = nil # Stub value.
+  ROPSetProfileEdges = nil # Stub value.
+  ROPSetProfileWidth = nil # Stub value.
+  ROPSetProfilesOnlyEdges = nil # Stub value.
+  ROPSetRenderMode = nil # Stub value.
+  ROPSetSectionActiveColor = nil # Stub value.
+  ROPSetSectionCutWidth = nil # Stub value.
+  ROPSetSectionDefaultCutColor = nil # Stub value.
+  ROPSetSectionDisplayMode = nil # Stub value.
+  ROPSetSectionInactiveColor = nil # Stub value.
+  ROPSetSkyColor = nil # Stub value.
+  ROPSetTexture = nil # Stub value.
+  ROPSetTransparencyObsolete = nil # Stub value.
+  ROPSetXRayOpacity = nil # Stub value.
+  ROPTransparencySortMethod = nil # Stub value.
+
+  # Class Methods
+
+  # The each_key method iterates through all of the rendering options keys.
+  #
+  # @example
+  #   Sketchup.active_model.rendering_options.each_key { |key|
+  #     puts key
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key] Variable to hold each key as they are found.
+  def self.each_key
+  end
+
+  # The keys method returns an array with all of the attribute keys.
+  #
+  # @example
+  #   keys = Sketchup.active_model.rendering_options.keys
+  #
+  # @return keys - an array of keys
+  #
+  # @version SketchUp 6.0
+  def self.keys
+  end
+
+  # Instance Methods
+
+  # The set value [] method is used to get the value in the array of
+  # rendering options.
+  #
+  # @example
+  #   result = Sketchup.active_model.rendering_options["DisplayInstanceAxes"]
+  #
+  # @param key
+  #   The key of the rendering option value to set.
+  #
+  # @return value - the value that was found.
+  #
+  # @version SketchUp 6.0
+  def [](key)
+  end
+
+  # The set value []= method is used to set the value in the array of
+  # rendering options.
+  #
+  # @example
+  #   Sketchup.active_model.rendering_options["DisplayInstanceAxes"] = false
+  #
+  # @param key
+  #   The key of the rendering option value to set.
+  #
+  # @param value
+  #   The value to be set.
+  #
+  # @return value - the value that was set
+  #
+  # @version SketchUp 6.0
+  def []=(key, value)
+  end
+
+  # The add_observer method is used to add an observer to the current object.
+  #
+  # @example
+  #   observer = Sketchup::RenderingOptionsObserver.new # Dummy observer.
+  #   result = Sketchup.active_model.rendering_options.add_observer(observer)
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def add_observer(observer)
+  end
+
+  # The {#count} method is inherited from the +Enumerable+ mix-in module.
+  #
+  # @example
+  #   options = Sketchup.active_model.rendering_options
+  #   number = options.count
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def count
+  end
+
+  # An alias for each. See RenderingOptions.each.
+  #
+  # @example
+  #   Sketchup.active_model.rendering_options.each_pair { |key, value|
+  #     puts "#{key} : #{value}"
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def each
+  end
+
+  # The each_key method iterates through all of the rendering options keys.
+  #
+  # @example
+  #   Sketchup.active_model.rendering_options.each_key { |key|
+  #     puts key
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key] Variable to hold each key as they are found.
+  def each_key
+  end
+
+  # An alias for each. See RenderingOptions.each.
+  #
+  # @example
+  #   Sketchup.active_model.rendering_options.each_pair { |key, value|
+  #     puts "#{key} : #{value}"
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  def each_pair
+  end
+
+  # The keys method returns an array with all of the attribute keys.
+  #
+  # @example
+  #   keys = Sketchup.active_model.rendering_options.keys
+  #
+  # @return keys - an array of keys
+  #
+  # @version SketchUp 6.0
+  def keys
+  end
+
+  # The {#length} method returns the number of options in the rendering options
+  # collection
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   options = Sketchup.active_model.rendering_options
+  #   number = options.length
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def length
+  end
+
+  # The remove_observer method is used to remove an observer from the current
+  # object.
+  #
+  # @example
+  #   observer = Sketchup::RenderingOptionsObserver.new # Dummy observer.
+  #   options = Sketchup.active_model.rendering_options
+  #   options.add_observer(observer)
+  #   result = options.remove_observer(observer)
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def remove_observer(observer)
+  end
+
+  # The {#length} method returns the number of options in the rendering options
+  # collection
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   options = Sketchup.active_model.rendering_options
+  #   number = options.length
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def size
+  end
+
+end

data/SketchUp/Sketchup/RenderingOptionsObserver.rb

@@ -0,0 +1,44 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to rendering options events.
+# To implement this observer, create a Ruby class of this type, implement the
+# desired methods, and add an instance of the observer to the objects of
+# interests.
+#
+# @example
+#   # This is an example of an observer that watches the rendering options
+#   # for changes.
+#   class MyRenderingOptionsObserver < Sketchup::RenderingOptionsObserver
+#     def onRenderingOptionsChanged(rendering_options, type)
+#       puts "onRenderingOptionsChanged(#{rendering_options}, #{type})"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   rendering_options = Sketchup.active_model.rendering_options
+#   rendering_options.add_observer(MyRenderingOptionsObserver.new)
+class Sketchup::RenderingOptionsObserver
+
+  # Instance Methods
+
+  # The onRenderingOptionsChanged method is invoked whenever the user changes
+  # their rendering options.
+  #
+  # @example
+  #   def onRenderingOptionsChanged(rendering_options, type)
+  #     puts "onRenderingOptionsChanged(#{rendering_options}, #{type})"
+  #   end
+  #
+  # @param [Integer] type
+  #   A number indicating which option was changed
+  #   represented by one of the constants defined in
+  #   {Sketchup::RenderingOptions}.
+  #
+  # @param [Sketchup::RenderingOptions] rendering_options
+  #
+  # @version SketchUp 6.0
+  def onRenderingOptionsChanged(rendering_options, type)
+  end
+
+end

data/SketchUp/Sketchup/SectionPlane.rb

@@ -0,0 +1,88 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The SectionPlane class represents a section plane in a SketchUp model. Note
+# that prior to SketchUp 2014 there was no way to create a SectionPlane object
+# using Ruby. For older versions of SketchUp, you must manually create a
+# section plane with the Section Plane Tool in SketchUp and then query the
+# entities array to find the SectionPlane object.
+#
+# @version SketchUp 6.0
+class Sketchup::SectionPlane < Sketchup::Drawingelement
+
+  # Instance Methods
+
+  # The activate method is used to make the section plane the active one of its
+  # parent component/group.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   sp = entities.add_section_plane([50, 50, 0], [1.0, 1.0, 0])
+  #   sp.activate
+  #
+  # @return self if successful
+  #
+  # @version SketchUp 2014
+  def activate
+  end
+
+  # The active? method indicates whether the section plane is active or not.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   sp = entities.add_section_plane([50, 50, 0], [1.0, 1.0, 0])
+  #   sp.activate
+  #   if sp.active?
+  #      puts "Yes, it is active"
+  #   end
+  #
+  # @return boolean - true if active
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2014
+  def active?
+  end
+
+  # The get_plane method is used to retrieve the plane that the section plane is
+  # on.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   # Grab the first section plane from the model.
+  #   sp = entities.grep(Sketchup::SectionPlane).first
+  #   plane = sp.get_plane
+  #   if (plane)
+  #     puts plane.to_s
+  #   else
+  #     puts 'Failure'
+  #   end
+  #
+  # @return plane - a plane. See the Geom module and Array class
+  #   for further information on planes.
+  #
+  # @version SketchUp 6.0
+  def get_plane
+  end
+
+  # The set_plane method is used to set the plane that the section plane is
+  # on.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   # Grab the first section plane from the model.
+  #   sp = entities.grep(Sketchup::SectionPlane).first
+  #   sp = sp.set_plane my_plane_array
+  #
+  # @param plane
+  #   An array representing the new plane,
+  #
+  # @return section_plane - the updated SectionPlane.
+  #
+  # @version SketchUp 6.0
+  def set_plane(plane)
+  end
+
+end