sketchup-api-stubs 0.1.2 → 0.2.0

data/SketchUp/Layout/Layer.rb

@@ -0,0 +1,222 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This is the interface to a LayOut Layer Definition. A layer definition
+# specifies the document-wide information about a layer. To access the entities
+# on a layer for a given page, use {Layout::LayerInstance}.
+#
+# @example
+#   # Grab a handle to an existing LayOut document.
+#   doc = Layout::Document.open("C:/path/to/document.layout")
+#
+#   new_layer = doc.add_layer(true)
+#   new_layer.name = "A new layer"
+#
+# @version LayOut 2018
+class Layout::Layer
+
+  # Constants
+
+  SHARELAYERACTION_CLEAR = nil # Stub value.
+  SHARELAYERACTION_KEEPONEPAGE = nil # Stub value.
+  SHARELAYERACTION_MERGEALLPAGES = nil # Stub value.
+
+  UNSHARELAYERACTION_CLEAR = nil # Stub value.
+  UNSHARELAYERACTION_COPYTOALLPAGES = nil # Stub value.
+  UNSHARELAYERACTION_COPYTOONEPAGE = nil # Stub value.
+
+  # Instance Methods
+
+  # The {#==} method checks to see if the two {Layout::Layer}s are equal.
+  # This checks whether the Ruby Objects are pointing to the same internal
+  # object.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   document = doc.pages.first.document
+  #   doc.layers.first == document.layers.first
+  #
+  # @param [Layout::Layer] other
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2018
+  def ==(other)
+  end
+
+  # The {#document} method returns the {Layout::Document} that the {Layout::Layer}
+  # belongs to.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   first_layer = doc.layers.first
+  #   # layer_doc should reference the same document as doc
+  #   layer_doc = first_layer.document
+  #
+  # @return [Layout::Document]
+  #
+  # @version LayOut 2018
+  def document
+  end
+
+  # The {#layer_instance} method returns a {Layout::LayerInstance} from the
+  # {Layout::Layer}. If the {Layout::Layer} is shared, a {Layout::Page} does not
+  # have to be provided.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   page = doc.pages.first
+  #   layer_instance = layers.first.layer_instance(page)
+  #
+  # @overload layer_instance
+  #
+  #   @return [Layout::LayerInstance]
+  #
+  # @overload layer_instance(page)
+  #
+  #   @param [Layout::Page] page
+  #   @return [Layout::LayerInstance]
+  #
+  # @raise [ArgumentError] if the {Layout::Layer} is not shared and no page is
+  #   provided
+  #
+  # @version LayOut 2018
+  def layer_instance(page)
+  end
+
+  # The {#locked=} method sets whether the {Layout::Layer} is locked.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layers.first.locked = false
+  #
+  # @param [Boolean] locked
+  #   +true+ to lock the {Layout::Layer}, +false+ to
+  #   unlock it
+  #
+  # @raise [ArgumentError] if the {Layout::Layer} could not be locked because
+  #   there must be at least one unlocked, visible {Layout::Layer}
+  #
+  # @version LayOut 2018
+  def locked=(locked)
+  end
+
+  # The {#locked?} method returns whether the {Layout::Layer} is locked.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   is_locked = layer.first.locked?
+  #
+  # @return [Boolean]
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2018
+  def locked?
+  end
+
+  # The {#name} method returns the name of the {Layout::Layer}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layer_name = layers.first.name
+  #
+  # @return [String]
+  #
+  # @version LayOut 2018
+  def name
+  end
+
+  # The {#name=} sets the name of the {Layout::Layer}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layers.first.name = "Base layer"
+  #
+  # @param [String] name
+  #
+  # @raise [ArgumentError] if name is an empty string
+  #
+  # @version LayOut 2018
+  def name=(name)
+  end
+
+  # The {#set_nonshared} method sets the {Layout::Layer} to non-shared.
+  #
+  # The unshare action can be one of the following values:
+  # [+Layout::Layer::UNSHARELAYERACTION_CLEAR+]
+  # [+Layout::Layer::UNSHARELAYERACTION_COPYTOONEPAGE+]
+  # [+Layout::Layer::UNSHARELAYERACTION_COPYTOALLPAGES+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   page = doc.pages.first
+  #   layers.first.set_nonshared(page, Layout::Layer::UNSHARELAYERACTION_COPYTOONEPAGE);
+  #
+  # @param [Layout::Page] page
+  #   The {Layout::Page} with the {Layout::Layer} to be
+  #   non-shared.
+  #
+  # @param [Integer] unshare_action
+  #   The share action that specifies what to do
+  #   with {Layout::Entity}s after the {Layout::Layer} is non-shared.
+  #
+  # @raise [ArgumentError] if unshare_action is not a valid value
+  #
+  # @raise [LockedLayerError] if the {Layout::Layer} is locked
+  #
+  # @version LayOut 2018
+  def set_nonshared(page, unshare_action)
+  end
+
+  # The {#set_shared} method sets the {Layout::Layer} to shared.
+  #
+  # The share action can be one of the following values:
+  # [+Layout::Layer::SHARELAYERACTION_CLEAR+]
+  # [+Layout::Layer::SHARELAYERACTION_KEEPONEPAGE+]
+  # [+Layout::Layer::SHARELAYERACTION_MERGEALLPAGES+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   page = doc.pages.first
+  #   layers.first.set_shared(page, Layout::Layer::SHARELAYERACTION_KEEPONEPAGE);
+  #
+  # @param [Layout::Page] page
+  #   The {Layout::Page} with the {Layout::Layer} to be
+  #   shared.
+  #
+  # @param [Integer] share_action
+  #   The share action that specifies what to do with
+  #   {Layout::Entity}s after the {Layout::Layer} is shared.
+  #
+  # @raise [ArgumentError] if share_action is not a valid value
+  #
+  # @raise [Layout::LockedLayerError] if the {Layout::Layer} is locked
+  #
+  # @version LayOut 2018
+  def set_shared(page, share_action)
+  end
+
+  # The {#shared?} method returns whether the {Layout::Layer} is shared.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   is_shared = layers.first.shared?
+  #
+  # @return [Boolean]
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2018
+  def shared?
+  end
+
+end

