sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Layout/LockedEntityError.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is raised whenever a method attempts to modify any {Layout::Entity}

data/SketchUp/Layout/LockedLayerError.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is raised whenever a method attempts to modify any {Layout::Entity}

data/SketchUp/Layout/Page.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Class for a single page in a LayOut document.
@@ -173,11 +173,11 @@ class Layout::Page
   #
   # @param [Boolean] visible
   #
+  # @raise [ArgumentError] if layer and page are not in the same document
+  #
   # @raise [ArgumentError] if layer could not be hidden because there must be at
   #   least one unlocked, visible layer on each page
   #
-  # @raise [ArgumentError] if layer and page are not in the same document
-  #
   # @return [Boolean]
   #
   # @version LayOut 2018

data/SketchUp/Layout/PageInfo.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a {Layout::Document}'s paper space information. The

data/SketchUp/Layout/Pages.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Pages class is a container class for all pages in a {Layout::Document}.

data/SketchUp/Layout/Path.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A path entity represents a continuous, multi-segment polyline or bezier
@@ -9,6 +9,10 @@ class Layout::Path < Layout::Entity
 
   # Constants
 
+  PATH_WINDING_CLOCKWISE = nil # Stub value.
+  PATH_WINDING_COUNTER_CLOCKWISE = nil # Stub value.
+  PATH_WINDING_NONE = nil # Stub value.
+
   POINT_TYPE_ARC_CENTER = nil # Stub value.
   POINT_TYPE_BEZIER_CONTROL = nil # Stub value.
   POINT_TYPE_BEZIER_TO = nil # Stub value.
@@ -35,10 +39,10 @@ class Layout::Path < Layout::Entity
   #
   # @param [Float] end_angle
   #
-  # @raise [ArgumentError] if start angle is equal to end angle
-  #
   # @raise [ArgumentError] if radius is less than or equal to zero
   #
+  # @raise [ArgumentError] if start angle is equal to end angle
+  #
   # @return [Layout::Path] an arc path
   #
   # @version LayOut 2018
@@ -56,20 +60,20 @@ class Layout::Path < Layout::Entity
   #
   # @overload append_point(point)
   #
-  #   @param  [Geom::Point2d] append_point
+  #   @param  [Geom::Point2d] point
   #   @return [Layout::Path]
   #
-  # @overload append_point(point, control_point1, control_point2)
+  # @overload append_point(control_point1, control_point2, point)
   #
-  #   @param  [Geom::Point2d] point The point to append
   #   @param  [Geom::Point2d] control_point1 The first bezier control point
   #   @param  [Geom::Point2d] control_point2 The second bezier control point
+  #   @param  [Geom::Point2d] point The point to append
   #   @return [Layout::Path]
   #
-  # @raise [LockedEntityError] if the {Layout::Path} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Path} is on a locked {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Path} is locked
+  #
   # @version LayOut 2018
   def append_point(*args)
   end
@@ -107,11 +111,11 @@ class Layout::Path < Layout::Entity
   # @raise [LockedLayerError] if the {Layout::Path} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [LockedEntityError] if the {Layout::Path} is locked
-  #
   # @raise [ArgumentError] if the {Layout::Path} can not be closed becauase it
   #   contains less than three points.
   #
+  # @raise [LockedEntityError] if the {Layout::Path} is locked
+  #
   # @version LayOut 2018
   def close
   end
@@ -161,43 +165,36 @@ class Layout::Path < Layout::Entity
   #
   # @example
   #   start = Geom::Point2d.new(1, 1)
-  #   control_1 = Geom::Point2d.new(1.5, 1)
-  #   control_2 = Geom::Point2d.new(1, 1.5)
   #   end = Geom::Point2d.new(2, 2)
-  #   new_path = Layout::Path.new(start, control_1, control_2, end)
+  #   new_path = Layout::Path.new(start, end)
   #
   # @example
   #   start = Geom::Point2d.new(1, 1)
+  #   control_1 = Geom::Point2d.new(1.5, 1)
+  #   control_2 = Geom::Point2d.new(1, 1.5)
   #   end = Geom::Point2d.new(2, 2)
-  #   new_path = Layout::Path.new(start, end)
+  #   new_path = Layout::Path.new(start, control_1, control_2, end)
   #
-  # @overload initialize(start_point, control_point_1, control_point_2, end_point)
+  # @overload initialize(start_point, end_point)
   #
   #   @param [Geom::Point2D] start_point
