sketchup-api-stubs 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/SketchUp/Geom/BoundingBox.rb +17 -20
  3. data/SketchUp/Geom/Bounds2d.rb +172 -0
  4. data/SketchUp/Geom/LatLong.rb +31 -16
  5. data/SketchUp/Geom/OrientedBounds2d.rb +102 -0
  6. data/SketchUp/Geom/Point2d.rb +365 -0
  7. data/SketchUp/Geom/Point3d.rb +121 -110
  8. data/SketchUp/Geom/PolygonMesh.rb +30 -21
  9. data/SketchUp/Geom/Transformation.rb +8 -4
  10. data/SketchUp/Geom/Transformation2d.rb +125 -0
  11. data/SketchUp/Geom/UTM.rb +43 -37
  12. data/SketchUp/Geom/Vector2d.rb +497 -0
  13. data/SketchUp/Geom/Vector3d.rb +143 -131
  14. data/SketchUp/Layout.rb +25 -0
  15. data/SketchUp/Layout/AngularDimension.rb +569 -0
  16. data/SketchUp/Layout/AutoTextDefinition.rb +417 -0
  17. data/SketchUp/Layout/AutoTextDefinitions.rb +186 -0
  18. data/SketchUp/Layout/ConnectionPoint.rb +70 -0
  19. data/SketchUp/Layout/Document.rb +458 -0
  20. data/SketchUp/Layout/Ellipse.rb +29 -0
  21. data/SketchUp/Layout/Entities.rb +155 -0
  22. data/SketchUp/Layout/Entity.rb +363 -0
  23. data/SketchUp/Layout/FormattedText.rb +349 -0
  24. data/SketchUp/Layout/Grid.rb +131 -0
  25. data/SketchUp/Layout/Group.rb +261 -0
  26. data/SketchUp/Layout/Image.rb +86 -0
  27. data/SketchUp/Layout/Label.rb +371 -0
  28. data/SketchUp/Layout/Layer.rb +222 -0
  29. data/SketchUp/Layout/LayerInstance.rb +128 -0
  30. data/SketchUp/Layout/Layers.rb +232 -0
  31. data/SketchUp/Layout/LinearDimension.rb +563 -0
  32. data/SketchUp/Layout/LockedEntityError.rb +10 -0
  33. data/SketchUp/Layout/LockedLayerError.rb +11 -0
  34. data/SketchUp/Layout/Page.rb +187 -0
  35. data/SketchUp/Layout/PageInfo.rb +393 -0
  36. data/SketchUp/Layout/Pages.rb +216 -0
  37. data/SketchUp/Layout/Path.rb +326 -0
  38. data/SketchUp/Layout/Rectangle.rb +174 -0
  39. data/SketchUp/Layout/SketchUpModel.rb +522 -0
  40. data/SketchUp/Layout/Style.rb +1520 -0
  41. data/SketchUp/Layout/Table.rb +290 -0
  42. data/SketchUp/Layout/TableCell.rb +149 -0
  43. data/SketchUp/Layout/TableColumn.rb +139 -0
  44. data/SketchUp/Layout/TableRow.rb +135 -0
  45. data/SketchUp/Sketchup/Animation.rb +7 -4
  46. data/SketchUp/Sketchup/ArcCurve.rb +10 -10
  47. data/SketchUp/Sketchup/AttributeDictionaries.rb +13 -4
  48. data/SketchUp/Sketchup/AttributeDictionary.rb +12 -12
  49. data/SketchUp/Sketchup/Color.rb +68 -78
  50. data/SketchUp/Sketchup/ComponentDefinition.rb +60 -60
  51. data/SketchUp/Sketchup/ComponentInstance.rb +57 -55
  52. data/SketchUp/Sketchup/DefinitionList.rb +34 -17
  53. data/SketchUp/Sketchup/Drawingelement.rb +19 -21
  54. data/SketchUp/Sketchup/Edge.rb +22 -24
  55. data/SketchUp/Sketchup/Entities.rb +173 -162
  56. data/SketchUp/Sketchup/Entity.rb +71 -55
  57. data/SketchUp/Sketchup/Face.rb +45 -44
  58. data/SketchUp/Sketchup/Group.rb +47 -49
  59. data/SketchUp/Sketchup/Image.rb +16 -0
  60. data/SketchUp/Sketchup/ImageRep.rb +226 -0
  61. data/SketchUp/Sketchup/InstancePath.rb +13 -13
  62. data/SketchUp/Sketchup/Layer.rb +15 -17
  63. data/SketchUp/Sketchup/Material.rb +40 -30
  64. data/SketchUp/Sketchup/Materials.rb +40 -22
  65. data/SketchUp/Sketchup/Menu.rb +5 -5
  66. data/SketchUp/Sketchup/Model.rb +230 -228
  67. data/SketchUp/Sketchup/Page.rb +32 -0
  68. data/SketchUp/Sketchup/Pages.rb +3 -4
  69. data/SketchUp/Sketchup/RenderingOptions.rb +21 -16
  70. data/SketchUp/Sketchup/SectionPlane.rb +64 -0
  71. data/SketchUp/Sketchup/Selection.rb +20 -28
  72. data/SketchUp/Sketchup/ShadowInfo.rb +14 -14
  73. data/SketchUp/Sketchup/Text.rb +24 -26
  74. data/SketchUp/Sketchup/Texture.rb +28 -12
  75. data/SketchUp/Sketchup/Vertex.rb +14 -11
  76. data/SketchUp/Sketchup/View.rb +126 -116
  77. data/SketchUp/UI/Command.rb +17 -17
  78. data/SketchUp/UI/HtmlDialog.rb +8 -5
  79. data/SketchUp/UI/Notification.rb +1 -1
  80. data/SketchUp/UI/Toolbar.rb +13 -14
  81. data/SketchUp/UI/WebDialog.rb +55 -59
  82. data/SketchUp/_top_level.rb +139 -27
  83. data/SketchUp/{Array.rb → array.rb} +167 -30
  84. data/SketchUp/{Geom.rb → geom.rb} +9 -7
  85. data/SketchUp/{LanguageHandler.rb → languagehandler.rb} +15 -15
  86. data/SketchUp/{Length.rb → length.rb} +15 -15
  87. data/SketchUp/{Numeric.rb → numeric.rb} +19 -19
  88. data/SketchUp/sketchup.rb +167 -156
  89. data/SketchUp/{SketchupExtension.rb → sketchupextension.rb} +27 -27
  90. data/SketchUp/{String.rb → string.rb} +1 -1
  91. data/SketchUp/ui.rb +113 -87
  92. metadata +46 -9
