sketchup-api-stubs 0.7.4 → 0.7.5

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