-  #   @param [Geom::Point2D] control_point_1 The first bezier control point
-  #   @param [Geom::Point2D] control_point_2 The second bezier control point
   #   @param [Geom::Point2D] end_point
-  #   @return [Layout::Path] a bezier path
+  #   @return [Layout::Path] a straight path
   #
   #   @raise [ArgumentError] if the length between start point and end point is
   #     zero
   #
-  # @overload initialize(start_point, end_point)
+  # @overload initialize(start_point, control_point_1, control_point_2, end_point)
   #
   #   @param [Geom::Point2D] start_point
+  #   @param [Geom::Point2D] control_point_1 The first bezier control point
+  #   @param [Geom::Point2D] control_point_2 The second bezier control point
   #   @param [Geom::Point2D] end_point
-  #   @return [Layout::Path] a straight path
+  #   @return [Layout::Path] a bezier path
   #
   #   @raise [ArgumentError] if the length between start point and end point is
   #     zero
   #
-  # @overload initialize(ellipse)
-  #
-  #   @param [Layout::Ellipse] ellipse
-  #   @return [Layout::Path] a path created from the {Layout::Ellipse}
-  #
-  #   @raise [TypeError] if ellipse is not an {Layout::Ellipse}
-  #
   # @overload initialize(rectangle)
   #
   #   @param [Layout::Rectangle] rectangle
@@ -205,6 +202,13 @@ class Layout::Path < Layout::Entity
   #
   #   @raise [TypeError] if rectangle is not a {Layout::Rectangle}
   #
+  # @overload initialize(ellipse)
+  #
+  #   @param [Layout::Ellipse] ellipse
+  #   @return [Layout::Path] a path created from the {Layout::Ellipse}
+  #
+  #   @raise [TypeError] if ellipse is not an {Layout::Ellipse}
+  #
   # @version LayOut 2018
   def initialize(*args)
   end
@@ -323,4 +327,20 @@ class Layout::Path < Layout::Entity
   def tangent_at(parametric_value)
   end
 
+  # The {#winding} method returns the winding type of the {Layout::Path}.
+  #
+  # A point type can be one of the following values:
+  # [+PATH_WINDING_NONE+]
+  # [+PATH_WINDING_CLOCKWISE+]
+  # [+PATH_WINDING_COUNTER_CLOCKWISE+]
+  #
+  # @example
+  #   winding = path.winding
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2019
+  def winding
+  end
+
 end

data/SketchUp/Layout/Rectangle.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A simple rectangular shape entity.
@@ -59,14 +59,14 @@ class Layout::Rectangle < Layout::Entity
   #   @param [Float] radius
   #   @return [Layout::Rectangle]
   #
-  # @raise [ArgumentError] if radius is a negative value
+  # @raise [ArgumentError] if type passed in does not match the number of
+  #   arguments
   #
   # @raise [ArgumentError] if bounds is zero size
   #
   # @raise [ArgumentError] if type is not a valid type
   #
-  # @raise [ArgumentError] if type passed in does not match the number of
-  #   arguments
+  # @raise [ArgumentError] if radius is a negative value
   #
   # @version LayOut 2018
   def initialize(*args)
@@ -107,12 +107,12 @@ class Layout::Rectangle < Layout::Entity
   # @raise [ArgumentError] if the {Layout::Rectangle} is not of type
   #   +Layout::Rectangle::TYPE_BULGED+ or +Layout::Rectangle::TYPE_ROUNDED+
   #
-  # @raise [LockedEntityError] if the {Layout::Rectangle} is locked
+  # @raise [ArgumentError] if radius is negative
   #
   # @raise [LockedLayerError] if the {Layout::Rectangle} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [ArgumentError] if radius is negative
+  # @raise [LockedEntityError] if the {Layout::Rectangle} is locked
   #
   # @version LayOut 2018
   def radius=(radius)
@@ -163,10 +163,10 @@ class Layout::Rectangle < Layout::Entity
   # @raise [LockedLayerError] if the {Layout::Rectangle} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [ArgumentError] if type is not a valid rectangle type
-  #
   # @raise [LockedEntityError] if the {Layout::Rectangle} is locked
   #
+  # @raise [ArgumentError] if type is not a valid rectangle type
+  #
   # @version LayOut 2018
   def type=(type)
   end