@@ -0,0 +1,1520 @@
1
+ # Copyright:: Copyright 2017 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # References a collection of style attributes that determine the visual
5
+ # appearance of {Layout::Entity}s. Style attributes are those attributes which
6
+ # the user can manipulate in LayOut's inspector windows. For example, shape
7
+ # style attributes that define stroke and fill, or text style attributes that
8
+ # define the font for {Layout::FormattedText}. The {Layout::Document} maintains
9
+ # a default style for various types of {Layout::Entity}s, and it is possible to
10
+ # apply the style of one entity to another. {Layout::Style} objects are
11
+ # transient and do not belong to a {Layout::Document}.
12
+ #
13
+ # @version LayOut 2018
14
+ class Layout::Style
15
+
16
+ # Constants
17
+
18
+ ALIGN_CENTER = nil # Stub value.
19
+ ALIGN_LEFT = nil # Stub value.
20
+ ALIGN_RIGHT = nil # Stub value.
21
+
22
+ ARCHITECTURAL_INCHES = nil # Stub value.
23
+
24
+ ANCHOR_BOTTOM = nil # Stub value.
25
+ ANCHOR_CENTER = nil # Stub value.
26
+ ANCHOR_TOP = nil # Stub value.
27
+
28
+ ARROW_FILLED_CIRCLE = nil # Stub value.
29
+ ARROW_FILLED_DIAMOND = nil # Stub value.
30
+ ARROW_FILLED_SKINNY_TRIANGLE = nil # Stub value.
31
+ ARROW_FILLED_SQUARE = nil # Stub value.
32
+ ARROW_FILLED_TRIANGLE = nil # Stub value.
33
+ ARROW_NONE = nil # Stub value.
34
+ ARROW_OPEN_ARROW_120 = nil # Stub value.
35
+ ARROW_OPEN_ARROW_90 = nil # Stub value.
36
+ ARROW_OPEN_CIRCLE = nil # Stub value.
37
+ ARROW_OPEN_DIAMOND = nil # Stub value.
38
+ ARROW_OPEN_SKINNY_TRIANGLE = nil # Stub value.
39
+ ARROW_OPEN_SQUARE = nil # Stub value.
40
+ ARROW_OPEN_TRIANGLE = nil # Stub value.
41
+ ARROW_OVERRUN = nil # Stub value.
42
+ ARROW_SLASH_LEFT = nil # Stub value.
43
+ ARROW_SLASH_RIGHT = nil # Stub value.
44
+ ARROW_STAR = nil # Stub value.
45
+ ARROW_T = nil # Stub value.
46
+ ARROW_UNDERRUN = nil # Stub value.
47
+
48
+ CAP_STYLE_FLAT = nil # Stub value.
49
+ CAP_STYLE_ROUND = nil # Stub value.
50
+ CAP_STYLE_SQUARE = nil # Stub value.
51
+
52
+ DECIMAL_CENTIMETERS = nil # Stub value.
53
+ DECIMAL_FEET = nil # Stub value.
54
+ DECIMAL_INCHES = nil # Stub value.
55
+ DECIMAL_METERS = nil # Stub value.
56
+ DECIMAL_MILLIMETERS = nil # Stub value.
57
+ DECIMAL_POINTS = nil # Stub value.
58
+
59
+ DEGREES = nil # Stub value.
60
+
61
+ DIMENSION_END_EXTENSION_LINE = nil # Stub value.
62
+ DIMENSION_LEADER_LINE = nil # Stub value.
63
+ DIMENSION_LINE = nil # Stub value.
64
+ DIMENSION_START_EXTENSION_LINE = nil # Stub value.
65
+ DIMENSION_TEXT = nil # Stub value.
66
+
67
+ DIMENSION_TEXT_ABOVE = nil # Stub value.
68
+ DIMENSION_TEXT_BELOW = nil # Stub value.
69
+ DIMENSION_TEXT_CENTER = nil # Stub value.
70
+ DIMENSION_TEXT_HORIZONTAL = nil # Stub value.
71
+ DIMENSION_TEXT_OFFSET = nil # Stub value.
72
+ DIMENSION_TEXT_PARALLEL = nil # Stub value.
73
+ DIMENSION_TEXT_PERPENDICULAR = nil # Stub value.
74
+ DIMENSION_TEXT_VERTICAL = nil # Stub value.
75
+
76
+ ENGINEERING_FEET = nil # Stub value.
77
+
78
+ FRACTIONAL_INCHES = nil # Stub value.
79
+
80
+ JOIN_STYLE_BEVEL = nil # Stub value.
81
+ JOIN_STYLE_MITER = nil # Stub value.
82
+ JOIN_STYLE_ROUND = nil # Stub value.
83
+
84
+ LABEL_LEADER_LINE = nil # Stub value.
85
+ LABEL_TEXT = nil # Stub value.
86
+
87
+ NORMAL_SCRIPT = nil # Stub value.
88
+
89
+ RADIANS = nil # Stub value.
90
+
91
+ SUPER_SCRIPT = nil # Stub value.
92
+
93
+ STROKE_PATTERN_CENTER = nil # Stub value.
94
+ STROKE_PATTERN_DASH = nil # Stub value.
95
+ STROKE_PATTERN_DASH_DASH_DOT = nil # Stub value.
96
+ STROKE_PATTERN_DASH_DASH_DOT_DOT = nil # Stub value.
97
+ STROKE_PATTERN_DASH_DASH_DOT_DOT_DOT = nil # Stub value.
98
+ STROKE_PATTERN_DASH_DOT = nil # Stub value.
99
+ STROKE_PATTERN_DASH_DOT_DOT = nil # Stub value.
100
+ STROKE_PATTERN_DASH_DOT_DOT_DOT = nil # Stub value.
101
+ STROKE_PATTERN_DASH_SPACE = nil # Stub value.
102
+ STROKE_PATTERN_DOT = nil # Stub value.
103
+ STROKE_PATTERN_PHANTOM = nil # Stub value.
104
+ STROKE_PATTERN_SOLID = nil # Stub value.
105
+
106
+ SUB_SCRIPT = nil # Stub value.
107
+
108
+ UNDERLINE_DOUBLE = nil # Stub value.
109
+ UNDERLINE_NONE = nil # Stub value.
110
+ UNDERLINE_SINGLE = nil # Stub value.
111
+
112
+ # Class Methods
113
+
114
+ # The {.arrow_type_filled?} method returns whether the specified arrow type is
115
+ # filled or not.
116
+ #
117
+ # The arrow type can be one of the following values:
118
+ # [+Layout::Style::ARROW_NONE+]
119
+ # [+Layout::Style::ARROW_FILLED_TRIANGLE+]
120
+ # [+Layout::Style::ARROW_OPEN_TRIANGLE+]
121
+ # [+Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE+]
122
+ # [+Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE+]
123
+ # [+Layout::Style::ARROW_OPEN_ARROW_90+]
124
+ # [+Layout::Style::ARROW_OPEN_ARROW_120+]
125
+ # [+Layout::Style::ARROW_FILLED_CIRCLE+]
126
+ # [+Layout::Style::ARROW_OPEN_CIRCLE+]
127
+ # [+Layout::Style::ARROW_FILLED_SQUARE+]
128
+ # [+Layout::Style::ARROW_OPEN_SQUARE+]
129
+ # [+Layout::Style::ARROW_FILLED_DIAMOND+]
130
+ # [+Layout::Style::ARROW_OPEN_DIAMOND+]
131
+ # [+Layout::Style::ARROW_STAR+]
132
+ # [+Layout::Style::ARROW_T+]
133
+ # [+Layout::Style::ARROW_SLASH_RIGHT+]
134
+ # [+Layout::Style::ARROW_SLASH_LEFT+]
135
+ # [+Layout::Style::ARROW_UNDERRUN+]
136
+ # [+Layout::Style::ARROW_OVERRUN+]
137
+ #
138
+ # @example
139
+ # # Returns false
140
+ # filled = Layout::Style.arrow_type_filled?(Layout::Style::ARROW_T)
141
+ # # Returns true
142
+ # filled = Layout::Style.arrow_type_filled?(Layout::Style::ARROW_FILLED_SQUARE)
143
+ #
144
+ # @return [Boolean]
145
+ #
146
+ # @return [Boolean]
147
+ #
148
+ # @version LayOut 2018
149
+ def self.arrow_type_filled?(arrow_type)
150
+ end
151
+
152
+ # Instance Methods
153
+
154
+ # The {#dimension_rotation_alignment} method returns the rotational text
155
+ # alignment for {Layout::LinearDimension} text, or +nil+ if the {Layout::Style}
156
+ # does not have a value for that setting.
157
+ #
158
+ # The rotational alignment type can be one of the following values:
159
+ # [+Layout::Style::DIMENSION_TEXT_HORIZONTAL+]
160
+ # [+Layout::Style::DIMENSION_TEXT_VERTICAL+]
161
+ # [+Layout::Style::DIMENSION_TEXT_PARALLEL+]
162
+ # [+Layout::Style::DIMENSION_TEXT_PERPENDICULAR+]
163
+ #
164
+ # @example
165
+ # doc = Layout::Document.open("C:/path/to/document.layout")
166
+ # page = doc.pages.first
167
+ # entity = page.entities.first
168
+ # style = entity.style
169
+ # dimension_alignment = style.dimension_rotation_alignment
170
+ #
171
+ # @return [Integer, nil]
172
+ #
173
+ # @version LayOut 2018
174
+ def dimension_rotation_alignment
175
+ end
176
+
177
+ # The {#dimension_rotation_alignment=} method sets the rotational text
178
+ # alignment.
179
+ #
180
+ # The rotational alignment type can be one of the following values:
181
+ # [+Layout::Style::DIMENSION_TEXT_HORIZONTAL+]
182
+ # [+Layout::Style::DIMENSION_TEXT_VERTICAL+]
183
+ # [+Layout::Style::DIMENSION_TEXT_PARALLEL+]
184
+ # [+Layout::Style::DIMENSION_TEXT_PERPENDICULAR+]
185
+ #
186
+ # @example
187
+ # doc = Layout::Document.open("C:/path/to/document.layout")
188
+ # page = doc.pages.first
189
+ # entity = page.entities.first
190
+ # style = entity.style
191
+ # style.dimension_rotation_alignment = Layout::Style::DIMENSION_TEXT_HORIZONTAL
192
+ # # Set the style to apply changes
193
+ # entity.style = style
194
+ #
195
+ # @param [Integer] alignment_type
196
+ #
197
+ # @raise [ArgumentError] if alignment_type is not a valid alignment type
198
+ #
199
+ # @version LayOut 2018
200
+ def dimension_rotation_alignment=(alignment_type)
201
+ end
202
+
203
+ # The {#dimension_units} method returns the unit format and precision for
204
+ # dimensions, or +nil+ if the {Layout::Style} does not have a value for that
205
+ # setting. Units may be for either {Layout::LinearDimension}s or
206
+ # {Layout::AngularDimension}s, but not both.
207
+ #
208
+ # The units can be one of the following values:
209
+ # [+Layout::Style::FRACTIONAL_INCHES+]
210
+ # [+Layout::Style::ARCHITECTURAL_INCHES+]
211
+ # [+Layout::Style::ENGINEERING_FEET+]
212
+ # [+Layout::Style::DECIMAL_INCHES+]
213
+ # [+Layout::Style::DECIMAL_FEET+]
214
+ # [+Layout::Style::DECIMAL_MILLIMETERS+]
215
+ # [+Layout::Style::DECIMAL_CENTIMETERS+]
216
+ # [+Layout::Style::DECIMAL_METERS+]
217
+ # [+Layout::Style::DECIMAL_POINTS+]
218
+ # [+Layout::Style::DEGREES+]
219
+ # [+Layout::Style::RADIANS+]
220
+ #
221
+ # @example
222
+ # doc = Layout::Document.open("C:/path/to/document.layout")
223
+ # page = doc.pages.first
224
+ # entity = page.entities.first
225
+ # style = entity.style
226
+ # units, precision = style.dimension_units
227
+ #
228
+ # @return [Array(Integer, Float), nil]
229
+ #
230
+ # @version LayOut 2018
231
+ def dimension_units
232
+ end
233
+
234
+ # The {#dimension_vertical_alignment} method returns the vertical text
235
+ # alignment for {Layout::LinearDimension} text, or +nil+ if the {Layout::Style}
236
+ # does not have a value for that setting.
237
+ #
238
+ # The vertical alignment type can be one of the following values:
239
+ # [+Layout::Style::DIMENSION_TEXT_ABOVE+]
240
+ # [+Layout::Style::DIMENSION_TEXT_CENTER+]
241
+ # [+Layout::Style::DIMENSION_TEXT_BELOW+]
242
+ # [+Layout::Style::DIMENSION_TEXT_OFFSET+]
243
+ #
244
+ # @example
245
+ # doc = Layout::Document.open("C:/path/to/document.layout")
246
+ # page = doc.pages.first
247
+ # entity = page.entities.first
248
+ # style = entity.style
249
+ # dimension_alignment = style.dimension_vertical_alignment
250
+ #
251
+ # @return [Integer, nil]
252
+ #
253
+ # @version LayOut 2018
254
+ def dimension_vertical_alignment
255
+ end
256
+
257
+ # The {#dimension_vertical_alignment=} method sets the vertical text
258
+ # alignment for {Layout::LinearDimension} text.
259
+ #
260
+ # The vertical alignment type can be one of the following values:
261
+ # [+Layout::Style::DIMENSION_TEXT_ABOVE+]
262
+ # [+Layout::Style::DIMENSION_TEXT_CENTER+]
263
+ # [+Layout::Style::DIMENSION_TEXT_BELOW+]
264
+ # [+Layout::Style::DIMENSION_TEXT_OFFSET+]
265
+ #
266
+ # @example
267
+ # doc = Layout::Document.open("C:/path/to/document.layout")
268
+ # page = doc.pages.first
269
+ # entity = page.entities.first
270
+ # style = entity.style
271
+ # style.dimension_vertical_alignment = Layout::Style::DIMENSION_TEXT_ABOVE
272
+ # # Set the style to apply changes
273
+ # entity.style = style
274
+ #
275
+ # @param [Integer] alignment_type
276
+ #
277
+ # @raise [ArgumentError] if alignment_type is not a valid alignment type
278
+ #
279
+ # @version LayOut 2018
280
+ def dimension_vertical_alignment=(alignment_type)
281
+ end
282
+
283
+ # The {#end_arrow_size} method returns the size of the end arrow, or +nil+ if
284
+ # the {Layout::Style} does not have a value for that setting.
285
+ #
286
+ # @example
287
+ # doc = Layout::Document.open("C:/path/to/document.layout")
288
+ # page = doc.pages.first
289
+ # entity = page.entities.first
290
+ # style = entity.style
291
+ # arrow_size = style.start_arrow_size
292
+ #
293
+ # @return [Float, nil]
294
+ #
295
+ # @version LayOut 2018
296
+ def end_arrow_size
297
+ end
298
+
299
+ # The {#end_arrow_size=} method sets the size of the end arrow. The minimum
300
+ # size is 0.25.
301
+ #
302
+ # @example
303
+ # doc = Layout::Document.open("C:/path/to/document.layout")
304
+ # page = doc.pages.first
305
+ # entity = page.entities.first
306
+ # style = entity.style
307
+ # style.end_arrow_size = 2.0
308
+ # # Set the style to apply changes
309
+ # entity.style = style
310
+ #
311
+ # @param [Float] arrow_size
312
+ #
313
+ # @raise [ArgumentError] if arrow_size is less than 0.25
314
+ #
315
+ # @version LayOut 2018
316
+ def end_arrow_size=(arrow_size)
317
+ end
318
+
319
+ # The {#end_arrow_type} method returns the type of end arrow, or +nil+ if
320
+ # the {Layout::Style} does not have a value for that setting.
321
+ #
322
+ # The arrow type can be one of the following values:
323
+ # [+Layout::Style::ARROW_NONE+]
324
+ # [+Layout::Style::ARROW_FILLED_TRIANGLE+]
325
+ # [+Layout::Style::ARROW_OPEN_TRIANGLE+]
326
+ # [+Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE+]
327
+ # [+Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE+]
328
+ # [+Layout::Style::ARROW_OPEN_ARROW_90+]
329
+ # [+Layout::Style::ARROW_OPEN_ARROW_120+]
330
+ # [+Layout::Style::ARROW_FILLED_CIRCLE+]
331
+ # [+Layout::Style::ARROW_OPEN_CIRCLE+]
332
+ # [+Layout::Style::ARROW_FILLED_SQUARE+]
333
+ # [+Layout::Style::ARROW_OPEN_SQUARE+]
334
+ # [+Layout::Style::ARROW_FILLED_DIAMOND+]
335
+ # [+Layout::Style::ARROW_OPEN_DIAMOND+]
336
+ # [+Layout::Style::ARROW_STAR+]
337
+ # [+Layout::Style::ARROW_T+]
338
+ # [+Layout::Style::ARROW_SLASH_RIGHT+]
339
+ # [+Layout::Style::ARROW_SLASH_LEFT+]
340
+ # [+Layout::Style::ARROW_UNDERRUN+]
341
+ # [+Layout::Style::ARROW_OVERRUN+]
342
+ #
343
+ # @example
344
+ # doc = Layout::Document.open("C:/path/to/document.layout")
345
+ # page = doc.pages.first
346
+ # entity = page.entities.first
347
+ # style = entity.style
348
+ # arrow_type = style.end_arrow_type
349
+ #
350
+ # @return [Integer, nil]
351
+ #
352
+ # @version LayOut 2018
353
+ def end_arrow_type
354
+ end
355
+
356
+ # The {#end_arrow_type=} method sets the type of end arrow.
357
+ #
358
+ # The arrow type can be one of the following values:
359
+ # [+Layout::Style::ARROW_NONE+]
360
+ # [+Layout::Style::ARROW_FILLED_TRIANGLE+]
361
+ # [+Layout::Style::ARROW_OPEN_TRIANGLE+]
362
+ # [+Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE+]
363
+ # [+Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE+]
364
+ # [+Layout::Style::ARROW_OPEN_ARROW_90+]
365
+ # [+Layout::Style::ARROW_OPEN_ARROW_120+]
366
+ # [+Layout::Style::ARROW_FILLED_CIRCLE+]
367
+ # [+Layout::Style::ARROW_OPEN_CIRCLE+]
368
+ # [+Layout::Style::ARROW_FILLED_SQUARE+]
369
+ # [+Layout::Style::ARROW_OPEN_SQUARE+]
370
+ # [+Layout::Style::ARROW_FILLED_DIAMOND+]
371
+ # [+Layout::Style::ARROW_OPEN_DIAMOND+]
372
+ # [+Layout::Style::ARROW_STAR+]
373
+ # [+Layout::Style::ARROW_T+]
374
+ # [+Layout::Style::ARROW_SLASH_RIGHT+]
375
+ # [+Layout::Style::ARROW_SLASH_LEFT+]
376
+ # [+Layout::Style::ARROW_UNDERRUN+]
377
+ # [+Layout::Style::ARROW_OVERRUN+]
378
+ #
379
+ # @example
380
+ # doc = Layout::Document.open("C:/path/to/document.layout")
381
+ # page = doc.pages.first
382
+ # entity = page.entities.first
383
+ # style = entity.style
384
+ # style.end_arrow_type = Layout::Style::ARROW_SLASH_LEFT
385
+ # # Set the style to apply changes
386
+ # entity.style = style
387
+ #
388
+ # @param [Integer] arrow_type
389
+ #
390
+ # @raise [ArgumentError] if arrow_type is not a valid arrow type
391
+ #
392
+ # @version LayOut 2018
393
+ def end_arrow_type=(arrow_type)
394
+ end
395
+
396
+ # The {#fill_color} method returns the solid file color, or +nil+ if the
397
+ # {Layout::Style} does not have a value for that setting.
398
+ #
399
+ # @example
400
+ # doc = Layout::Document.open("C:/path/to/document.layout")
401
+ # page = doc.pages.first
402
+ # entity = page.entities.first
403
+ # style = entity.style
404
+ # color = style.fill_color
405
+ #
406
+ # @return [Sketchup::Color, nil]
407
+ #
408
+ # @version LayOut 2018
409
+ def fill_color
410
+ end
411
+
412
+ # The {#fill_color=} method sets the solid fill color.
413
+ #
414
+ # @example
415
+ # doc = Layout::Document.open("C:/path/to/document.layout")
416
+ # page = doc.pages.first
417
+ # entity = page.entities.first
418
+ # style = entity.style
419
+ # style.solid_filled = true
420
+ # style.fill_color = Sketchup::Color.new(0, 255, 0, 255)
421
+ # # Set the style to apply changes
422
+ # entity.style = style
423
+ #
424
+ # @param [Sketchup::Color] fill_color
425
+ #
426
+ # @version LayOut 2018
427
+ def fill_color=(fill_color)
428
+ end
429
+
430
+ # The {#font_family} method returns the text font name, or +nil+ if the
431
+ # {Layout::Style} does not have a value for that setting.
432
+ #
433
+ # @example
434
+ # doc = Layout::Document.open("C:/path/to/document.layout")
435
+ # page = doc.pages.first
436
+ # entity = page.entities.first
437
+ # style = entity.style
438
+ # font_name = style.font_family
439
+ #
440
+ # @return [String, nil]
441
+ #
442
+ # @version LayOut 2018
443
+ def font_family
444
+ end
445
+
446
+ # The {#font_family=} method sets the text font name.
447
+ #
448
+ # @example
449
+ # doc = Layout::Document.open("C:/path/to/document.layout")
450
+ # page = doc.pages.first
451
+ # entity = page.entities.first
452
+ # style = entity.style
453
+ # style.font_family = "Verdana"
454
+ # # Set the style to apply changes
455
+ # entity.style = style
456
+ #
457
+ # @param [String] font_family
458
+ #
459
+ # @version LayOut 2018
460
+ def font_family=(font_family)
461
+ end
462
+
463
+ # The {#font_size} method returns the font size, or +nil+ if the
464
+ # {Layout::Style} does not have a value for that setting.
465
+ #
466
+ # @example
467
+ # doc = Layout::Document.open("C:/path/to/document.layout")
468
+ # page = doc.pages.first
469
+ # entity = page.entities.first
470
+ # style = entity.style
471
+ # font_size = style.font_size
472
+ #
473
+ # @return [Float, nil]
474
+ #
475
+ # @version LayOut 2018
476
+ def font_size
477
+ end
478
+
479
+ # The {#font_size=} method sets the font size.
480
+ #
481
+ # @example
482
+ # doc = Layout::Document.open("C:/path/to/document.layout")
483
+ # page = doc.pages.first
484
+ # entity = page.entities.first
485
+ # style = entity.style
486
+ # style.font_size = 12.0
487
+ # # Set the style to apply changes
488
+ # entity.style = style
489
+ #
490
+ # @param [Float] font_size
491
+ #
492
+ # @version LayOut 2018
493
+ def font_size=(font_size)
494
+ end
495
+
496
+ # The {#get_sub_style} method returns the {Layout::Style} for a sub-entity
497
+ # from the {Layout::Style}. This would be used to get the current style of a
498
+ # {Layout::LinearDimension}'s text, for example.
499
+ #
500
+ # @example
501
+ # doc = Layout::Document.open("C:/path/to/document.layout")
502
+ # page = doc.pages.first
503
+ # entity = page.entities.first
504
+ # style = entity.style
505
+ # sub_style = style.get_sub_style(Layout::Style::DIMENSION_TEXT)
506
+ #
507
+ # @param [Integer] type
508
+ #
509
+ # @raise [ArgumentError] if type is not a valid sub-entity type.
510
+ #
511
+ # @return [Layout::Style]
512
+ #
513
+ # @version LayOut 2018
514
+ def get_sub_style(type)
515
+ end
516
+
517
+ # The {#initialize} method creates a new {Layout::Style}.
518
+ #
519
+ # @example
520
+ # style = Layout::Style.new
521
+ #
522
+ # @return [Layout::Style]
523
+ #
524
+ # @version LayOut 2018
525
+ def initialize
526
+ end
527
+
528
+ # The {#pattern_fill_origin} method returns the starting piont for the pattern
529
+ # fill, or +nil+ if the {Layout::Style} does not have a value for that setting.
530
+ #
531
+ # @example
532
+ # doc = Layout::Document.open("C:/path/to/document.layout")
533
+ # page = doc.pages.first
534
+ # entity = page.entities.first
535
+ # style = entity.style
536
+ # origin = style.pattern_fill_origin
537
+ #
538
+ # @return [Geom::Point2d, nil]
539
+ #
540
+ # @version LayOut 2018
541
+ def pattern_fill_origin
542
+ end
543
+
544
+ # The {#pattern_fill_origin=} method sets the starting point for the pattern
545
+ # fill.
546
+ #
547
+ # @example
548
+ # doc = Layout::Document.open("C:/path/to/document.layout")
549
+ # page = doc.pages.first
550
+ # entity = page.entities.first
551
+ # style = entity.style
552
+ # style.pattern_filled = true
553
+ # style.pattern_fill_path = "C:/path/to/pattern.png"
554
+ # style.pattern_fill_origin = [2, 1]
555
+ # # Set the style to apply changes
556
+ # entity.style = style
557
+ #
558
+ # @param [Geom::Point2d] origin
559
+ #
560
+ # @version LayOut 2018
561
+ def pattern_fill_origin=(origin)
562
+ end
563
+
564
+ # The {#pattern_fill_path} method returns the file path to the pattern fill
565
+ # image, or +nil+ if the {Layout::Style} does not have a value for that setting.
566
+ #
567
+ # @example
568
+ # doc = Layout::Document.open("C:/path/to/document.layout")
569
+ # page = doc.pages.first
570
+ # entity = page.entities.first
571
+ # style = entity.style
572
+ # path = style.pattern_fill_path
573
+ #
574
+ # @return [String, nil]
575
+ #
576
+ # @version LayOut 2018
577
+ def pattern_fill_path
578
+ end
579
+
580
+ # The {#pattern_fill_path=} method sets the path to the image to use for the
581
+ # pattern fill.
582
+ #
583
+ # @example
584
+ # doc = Layout::Document.open("C:/path/to/document.layout")
585
+ # page = doc.pages.first
586
+ # entity = page.entities.first
587
+ # style = entity.style
588
+ # style.pattern_filled = true
589
+ # style.pattern_fill_path = "C:/path/to/pattern.png"
590
+ # # Set the style to apply changes
591
+ # entity.style = style
592
+ #
593
+ # @param [String] path
594
+ #
595
+ # @raise [ArgumentError] if the image specified by path could not be loaded
596
+ #
597
+ # @version LayOut 2018
598
+ def pattern_fill_path=(path)
599
+ end
600
+
601
+ # The {#pattern_fill_rotation} method returns the rotation of the pattern fill
602
+ # image in degrees, or +nil+ if the {Layout::Style} does not have a value for
603
+ # that setting.
604
+ #
605
+ # @example
606
+ # doc = Layout::Document.open("C:/path/to/document.layout")
607
+ # page = doc.pages.first
608
+ # entity = page.entities.first
609
+ # style = entity.style
610
+ # rotation = style.pattern_fill_rotation
611
+ #
612
+ # @return [Float, nil]
613
+ #
614
+ # @version LayOut 2018
615
+ def pattern_fill_rotation
616
+ end
617
+
618
+ # The {#pattern_fill_rotation=} method sets the rotation in degrees of the
619
+ # pattern fill image.
620
+ #
621
+ # @example
622
+ # doc = Layout::Document.open("C:/path/to/document.layout")
623
+ # page = doc.pages.first
624
+ # entity = page.entities.first
625
+ # style = entity.style
626
+ # style.pattern_filled = true
627
+ # style.pattern_fill_path = "C:/path/to/pattern.png"
628
+ # style.pattern_fill_rotation = -90.0
629
+ # # Set the style to apply changes
630
+ # entity.style = style
631
+ #
632
+ # @param [Float] rotation
633
+ #
634
+ # @version LayOut 2018
635
+ def pattern_fill_rotation=(rotation)
636
+ end
637
+
638
+ # The {#pattern_fill_scale} method returns the pattern fill scale, or +nil+
639
+ # if the {Layout::Style} does not have a value for that setting.
640
+ #
641
+ # @example
642
+ # doc = Layout::Document.open("C:/path/to/document.layout")
643
+ # page = doc.pages.first
644
+ # entity = page.entities.first
645
+ # style = entity.style
646
+ # scale = style.pattern_fill_scale
647
+ #
648
+ # @return [Float, nil]
649
+ #
650
+ # @version LayOut 2018
651
+ def pattern_fill_scale
652
+ end
653
+
654
+ # The {#pattern_fill_scale=} method sets the pattern fill scale.
655
+ #
656
+ # @example
657
+ # doc = Layout::Document.open("C:/path/to/document.layout")
658
+ # page = doc.pages.first
659
+ # entity = page.entities.first
660
+ # style = entity.style
661
+ # style.pattern_filled = true
662
+ # style.pattern_fill_path = "C:/path/to/pattern.png"
663
+ # style.pattern_fill_scale = 2.0
664
+ # # Set the style to apply changes
665
+ # entity.style = style
666
+ #
667
+ # @param [Float] scale
668
+ #
669
+ # @raise [ArgumentError] if scale is less than 0.1 or greater than 9999.0
670
+ #
671
+ # @version LayOut 2018
672
+ def pattern_fill_scale=(scale)
673
+ end
674
+
675
+ # The {#pattern_filled} method returns whether the {Layout::Style} has a
676
+ # pattern fill, or +nil+ if the {Layout::Style} does not have a value for that
677
+ # setting.
678
+ #
679
+ # @example
680
+ # doc = Layout::Document.open("C:/path/to/document.layout")
681
+ # page = doc.pages.first
682
+ # entity = page.entities.first
683
+ # style = entity.style
684
+ # is_filled = style.pattern_filled
685
+ #
686
+ # @return [Boolean, nil]
687
+ #
688
+ # @version LayOut 2018
689
+ def pattern_filled
690
+ end
691
+
692
+ # The {#pattern_filled=} method sets whether the {Layout::Style} has a pattern
693
+ # fill.
694
+ #
695
+ # @example
696
+ # doc = Layout::Document.open("C:/path/to/document.layout")
697
+ # page = doc.pages.first
698
+ # entity = page.entities.first
699
+ # style = entity.style
700
+ # style.pattern_filled = true
701
+ # style.pattern_fill_path = "C:/path/to/pattern.png"
702
+ # # Set the style to apply changes
703
+ # entity.style = style
704
+ #
705
+ # @param [Boolean] filled
706
+ #
707
+ # @version LayOut 2018
708
+ def pattern_filled=(filled)
709
+ end
710
+
711
+ # The {#set_dimension_units} method sets the unit format and precision for
712
+ # dimensions. Units may be for either {Layout::LinearDimension}s or
713
+ # {Layout::AngularDimension}s, but not both.
714
+ #
715
+ # The units can be one of the following values:
716
+ # [+Layout::Style::FRACTIONAL_INCHES+]
717
+ # [+Layout::Style::ARCHITECTURAL_INCHES+]
718
+ # [+Layout::Style::ENGINEERING_FEET+]
719
+ # [+Layout::Style::DECIMAL_INCHES+]
720
+ # [+Layout::Style::DECIMAL_FEET+]
721
+ # [+Layout::Style::DECIMAL_MILLIMETERS+]
722
+ # [+Layout::Style::DECIMAL_CENTIMETERS+]
723
+ # [+Layout::Style::DECIMAL_METERS+]
724
+ # [+Layout::Style::DECIMAL_POINTS+]
725
+ # [+Layout::Style::DEGREES+]
726
+ # [+Layout::Style::RADIANS+]
727
+ #
728
+ # @example
729
+ # doc = Layout::Document.open("C:/path/to/document.layout")
730
+ # page = doc.pages.first
731
+ # entity = page.entities.first
732
+ # style = entity.style
733
+ # precision = 0.0001
734
+ # units = Layout::Style::DECIMAL_MILLIMETERS
735
+ # style.set_dimension_units(units, precision)
736
+ #
737
+ # @param [Integer] units
738
+ #
739
+ # @param [Float] precision
740
+ #
741
+ # @raise [ArgumentError] if units is not a valid unit format
742
+ #
743
+ # @version LayOut 2018
744
+ def set_dimension_units(units, precision)
745
+ end
746
+
747
+ # The {#set_sub_style} method adds a {Layout::Style} to apply to a
748
+ # {Layout::Entity}'s sub-entity. This would be used to set the arrow type for
749
+ # extension lines of a {Layout::LinearDimension}, for example.
750
+ #
751
+ # @example
752
+ # doc = Layout::Document.open("C:/path/to/document.layout")
753
+ # page = doc.pages.first
754
+ # entity = page.entities.first
755
+ # style = entity.style
756
+ # sub_style = style.get_sub_style(Layout::Style::DIMENSION_TEXT)
757
+ # sub_style.dimension_vertical_alignment = Layout::Style::DIMENSION_TEXT_BELOW
758
+ # style.set_sub_style(Layout::Style::DIMENSION_TEXT, sub_style)
759
+ # # Set the style to apply changes
760
+ # entity.style = style
761
+ #
762
+ # @param [Integer] type
763
+ #
764
+ # @param [Layout::Style] sub_style
765
+ #
766
+ # @raise [ArgumentError] if type is not a valid sub-entity type.
767
+ #
768
+ # @version LayOut 2018
769
+ def set_sub_style(type, sub_style)
770
+ end
771
+
772
+ # The {#solid_filled} method returns whether the {Layout::Style} has a solid
773
+ # fill, or +nil+ if the {Layout::Style} does not have a value for that setting.
774
+ #
775
+ # @example
776
+ # doc = Layout::Document.open("C:/path/to/document.layout")
777
+ # page = doc.pages.first
778
+ # entity = page.entities.first
779
+ # style = entity.style
780
+ # is_filled = style.solid_filled
781
+ #
782
+ # @return [Boolean, nil]
783
+ #
784
+ # @version LayOut 2018
785
+ def solid_filled
786
+ end
787
+
788
+ # The {#solid_filled=} method sets whether the {Layout::Style} has a solid fill.
789
+ #
790
+ # @example
791
+ # doc = Layout::Document.open("C:/path/to/document.layout")
792
+ # page = doc.pages.first
793
+ # entity = page.entities.first
794
+ # style = entity.style
795
+ # style.solid_filled = true
796
+ # style.fill_color = Sketchup::Color.new(0, 255, 0, 255)
797
+ # # Set the style to apply changes
798
+ # entity.style = style
799
+ #
800
+ # @param [Boolean] filled
801
+ #
802
+ # @version LayOut 2018
803
+ def solid_filled=(filled)
804
+ end
805
+
806
+ # The {#start_arrow_size} method returns the size of the start arrow, or +nil+
807
+ # if the {Layout::Style} does not have a value for that setting.
808
+ #
809
+ # @example
810
+ # doc = Layout::Document.open("C:/path/to/document.layout")
811
+ # page = doc.pages.first
812
+ # entity = page.entities.first
813
+ # style = entity.style
814
+ # arrow_size = style.start_arrow_size
815
+ #
816
+ # @return [Float, nil]
817
+ #
818
+ # @version LayOut 2018
819
+ def start_arrow_size
820
+ end
821
+
822
+ # The {#start_arrow_size=} method sets the size of the start arrow. The minimum
823
+ # size is 0.25.
824
+ #
825
+ # @example
826
+ # doc = Layout::Document.open("C:/path/to/document.layout")
827
+ # page = doc.pages.first
828
+ # entity = page.entities.first
829
+ # style = entity.style
830
+ # style.start_arrow_size = 2.0
831
+ # # Set the style to apply changes
832
+ # entity.style = style
833
+ #
834
+ # @param [Float] arrow_size
835
+ #
836
+ # @raise [ArgumentError] if arrow_size is less than 0.25
837
+ #
838
+ # @version LayOut 2018
839
+ def start_arrow_size=(arrow_size)
840
+ end
841
+
842
+ # The {#start_arrow_type} method returns the type of start arrow, or +nil+ if
843
+ # the {Layout::Style} does not have a value for that setting.
844
+ #
845
+ # The arrow type can be one of the following values:
846
+ # [+Layout::Style::ARROW_NONE+]
847
+ # [+Layout::Style::ARROW_FILLED_TRIANGLE+]
848
+ # [+Layout::Style::ARROW_OPEN_TRIANGLE+]
849
+ # [+Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE+]
850
+ # [+Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE+]
851
+ # [+Layout::Style::ARROW_OPEN_ARROW_90+]
852
+ # [+Layout::Style::ARROW_OPEN_ARROW_120+]
853
+ # [+Layout::Style::ARROW_FILLED_CIRCLE+]
854
+ # [+Layout::Style::ARROW_OPEN_CIRCLE+]
855
+ # [+Layout::Style::ARROW_FILLED_SQUARE+]
856
+ # [+Layout::Style::ARROW_OPEN_SQUARE+]
857
+ # [+Layout::Style::ARROW_FILLED_DIAMOND+]
858
+ # [+Layout::Style::ARROW_OPEN_DIAMOND+]
859
+ # [+Layout::Style::ARROW_STAR+]
860
+ # [+Layout::Style::ARROW_T+]
861
+ # [+Layout::Style::ARROW_SLASH_RIGHT+]
862
+ # [+Layout::Style::ARROW_SLASH_LEFT+]
863
+ # [+Layout::Style::ARROW_UNDERRUN+]
864
+ # [+Layout::Style::ARROW_OVERRUN+]
865
+ #
866
+ # @example
867
+ # doc = Layout::Document.open("C:/path/to/document.layout")
868
+ # page = doc.pages.first
869
+ # entity = page.entities.first
870
+ # style = entity.style
871
+ # arrow_type = style.start_arrow_type
872
+ #
873
+ # @return [Integer, nil]
874
+ #
875
+ # @version LayOut 2018
876
+ def start_arrow_type
877
+ end
878
+
879
+ # The {#start_arrow_type=} method sets the type of start arrow.
880
+ #
881
+ # The arrow type can be one of the following values:
882
+ # [+Layout::Style::ARROW_NONE+]
883
+ # [+Layout::Style::ARROW_FILLED_TRIANGLE+]
884
+ # [+Layout::Style::ARROW_OPEN_TRIANGLE+]
885
+ # [+Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE+]
886
+ # [+Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE+]
887
+ # [+Layout::Style::ARROW_OPEN_ARROW_90+]
888
+ # [+Layout::Style::ARROW_OPEN_ARROW_120+]
889
+ # [+Layout::Style::ARROW_FILLED_CIRCLE+]
890
+ # [+Layout::Style::ARROW_OPEN_CIRCLE+]
891
+ # [+Layout::Style::ARROW_FILLED_SQUARE+]
892
+ # [+Layout::Style::ARROW_OPEN_SQUARE+]
893
+ # [+Layout::Style::ARROW_FILLED_DIAMOND+]
894
+ # [+Layout::Style::ARROW_OPEN_DIAMOND+]
895
+ # [+Layout::Style::ARROW_STAR+]
896
+ # [+Layout::Style::ARROW_T+]
897
+ # [+Layout::Style::ARROW_SLASH_RIGHT+]
898
+ # [+Layout::Style::ARROW_SLASH_LEFT+]
899
+ # [+Layout::Style::ARROW_UNDERRUN+]
900
+ # [+Layout::Style::ARROW_OVERRUN+]
901
+ #
902
+ # @example
903
+ # doc = Layout::Document.open("C:/path/to/document.layout")
904
+ # page = doc.pages.first
905
+ # entity = page.entities.first
906
+ # style = entity.style
907
+ # style.start_arrow_type = Layout::Style::ARROW_SLASH_RIGHT
908
+ # # Set the style to apply changes
909
+ # entity.style = style
910
+ #
911
+ # @param [Integer] arrow_type
912
+ #
913
+ # @raise [ArgumentError] if arrow_type is not a valid arrow type
914
+ #
915
+ # @version LayOut 2018
916
+ def start_arrow_type=(arrow_type)
917
+ end
918
+
919
+ # The {#stroke_cap_style} method returns the stroke cap style, or +nil+ if the
920
+ # {Layout::Style} does not have a value for that setting.
921
+ #
922
+ # The cap style can be one of the following:
923
+ # [+Layout::Style::CAP_STYLE_FLAT+]
924
+ # [+Layout::Style::CAP_STYLE_ROUND+]
925
+ # [+Layout::Style::CAP_STYLE_SQUARE+]
926
+ #
927
+ # @example
928
+ # doc = Layout::Document.open("C:/path/to/document.layout")
929
+ # page = doc.pages.first
930
+ # entity = page.entities.first
931
+ # style = entity.style
932
+ # cap_style = style.stroke_cap_style
933
+ #
934
+ # @return [Integer, nil]
935
+ #
936
+ # @version LayOut 2018
937
+ def stroke_cap_style
938
+ end
939
+
940
+ # The {#stroke_cap_style=} method sets the stroke cap style.
941
+ #
942
+ # The cap style can be one of the following:
943
+ # [+Layout::Style::CAP_STYLE_FLAT+]
944
+ # [+Layout::Style::CAP_STYLE_ROUND+]
945
+ # [+Layout::Style::CAP_STYLE_SQUARE+]
946
+ #
947
+ # @example
948
+ # doc = Layout::Document.open("C:/path/to/document.layout")
949
+ # page = doc.pages.first
950
+ # entity = page.entities.first
951
+ # style = entity.style
952
+ # style.stroke_cap_style = Layout::Style::CAP_STYLE_SQUARE
953
+ # # Set the style to apply changes
954
+ # entity.style = style
955
+ #
956
+ # @param [Integer] cap_style
957
+ #
958
+ # @raise [ArgumentError] if cap_style is not a valid cap style
959
+ #
960
+ # @version LayOut 2018
961
+ def stroke_cap_style=(cap_style)
962
+ end
963
+
964
+ # The {#stroke_color} method returns the stroke color, or +nil+ if the
965
+ # {Layout::Style} does not have a value for that setting.
966
+ #
967
+ # @example
968
+ # doc = Layout::Document.open("C:/path/to/document.layout")
969
+ # page = doc.pages.first
970
+ # entity = page.entities.first
971
+ # style = entity.style
972
+ # color = style.stroke_color
973
+ #
974
+ # @return [Sketchup::Color, nil]
975
+ #
976
+ # @version LayOut 2018
977
+ def stroke_color
978
+ end
979
+
980
+ # The {#stroke_color=} method sets the stroke color.
981
+ #
982
+ # @example
983
+ # doc = Layout::Document.open("C:/path/to/document.layout")
984
+ # page = doc.pages.first
985
+ # entity = page.entities.first
986
+ # style = entity.style
987
+ # style.stroke_color = Sketchup::Color.new(128, 128, 128, 255)
988
+ # # Set the style to apply changes
989
+ # entity.style = style
990
+ #
991
+ # @param [Sketchup::Color] stroke_color
992
+ #
993
+ # @version LayOut 2018
994
+ def stroke_color=(stroke_color)
995
+ end
996
+
997
+ # The {#stroke_join_style} method returns the stroke join style, or +nil+ if the
998
+ # {Layout::Style} does not have a value for that setting.
999
+ #
1000
+ # The join style can be one of the following:
1001
+ # [+Layout::Style::JOIN_STYLE_MITER+]
1002
+ # [+Layout::Style::JOIN_STYLE_ROUND+]
1003
+ # [+Layout::Style::JOIN_STYLE_BEVEL+]
1004
+ #
1005
+ # @example
1006
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1007
+ # page = doc.pages.first
1008
+ # entity = page.entities.first
1009
+ # style = entity.style
1010
+ # join_style = style.stroke_join_style
1011
+ #
1012
+ # @return [Integer, nil]
1013
+ #
1014
+ # @version LayOut 2018
1015
+ def stroke_join_style
1016
+ end
1017
+
1018
+ # The {#stroke_join_style=} method sets the stroke join style.
1019
+ #
1020
+ # The join style can be one of the following:
1021
+ # [+Layout::Style::JOIN_STYLE_MITER+]
1022
+ # [+Layout::Style::JOIN_STYLE_ROUND+]
1023
+ # [+Layout::Style::JOIN_STYLE_BEVEL+]
1024
+ #
1025
+ # @example
1026
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1027
+ # page = doc.pages.first
1028
+ # entity = page.entities.first
1029
+ # style = entity.style
1030
+ # style.stroke_join_style = Layout::Style::JOIN_STYLE_BEVEL
1031
+ # # Set the style to apply changes
1032
+ # entity.style = style
1033
+ #
1034
+ # @param [Integer] join_style
1035
+ #
1036
+ # @raise [ArgumentError] if join_style is not a valid join style
1037
+ #
1038
+ # @version LayOut 2018
1039
+ def stroke_join_style=(join_style)
1040
+ end
1041
+
1042
+ # The {#stroke_pattern} method returns the stroke pattern, or +nil+ if the
1043
+ # {Layout::Style} does not have a value for that setting.
1044
+ #
1045
+ # The stroke pattern can be one of the following:
1046
+ # [+Layout::Style::STROKE_PATTERN_SOLID+]
1047
+ # [+Layout::Style::STROKE_PATTERN_DASH+]
1048
+ # [+Layout::Style::STROKE_PATTERN_DOT+]
1049
+ # [+Layout::Style::STROKE_PATTERN_DASH_DOT+]
1050
+ # [+Layout::Style::STROKE_PATTERN_DASH_DOT_DOT+]
1051
+ # [+Layout::Style::STROKE_PATTERN_DASH_SPACE+]
1052
+ # [+Layout::Style::STROKE_PATTERN_DASH_DOT_DOT_DOT+]
1053
+ # [+Layout::Style::STROKE_PATTERN_DASH_DASH_DOT+]
1054
+ # [+Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT+]
1055
+ # [+Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT_DOT+]
1056
+ # [+Layout::Style::STROKE_PATTERN_CENTER+]
1057
+ # [+Layout::Style::STROKE_PATTERN_PHANTOM+]
1058
+ #
1059
+ # @example
1060
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1061
+ # page = doc.pages.first
1062
+ # entity = page.entities.first
1063
+ # style = entity.style
1064
+ # pattern = style.stroke_pattern
1065
+ #
1066
+ # @return [Integer, nil]
1067
+ #
1068
+ # @version LayOut 2018
1069
+ def stroke_pattern
1070
+ end
1071
+
1072
+ # The {#stroke_pattern=} method sets the stroke pattern.
1073
+ #
1074
+ # The stroke pattern can be one of the following:
1075
+ # [+Layout::Style::STROKE_PATTERN_SOLID+]
1076
+ # [+Layout::Style::STROKE_PATTERN_DASH+]
1077
+ # [+Layout::Style::STROKE_PATTERN_DOT+]
1078
+ # [+Layout::Style::STROKE_PATTERN_DASH_DOT+]
1079
+ # [+Layout::Style::STROKE_PATTERN_DASH_DOT_DOT+]
1080
+ # [+Layout::Style::STROKE_PATTERN_DASH_SPACE+]
1081
+ # [+Layout::Style::STROKE_PATTERN_DASH_DOT_DOT_DOT+]
1082
+ # [+Layout::Style::STROKE_PATTERN_DASH_DASH_DOT+]
1083
+ # [+Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT+]
1084
+ # [+Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT_DOT+]
1085
+ # [+Layout::Style::STROKE_PATTERN_CENTER+]
1086
+ # [+Layout::Style::STROKE_PATTERN_PHANTOM+]
1087
+ #
1088
+ # @example
1089
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1090
+ # page = doc.pages.first
1091
+ # entity = page.entities.first
1092
+ # style = entity.style
1093
+ # style.stroke_pattern = Layout::Style::CAP_STYLE_SQUARE
1094
+ # # Set the style to apply changes
1095
+ # entity.style = style
1096
+ #
1097
+ # @param [Integer] pattern
1098
+ #
1099
+ # @raise [ArgumentError] if pattern is not a valid stroke pattern
1100
+ #
1101
+ # @version LayOut 2018
1102
+ def stroke_pattern=(pattern)
1103
+ end
1104
+
1105
+ # The {#stroke_pattern_scale} method returns the stroke pattern scale, or +nil+
1106
+ # if the {Layout::Style} does not have a value for that setting.
1107
+ #
1108
+ # @example
1109
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1110
+ # page = doc.pages.first
1111
+ # entity = page.entities.first
1112
+ # style = entity.style
1113
+ # pattern_scale = style.stroke_pattern_scale
1114
+ #
1115
+ # @return [Float, nil]
1116
+ #
1117
+ # @version LayOut 2018
1118
+ def stroke_pattern_scale
1119
+ end
1120
+
1121
+ # The {#stroke_pattern_scale=} method sets the stroke pattern scale.
1122
+ #
1123
+ # @example
1124
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1125
+ # page = doc.pages.first
1126
+ # entity = page.entities.first
1127
+ # style = entity.style
1128
+ # style.stroke_pattern_scale = 2.0
1129
+ # # Set the style to apply changes
1130
+ # entity.style = style
1131
+ #
1132
+ # @param [Float] scale
1133
+ #
1134
+ # @raise [ArgumentError] if scale is less than 0.1 or greater than 9999.0
1135
+ #
1136
+ # @version LayOut 2018
1137
+ def stroke_pattern_scale=(scale)
1138
+ end
1139
+
1140
+ # The {#stroke_width} method returns the stroke width, or +nil+ if the
1141
+ # {Layout::Style} does not have a value for that setting.
1142
+ #
1143
+ # @example
1144
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1145
+ # page = doc.pages.first
1146
+ # entity = page.entities.first
1147
+ # style = entity.style
1148
+ # stroke_width = style.stroke_width
1149
+ #
1150
+ # @return [Float, nil]
1151
+ #
1152
+ # @version LayOut 2018
1153
+ def stroke_width
1154
+ end
1155
+
1156
+ # The {#stroke_width=} method sets the stroke width.
1157
+ #
1158
+ # @example
1159
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1160
+ # page = doc.pages.first
1161
+ # entity = page.entities.first
1162
+ # style = entity.style
1163
+ # style.stroke_width = 2.0
1164
+ # # Set the style to apply changes
1165
+ # entity.style = style
1166
+ #
1167
+ # @param [Float] stroke_width
1168
+ #
1169
+ # @raise [ArgumentError] if stroke_width is less than 0.0
1170
+ #
1171
+ # @version LayOut 2018
1172
+ def stroke_width=(stroke_width)
1173
+ end
1174
+
1175
+ # The {#stroked} method returns whether the {Layout::Style} has a stroke, or
1176
+ # +nil+ if the {Layout::Style} does not have a value for that setting.
1177
+ #
1178
+ # @example
1179
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1180
+ # page = doc.pages.first
1181
+ # entity = page.entities.first
1182
+ # style = entity.style
1183
+ # has_stroke = style.stroked
1184
+ #
1185
+ # @return [Boolean, nil]
1186
+ #
1187
+ # @version LayOut 2018
1188
+ def stroked
1189
+ end
1190
+
1191
+ # The {#stroked=} method sets whether the {Layout::Style} has a stroke.
1192
+ #
1193
+ # @example
1194
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1195
+ # page = doc.pages.first
1196
+ # entity = page.entities.first
1197
+ # style = entity.style
1198
+ # style.stroked = true
1199
+ # # Set the style to apply changes
1200
+ # entity.style = style
1201
+ #
1202
+ # @param [Boolean] stroked
1203
+ #
1204
+ # @version LayOut 2018
1205
+ def stroked=(stroked)
1206
+ end
1207
+
1208
+ # The {#suppress_dimension_units} method returns whether the units for
1209
+ # dimensions are suppressed, or +nil+ if the {Layout::Style} does not have a
1210
+ # value for that setting.
1211
+ #
1212
+ # @example
1213
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1214
+ # page = doc.pages.first
1215
+ # entity = page.entities.first
1216
+ # style = entity.style
1217
+ # suppressed = style.suppress_dimension_units
1218
+ #
1219
+ # @return [Boolean, nil]
1220
+ #
1221
+ # @version LayOut 2018
1222
+ def suppress_dimension_units
1223
+ end
1224
+
1225
+ # The {#suppress_dimension_units=} method sets whether the units for
1226
+ # dimensions are suppressed.
1227
+ #
1228
+ # @example
1229
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1230
+ # page = doc.pages.first
1231
+ # entity = page.entities.first
1232
+ # style = entity.style
1233
+ # style.suppress_dimension_units = true
1234
+ #
1235
+ # @param [Boolean] suppress
1236
+ #
1237
+ # @version LayOut 2018
1238
+ def suppress_dimension_units=(suppress)
1239
+ end
1240
+
1241
+ # The {#text_alignment} method returns the text alignment, or +nil+ if the
1242
+ # {Layout::Style} does not have a value for that setting.
1243
+ #
1244
+ # The alignment type can be one of the following values:
1245
+ # [+Layout::Style::ALIGN_LEFT+]
1246
+ # [+Layout::Style::ALIGN_RIGHT+]
1247
+ # [+Layout::Style::ALIGN_CENTER+]
1248
+ #
1249
+ # @example
1250
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1251
+ # page = doc.pages.first
1252
+ # entity = page.entities.first
1253
+ # style = entity.style
1254
+ # alignment = style.text_alignment
1255
+ #
1256
+ # @return [Integer, nil]
1257
+ #
1258
+ # @version LayOut 2018
1259
+ def text_alignment
1260
+ end
1261
+
1262
+ # The {#text_alignment=} method sets the text alignment.
1263
+ #
1264
+ # The alignment type can be one of the following values:
1265
+ # [+Layout::Style::ALIGN_LEFT+]
1266
+ # [+Layout::Style::ALIGN_RIGHT+]
1267
+ # [+Layout::Style::ALIGN_CENTER+]
1268
+ #
1269
+ # @example
1270
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1271
+ # page = doc.pages.first
1272
+ # entity = page.entities.first
1273
+ # style = entity.style
1274
+ # style.text_alignment = Layout::Style::ALIGN_CENTER
1275
+ # # Set the style to apply changes
1276
+ # entity.style = style
1277
+ #
1278
+ # @param [Integer] alignment_type
1279
+ #
1280
+ # @raise [ArgumentError] if alignment_type is not a valid alignment type
1281
+ #
1282
+ # @version LayOut 2018
1283
+ def text_alignment=(alignment_type)
1284
+ end
1285
+
1286
+ # The {#text_anchor} method returns the text anchor type, or +nil+ if the
1287
+ # {Layout::Style} does not have a value for that setting.
1288
+ #
1289
+ # The anchor type can be one of the following values:
1290
+ # [+Layout::Style::ANCHOR_TOP+]
1291
+ # [+Layout::Style::ANCHOR_CENTER+]
1292
+ # [+Layout::Style::ANCHOR_BOTTOM+]
1293
+ #
1294
+ # @example
1295
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1296
+ # page = doc.pages.first
1297
+ # entity = page.entities.first
1298
+ # style = entity.style
1299
+ # anchor_type = style.text_anchor
1300
+ #
1301
+ # @return [Integer, nil]
1302
+ #
1303
+ # @version LayOut 2018
1304
+ def text_anchor
1305
+ end
1306
+
1307
+ # The {#text_anchor=} method sets the text anchor type.
1308
+ #
1309
+ # The anchor type can be one of the following values:
1310
+ # [+Layout::Style::ANCHOR_TOP+]
1311
+ # [+Layout::Style::ANCHOR_CENTER+]
1312
+ # [+Layout::Style::ANCHOR_BOTTOM+]
1313
+ #
1314
+ # @example
1315
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1316
+ # page = doc.pages.first
1317
+ # entity = page.entities.first
1318
+ # style = entity.style
1319
+ # style.text_anchor = Layout::Style::ANCHOR_BOTTOM
1320
+ # # Set the style to apply changes
1321
+ # entity.style = style
1322
+ #
1323
+ # @param [Integer] anchor_type
1324
+ #
1325
+ # @raise [ArgumentError] if anchor_type is not a valid anchor type
1326
+ #
1327
+ # @version LayOut 2018
1328
+ def text_anchor=(anchor_type)
1329
+ end
1330
+
1331
+ # The {#text_bold} method returns whether text is bold, or +nil+ if the
1332
+ # {Layout::Style} does not have a value for that setting.
1333
+ #
1334
+ # @example
1335
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1336
+ # page = doc.pages.first
1337
+ # entity = page.entities.first
1338
+ # style = entity.style
1339
+ # bold = style.text_bold
1340
+ #
1341
+ # @return [Boolean, nil]
1342
+ #
1343
+ # @version LayOut 2018
1344
+ def text_bold
1345
+ end
1346
+
1347
+ # The {#text_bold=} method sets whether text is bold.
1348
+ #
1349
+ # @example
1350
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1351
+ # page = doc.pages.first
1352
+ # entity = page.entities.first
1353
+ # style = entity.style
1354
+ # style.text_bold = true
1355
+ # # Set the style to apply changes
1356
+ # entity.style = style
1357
+ #
1358
+ # @param [Boolean] bold
1359
+ #
1360
+ # @version LayOut 2018
1361
+ def text_bold=(bold)
1362
+ end
1363
+
1364
+ # The {#text_color} method returns the text color, or +nil+ if the
1365
+ # {Layout::Style} does not have a value for that setting.
1366
+ #
1367
+ # @example
1368
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1369
+ # page = doc.pages.first
1370
+ # entity = page.entities.first
1371
+ # style = entity.style
1372
+ # color = style.text_color
1373
+ #
1374
+ # @return [Sketchup::Color, nil]
1375
+ #
1376
+ # @version LayOut 2018
1377
+ def text_color
1378
+ end
1379
+
1380
+ # The {#text_color=} method sets the text color.
1381
+ #
1382
+ # @example
1383
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1384
+ # page = doc.pages.first
1385
+ # entity = page.entities.first
1386
+ # style = entity.style
1387
+ # style.text_color = Sketchup::Color.new(255, 0, 0, 255)
1388
+ # # Set the style to apply changes
1389
+ # entity.style = style
1390
+ #
1391
+ # @param [Sketchup::Color] color
1392
+ #
1393
+ # @version LayOut 2018
1394
+ def text_color=(color)
1395
+ end
1396
+
1397
+ # The {#text_elevation} method returns the text elevation, or +nil+ if the
1398
+ # {Layout::Style} does not have a value for that setting.
1399
+ #
1400
+ # The elevation type can be one of the following values:
1401
+ # [+Layout::Style::NORMAL_SCRIPT+]
1402
+ # [+Layout::Style::SUPER_SCRIPT+]
1403
+ # [+Layout::Style::SUB_SCRIPT+]
1404
+ #
1405
+ # @example
1406
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1407
+ # page = doc.pages.first
1408
+ # entity = page.entities.first
1409
+ # style = entity.style
1410
+ # elevation = style.text_elevation
1411
+ #
1412
+ # @return [Integer, nil]
1413
+ #
1414
+ # @version LayOut 2018
1415
+ def text_elevation
1416
+ end
1417
+
1418
+ # The {#text_elevation=} method sets the text elevation.
1419
+ #
1420
+ # The elevation type can be one of the following values:
1421
+ # [+Layout::Style::NORMAL_SCRIPT+]
1422
+ # [+Layout::Style::SUPER_SCRIPT+]
1423
+ # [+Layout::Style::SUB_SCRIPT+]
1424
+ #
1425
+ # @example
1426
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1427
+ # page = doc.pages.first
1428
+ # entity = page.entities.first
1429
+ # style = entity.style
1430
+ # style.text_elevation = Layout::Style::SUB_SCRIPT
1431
+ # # Set the style to apply changes
1432
+ # entity.style = style
1433
+ #
1434
+ # @param [Integer] elevation_type
1435
+ #
1436
+ # @raise [ArgumentError] if elevation_type is not a valid elevation type
1437
+ #
1438
+ # @version LayOut 2018
1439
+ def text_elevation=(elevation_type)
1440
+ end
1441
+
1442
+ # The {#text_italic} method returns whether text is italic, or +nil+ if the
1443
+ # {Layout::Style} does not have a value for that setting.
1444
+ #
1445
+ # @example
1446
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1447
+ # page = doc.pages.first
1448
+ # entity = page.entities.first
1449
+ # style = entity.style
1450
+ # italic = style.text_italic
1451
+ #
1452
+ # @return [Boolean, nil]
1453
+ #
1454
+ # @version LayOut 2018
1455
+ def text_italic
1456
+ end
1457
+
1458
+ # The {#text_italic=} method sets whether text is italic.
1459
+ #
1460
+ # @example
1461
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1462
+ # page = doc.pages.first
1463
+ # entity = page.entities.first
1464
+ # style = entity.style
1465
+ # style.text_italic = true
1466
+ # # Set the style to apply changes
1467
+ # entity.style = style
1468
+ #
1469
+ # @param [Boolean] italic
1470
+ #
1471
+ # @version LayOut 2018
1472
+ def text_italic=(italic)
1473
+ end
1474
+
1475
+ # The {#text_underline} method returns the text underline type, or +nil+ if the
1476
+ # {Layout::Style} does not have a value for that setting.
1477
+ #
1478
+ # The underline type can be one of the following values:
1479
+ # [+Layout::Style::UNDERLINE_NONE+]
1480
+ # [+Layout::Style::UNDERLINE_SINGLE+]
1481
+ # [+Layout::Style::UNDERLINE_DOUBLE+]
1482
+ #
1483
+ # @example
1484
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1485
+ # page = doc.pages.first
1486
+ # entity = page.entities.first
1487
+ # style = entity.style
1488
+ # underline_type = style.text_underline
1489
+ #
1490
+ # @return [Integer, nil]
1491
+ #
1492
+ # @version LayOut 2018
1493
+ def text_underline
1494
+ end
1495
+
1496
+ # The {#text_underline=} method sets the text underline type.
1497
+ #
1498
+ # The underline type can be one of the following values:
1499
+ # [+Layout::Style::UNDERLINE_NONE+]
1500
+ # [+Layout::Style::UNDERLINE_SINGLE+]
1501
+ # [+Layout::Style::UNDERLINE_DOUBLE+]
1502
+ #
1503
+ # @example
1504
+ # doc = Layout::Document.open("C:/path/to/document.layout")
1505
+ # page = doc.pages.first
1506
+ # entity = page.entities.first
1507
+ # style = entity.style
1508
+ # style.text_underline = Layout::Style::UNDERLINE_DOUBLE
1509
+ # # Set the style to apply changes
1510
+ # entity.style = style
1511
+ #
1512
+ # @param [Integer] underline_type
1513
+ #
1514
+ # @raise [ArgumentError] if underline_type is not a valid underline type
1515
+ #
1516
+ # @version LayOut 2018
1517
+ def text_underline=(underline_type)
1518
+ end
1519
+
1520
+ end