data/SketchUp/Layout/LayerInstance.rb

@@ -0,0 +1,128 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# References an instance of a {Layout::Layer}. A {Layout::LayerInstance}
+# provides access to the {Layout::Entity}s that are on it, as well as their
+# draw order. {Layout::Group}s are not included in the list of {Layout::Entity}s
+# associated with a {Layout::LayerInstance}, since the group hierarchy has no
+# effect on entity draw order. Each {Layout::Page} has one
+# {Layout::LayerInstance} for each {Layout::Layer} in the {Layout::Document}.
+# Non-shared {Layout::LayerInstance}s are unique per {Layout::Page}, while
+# shared {Layout::LayerInstance}s are shared across all {Layout::Page}s of the
+# {Layout::Document}.
+#
+# @example
+#   doc = Layout::Document.open("C:/path/to/document.layout")
+#   layers = doc.layers
+#   pages = doc.pages
+#   layers.each do |layer|
+#     layer_instance = layer.layer_instance(pages.first)
+#     entities = layer_instance.entities
+#     entities.each do |entity|
+#       new_index = rand(entities.length - 1)
+#       layer_instance.reorder_entity(entity, new_index)
+#     end
+#   end
+#
+# @version LayOut 2018
+class Layout::LayerInstance
+
+  # Instance Methods
+
+  # The {#==} method checks to see if the two {Layout::LayerInstance}s are equal.
+  # This checks whether the Ruby Objects are pointing to the same internal
+  # object.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   document = doc.pages.first.document
+  #   doc.page.layer_instances.first == document.page.layer_instances.first
+  #
+  # @param [Layout::LayerInstance] other
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2018
+  def ==(other)
+  end
+
+  # The {#definition} method returns the {Layout::Layer} of the
+  # {Layout::LayerInstance}.
+  #
+  # @example
+  #   layer_def = layer_instance.definition
+  #
+  # @return [Layout::Layer]
+  #
+  # @version LayOut 2018
+  def definition
+  end
+
+  # The {#entities} method returns the {Layout::Entities} on the
+  # {Layout::LayerInstance}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   pages = doc.pages
+  #   first_layer = layers.first
+  #   entities = first_layer.layer_instance.entities
+  #
+  # @return [Layout::Entities]
+  #
+  # @version LayOut 2018
+  def entities
+  end
+
+  # The {#entity_index} method returns the index of the {Layout::Entity} on the
+  # {Layout::LayerInstance}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   pages = doc.pages
+  #   instance = layers.first.layer_instance
+  #   instance.entities.each_with_index { |entity, index|
+  #     puts "#{index} == #{instance.entity_index(entity)}"
+  #   }
+  #
+  # @param [Layout::Entity] entity
+  #   The entity to get the index of.
+  #
+  # @raise [ArgumentError] if entity is not on the {Layout::LayerInstance}
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2018
+  def entity_index(entity)
+  end
+
+  # The {#reorder_entity} method moves the {Layout::Entity} to the specified
+  # index.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   pages = doc.pages
+  #   first_layer = layers.first
+  #   first_layer.set_shared(pages.first, SHARELAYERACTION_KEEPONEPAGE);
+  #   layer_instance = first_layer.layer_instance
+  #   entities = layer_instance.entities
+  #   # put the first entity into the back of the layer
+  #   layer_instance.reorder_entity(entities.first, (entities.length - 1))
+  #
+  # @param [Layout::Entity] entity
+  #   The {Layout::Entity} to reorder
+  #
+  # @param [Integer] index
+  #   The desired index of the {Layout::Entity}
+  #
+  # @raise [IndexError] if index is out of range
+  #
+  # @raise [ArgumentError] if entity is not on the {Layout::LayerInstance}
+  #
+  # @version LayOut 2018
+  def reorder_entity(entity, index)
+  end
+
+end