data/SketchUp/Layout/SketchUpModel.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A SketchUp Model entity. This is an instance of a SketchUp Model that is
@@ -18,11 +18,11 @@ class Layout::SketchUpModel < Layout::Entity
 
   # Constants
 
+  BACK_VIEW = nil # Stub value.
+
   BOTTOM_RELATIVE_VIEW = nil # Stub value.
   BOTTOM_VIEW = nil # Stub value.
 
-  BACK_VIEW = nil # Stub value.
-
   CUSTOM_VIEW = nil # Stub value.
 
   FRONT_VIEW = nil # Stub value.
@@ -33,10 +33,10 @@ class Layout::SketchUpModel < Layout::Entity
 
   LEFT_VIEW = nil # Stub value.
 
-  RIGHT_VIEW = nil # Stub value.
-
   RASTER_RENDER = nil # Stub value.
 
+  RIGHT_VIEW = nil # Stub value.
+
   TOP_RELATIVE_VIEW = nil # Stub value.
   TOP_VIEW = nil # Stub value.
 
@@ -73,13 +73,13 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @raise [ArgumentError] if clip_mask is already in a {Layout::Document}
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  # @raise [ArgumentError] if clip_mask is not a {Layout::Rectangle},
+  #   {Layout::Ellipse}, or {Layout::Path}
   #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [ArgumentError] if clip_mask is not a {Layout::Rectangle},
-  #   {Layout::Ellipse}, or {Layout::Path}
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
   #
   # @version LayOut 2018
   def clip_mask=(clip_mask)
@@ -113,11 +113,11 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @raise [IndexError] if index is out of range
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
   # @version LayOut 2018
   def current_scene=(index)
   end
@@ -140,6 +140,41 @@ class Layout::SketchUpModel < Layout::Entity
   def current_scene_modified?
   end
 
+  # The {#dash_scale} method returns the dash scale for the
+  # {Layout::SketchUpModel}. A scale value of 0.0 means the dashes are scaled
+  # based on the line weight.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   dash_scale = model.dash_scale
+  #
+  # @return [Float]
+  #
+  # @version LayOut 2019
+  def dash_scale
+  end
+
+  # The {#dash_scale=} method sets the dash scale for the {Layout::SketchUpModel}.
+  # A scale value of 0.0 or lower will "auto" scale the dashes based on the line
+  # weight.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
+  #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
+  #   model.dash_scale = 2.5
+  #
+  # @param [Float] dash_scale
+  #
+  # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
+  # @version LayOut 2018
+  def dash_scale=(dash_scale)
+  end
+
   # The {#display_background=} method sets whether the background is displayed
   # for the {Layout::SketchUpModel}.
   #
@@ -150,11 +185,11 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @param [Boolean] display
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
   # @version LayOut 2018
   def display_background=(display)
   end
@@ -203,10 +238,10 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @param [Geom::Bounds2d] bounds
   #
-  # @raise [ArgumentError] if bounds is zero size
-  #
   # @raise [ArgumentError] if path does not point to a valid SketchUp Model file
   #
+  # @raise [ArgumentError] if bounds is zero size
+  #
   # @return [Layout::SketchUpModel]
   #
   # @version LayOut 2018
@@ -239,11 +274,11 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @raise [ArgumentError] if line_weight is less than 0.01
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
   # @version LayOut 2018
   def line_weight=(line_weight)
   end
@@ -275,11 +310,11 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @param [Boolean] perspective
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
   # @version LayOut 2018
   def perspective=(perspective)
   end
@@ -310,11 +345,11 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @param [Boolean] preserve_scale
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
   # @version LayOut 2018
   def preserve_scale_on_resize=(preserve_scale)
   end
@@ -387,11 +422,11 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @raise [ArgumentError] if render_mode is not a valid render mode
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
-  #
   # @raise [LockedLayertError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
   # @version LayOut 2018
   def render_mode=(render_mode)
   end
@@ -437,12 +472,12 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @raise [ArgumentError] if the {Layout::SketchUpModel} view is not orthographic
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  # @raise [ArgumentError] if scale is less than 0.0000001
   #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [ArgumentError] if scale is less than 0.0000001
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
   #
   # @version LayOut 2018
   def scale=(scale)
@@ -510,11 +545,11 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @raise [ArgumentError] if view is not a valid standard view
   #
-  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::SketchUpModel} is locked
+  #
   # @version LayOut 2018
   def view=(view)
   end