data/SketchUp/Layout/Layers.rb

@@ -0,0 +1,232 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Layers class is a container class for all layers in a {Layout::Document}.
+#
+# @example
+#   # Grab a handle to the currently active document's layers
+#   doc = Layout::Document.open("C:/path/to/document.layout")
+#   layers = doc.layers
+#
+#   # From here, we can add layers to or remove them from the document
+#   layers.add("New Layer")
+#   layers.remove(layers[0])
+#
+# @version LayOut 2018
+class Layout::Layers
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The {#[]} method returns a value from the array of {Layout::Layer}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layer = layers[2]
+  #
+  # @param [Integer] index
+  #   The index of the {Layout::Layer} to return.
+  #
+  # @raise [IndexError] if index is out of range
+  #
+  # @return [Layout::Layer]
+  #
+  # @version LayOut 2018
+  def [](index)
+  end
+
+  # The {#active} method returns the active {Layout::Layer} in the
+  # {Layout::Document}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layer = doc.layers.active
+  #
+  # @return [Layout::Layer]
+  #
+  # @version LayOut 2018
+  def active
+  end
+
+  # The {#active=} method sets the active {Layout::Layer} that will be
+  # displayed the next time the {Layout::Document} is opened. This value will
+  # change whenever the {Layout::Layer} is changed in the {Layout::Document} in
+  # LayOut.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layers.active = layers[0]
+  #
+  # @overload active=(layer)
+  #
+  #   @param [Layout::Layer] layer The {Layout::Layer} to set as the initial one
+  #   @return [Layout::Layer]
+  #
+  #   @raise [ArgumentError] if layer does not belong to the {Layout::Document}
+  #   @raise [ArgumentError] if layer is locked or hidden on the current
+  #     {Layout::Page}
+  #
+  # @overload active=(index)
+  #
+  #   @param [Integer] index The index of {Layout::Layer} the to set as the
+  #     initial one
+  #   @return [Layout::Layer]
+  #
+  #   @raise [ArgumentError] if index is out of range
+  #   @raise [ArgumentError] if the {Layout::Layer} is locked or hidden on the
+  #     current {Layout::Page}
+  #
+  # @version LayOut 2018
+  def active=(layer)
+  end
+
+  # The {#add} method adds a new {Layout::Layer} to the {Layout::Document}.
+  # The newly added {Layout::Layer} will be the last one in the
+  # {Layout::Document}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   new_layer = doc.layers.add
+  #
+  # @overload add(shared = false)
+  #
+  #   @param [Boolean] shared +true+ to make the {Layout::Layer} shared, +false+
+  #     for non-shared.
+  #   @return [Layout::Layer] The newly added {Layout::Layer}.
+  #
+  # @overload add(name, shared = false)
+  #
+  #   @param [String] name The name for the new layer.
+  #   @param [Boolean] shared +true+ to make the {Layout::Layer} shared, +false+
+  #     for non-shared.
+  #   @return [Layout::Layer] The newly added {Layout::Layer}.
+  #
+  # @version LayOut 2018
+  def add(*args)
+  end
+
+  # The {#each} method iterates through all of the {Layout::Layer}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layers.each { |layer|
+  #     puts layer.name
+  #   }
+  #
+  # @version LayOut 2018
+  #
+  # @yieldparam [Layout::Layer] layer
+  def each
+  end
+
+  # The {#index} method returns the index of the {Layout::Layer}, or +nil+ if
+  # it doesn't exist in the {Layout::Document}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layer_index = layers.index(layers.first) # Returns 0
+  #
+  # @param [Layout::Layer] layer
+  #
+  # @return [Integer, nil]
+  #
+  # @version LayOut 2018
+  def index(layer)
+  end
+
+  # The {#length} method returns the number of {Layout::Layer}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   num_layers = layers.length
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2018
+  def length
+  end
+
+  # The {#remove} method deletes the given {Layout::Layer} from the
+  # {Layout::Document}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layers.remove(layers[0])
+  #
+  # @overload remove(layer, delete_entities = false)
+  #
+  #   @param [Layout::Layer] layer The {Layout::Layer} to be removed
+  #   @param [Boolean] delete_entities Whether the {Layout::Entity}s on the
+  #     deleted {Layout::Layer} should be deleted as well
+  #
+  #   @raise [ArgumentError] if the {Layout::Layer} is not in the
+  #     {Layout::Document}
+  #   @raise [ArgumentError] if the {Layout::Layer} is the only one in the
+  #     {Layout::Document}
+  #
+  # @overload remove(index, delete_entities = false)
+  #
+  #   @param [Integer] index The index of the {Layout::Layer} to be removed
+  #   @param [Boolean] delete_entities Whether the {Layout::Entity}s on the
+  #     deleted {Layout::Layer} should be deleted as well
+  #
+  #   @raise [IndexError] if index is out of range
+  #   @raise [ArgumentError] if the {Layout::Layer} is the only one in the
+  #     {Layout::Document}
+  #
+  # @version LayOut 2018
+  def remove(*args)
+  end
+
+  # The {#reorder} method moves a {Layout::Layer} to a different index
+  # within the {Layout::Document}'s list of layers. This will move the
+  # {Layout::Layer} such that its new index becomes new_index.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   layers.reorder(layers[1], 3)
+  #
+  # @overload reorder(layer, new_index)
+  #
+  #   @param [Layout::Layer] layer The {Layout::Layer} to be reordered
+  #   @param [Integer] new_index The index to put the {Layout::Layer} at
+  #
+  #   @raise [ArgumentError] if the {Layout::Layer} is not in the
+  #     {Layout::Document}
+  #   @raise [IndexError] if new_index is out of range
+  #
+  # @overload reorder(index, new_index)
+  #
+  #   @param [Integer] index The index of the {Layout::Layer} to be reordered
+  #   @param [Integer] new_index The index to put the {Layout::Layer} at
+  #
+  #   @raise [IndexError] if index or new_index are out of range
+  #
+  # @version LayOut 2018
+  def reorder(layer, new_index)
+  end
+
+  # The {#length} method returns the number of {Layout::Layer}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   layers = doc.layers
+  #   num_layers = layers.length
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2018
+  def size
+  end
+
+end