sketchup-api-stubs 0.7.8 → 0.7.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/sketchup-api-stubs/sketchup.rb +151 -148
- data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +509 -523
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -693
- data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
- data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -698
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -516
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -0
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -692
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Length.rb +278 -278
- data/lib/sketchup-api-stubs/stubs/Numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -144
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -619
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -426
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1205
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -272
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -937
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -468
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -407
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -326
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -112
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1651
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -477
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +255 -260
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -837
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1317
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1377 -1360
- data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/String.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -389
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -496
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -635
- data/lib/sketchup-api-stubs/stubs/UI.rb +683 -683
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
- data/lib/sketchup-api-stubs.rb +1 -1
- metadata +10 -7
@@ -1,387 +1,387 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# This is the interface to a {Layout::Document}'s paper space information. The
|
5
|
-
# paper size and margins, display resolution, and colors can all be accessed
|
6
|
-
# and set through this class.
|
7
|
-
#
|
8
|
-
# @example
|
9
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
10
|
-
# page_info = doc.page_info
|
11
|
-
# # Get the paper height and width and set the output resolution
|
12
|
-
# width = page_info.width
|
13
|
-
# height = page_info.height
|
14
|
-
# page_info.output_resolution = Layout::PageInfo::RESOLUTION_HIGH
|
15
|
-
#
|
16
|
-
# @version LayOut 2018
|
17
|
-
class Layout::PageInfo
|
18
|
-
|
19
|
-
# Constants
|
20
|
-
|
21
|
-
RESOLUTION_HIGH = nil # Stub value.
|
22
|
-
RESOLUTION_LOW = nil # Stub value.
|
23
|
-
RESOLUTION_MEDIUM = nil # Stub value.
|
24
|
-
|
25
|
-
# Instance Methods
|
26
|
-
|
27
|
-
# The {bottom_margin} method returns the paper's bottom margin in document
|
28
|
-
# units.
|
29
|
-
#
|
30
|
-
# @example
|
31
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
32
|
-
# bottom_margin = doc.page_info.bottom_margin
|
33
|
-
#
|
34
|
-
# @return [Numeric]
|
35
|
-
#
|
36
|
-
# @version LayOut 2018
|
37
|
-
def bottom_margin
|
38
|
-
end
|
39
|
-
|
40
|
-
# The {#bottom_margin=} method sets the paper's bottom margin in document units.
|
41
|
-
#
|
42
|
-
# @example
|
43
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
44
|
-
# doc.page_info.bottom_margin = 0.40
|
45
|
-
#
|
46
|
-
# @param [Numeric] margin
|
47
|
-
#
|
48
|
-
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
49
|
-
# height
|
50
|
-
#
|
51
|
-
# @version LayOut 2018
|
52
|
-
def bottom_margin=(margin)
|
53
|
-
end
|
54
|
-
|
55
|
-
# The {#color} method returns the paper's color.
|
56
|
-
#
|
57
|
-
# @example
|
58
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
59
|
-
# paper_color = Layout.page_info.color
|
60
|
-
#
|
61
|
-
# @return [Sketchup::Color]
|
62
|
-
#
|
63
|
-
# @version LayOut 2018
|
64
|
-
def color
|
65
|
-
end
|
66
|
-
|
67
|
-
# The {#color=} method sets the paper's color.
|
68
|
-
#
|
69
|
-
# @example
|
70
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
71
|
-
# doc.page_info.color = Sketchup::Color.new(45, 45, 75, 255)
|
72
|
-
#
|
73
|
-
# @param [Sketchup::Color] new_color
|
74
|
-
#
|
75
|
-
# @version LayOut 2018
|
76
|
-
def color=(new_color)
|
77
|
-
end
|
78
|
-
|
79
|
-
# The {#display_resolution} method returns the on screen rendering resolution
|
80
|
-
# quality.
|
81
|
-
#
|
82
|
-
# The resolution can be one of the following values:
|
83
|
-
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
84
|
-
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
85
|
-
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
86
|
-
#
|
87
|
-
# @example
|
88
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
89
|
-
# display_resolution = doc.page_info.display_resolution
|
90
|
-
#
|
91
|
-
# @return [Integer]
|
92
|
-
#
|
93
|
-
# @version LayOut 2018
|
94
|
-
def display_resolution
|
95
|
-
end
|
96
|
-
|
97
|
-
# The {#display_resolution=} method sets the on screen rendering resolution
|
98
|
-
# quality.
|
99
|
-
#
|
100
|
-
# The resolution can be one of the following values:
|
101
|
-
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
102
|
-
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
103
|
-
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
104
|
-
#
|
105
|
-
# @example
|
106
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
107
|
-
# doc.page_info.display_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
|
108
|
-
#
|
109
|
-
# @param [Integer] resolution
|
110
|
-
#
|
111
|
-
# @raise [ArgumentError] if resolution is not a valid resolution value
|
112
|
-
#
|
113
|
-
# @version LayOut 2018
|
114
|
-
def display_resolution=(resolution)
|
115
|
-
end
|
116
|
-
|
117
|
-
# The {#height} method returns the paper height in document units.
|
118
|
-
#
|
119
|
-
# @example
|
120
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
121
|
-
# height = doc.page_info.height
|
122
|
-
#
|
123
|
-
# @return [Numeric]
|
124
|
-
#
|
125
|
-
# @version LayOut 2018
|
126
|
-
def height
|
127
|
-
end
|
128
|
-
|
129
|
-
# The {#height=} method sets the paper height in document units.
|
130
|
-
#
|
131
|
-
# @example
|
132
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
133
|
-
# doc.page_info.height = 8.5
|
134
|
-
#
|
135
|
-
# @param [Numeric] height
|
136
|
-
#
|
137
|
-
# @raise [ArgumentError] if height is less than 1 or greater than 200
|
138
|
-
#
|
139
|
-
# @version LayOut 2018
|
140
|
-
def height=(height)
|
141
|
-
end
|
142
|
-
|
143
|
-
# The {#left_margin} method returns the paper's left margin in document units.
|
144
|
-
#
|
145
|
-
# @example
|
146
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
147
|
-
# left_margin = doc.page_info.left_margin
|
148
|
-
#
|
149
|
-
# @return [Numeric]
|
150
|
-
#
|
151
|
-
# @version LayOut 2018
|
152
|
-
def left_margin
|
153
|
-
end
|
154
|
-
|
155
|
-
# The {#left_margin=} method sets the paper's left margin in document units.
|
156
|
-
#
|
157
|
-
# @example
|
158
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
159
|
-
# doc.page_info.left_margin = 0.40
|
160
|
-
#
|
161
|
-
# @param [Numeric] margin
|
162
|
-
#
|
163
|
-
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
164
|
-
# width
|
165
|
-
#
|
166
|
-
# @version LayOut 2018
|
167
|
-
def left_margin=(margin)
|
168
|
-
end
|
169
|
-
|
170
|
-
# The {#margin_color} method returns the color of the paper's margin.
|
171
|
-
#
|
172
|
-
# @example
|
173
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
174
|
-
# margin_color = doc.page_info.margin_color
|
175
|
-
#
|
176
|
-
# @return [Sketchup::Color]
|
177
|
-
#
|
178
|
-
# @version LayOut 2018
|
179
|
-
def margin_color
|
180
|
-
end
|
181
|
-
|
182
|
-
# The {#margin_color=} sets the color of paper's margin.
|
183
|
-
#
|
184
|
-
# @example
|
185
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
186
|
-
# new_color = Sketchup::Color("Red")
|
187
|
-
# doc.page_info.margin_color = new_color
|
188
|
-
#
|
189
|
-
# @param [Sketchup::Color] color
|
190
|
-
#
|
191
|
-
# @version LayOut 2018
|
192
|
-
def margin_color=(color)
|
193
|
-
end
|
194
|
-
|
195
|
-
# The {#output_resolution} method returns the output rendering resolution
|
196
|
-
# quality.
|
197
|
-
#
|
198
|
-
# The resolution can be one of the following values:
|
199
|
-
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
200
|
-
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
201
|
-
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
202
|
-
#
|
203
|
-
# @example
|
204
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
205
|
-
# output_resolution = doc.page_info.output_resolution
|
206
|
-
#
|
207
|
-
# @return [Integer]
|
208
|
-
#
|
209
|
-
# @version LayOut 2018
|
210
|
-
def output_resolution
|
211
|
-
end
|
212
|
-
|
213
|
-
# The {#output_resolution=} method sets the output rendering resolution
|
214
|
-
# quality.
|
215
|
-
#
|
216
|
-
# The resolution can be one of the following values:
|
217
|
-
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
218
|
-
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
219
|
-
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
220
|
-
#
|
221
|
-
# @example
|
222
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
223
|
-
# doc.page_info.output_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
|
224
|
-
#
|
225
|
-
# @param [Integer] resolution
|
226
|
-
#
|
227
|
-
# @raise [ArgumentError] if resolution is not a valid resolution value
|
228
|
-
#
|
229
|
-
# @version LayOut 2018
|
230
|
-
def output_resolution=(resolution)
|
231
|
-
end
|
232
|
-
|
233
|
-
# The {#print_margins=} method sets whether to print the paper's margins.
|
234
|
-
#
|
235
|
-
# @example
|
236
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
237
|
-
# doc.page_info.print_margins=true
|
238
|
-
#
|
239
|
-
# @param [Boolean] print
|
240
|
-
#
|
241
|
-
# @version LayOut 2018
|
242
|
-
def print_margins=(print)
|
243
|
-
end
|
244
|
-
|
245
|
-
# The {#print_margins?} method returns whether to print the paper's margins.
|
246
|
-
#
|
247
|
-
# @example
|
248
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
249
|
-
# margins_printed = doc.page_info.print_margins?
|
250
|
-
#
|
251
|
-
# @return [Boolean]
|
252
|
-
#
|
253
|
-
# @version LayOut 2018
|
254
|
-
def print_margins?
|
255
|
-
end
|
256
|
-
|
257
|
-
# The {#print_paper_color=} method sets whether or not the page color should be
|
258
|
-
# printed.
|
259
|
-
#
|
260
|
-
# @example
|
261
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
262
|
-
# doc.page_info.print_color = true
|
263
|
-
#
|
264
|
-
# @param [Boolean] print_paper_color
|
265
|
-
#
|
266
|
-
# @version LayOut 2018
|
267
|
-
def print_paper_color=(print_paper_color)
|
268
|
-
end
|
269
|
-
|
270
|
-
# The {#print_paper_color?} method returns whether or not the page color should
|
271
|
-
# be printed.
|
272
|
-
#
|
273
|
-
# @example
|
274
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
275
|
-
# paper_color = doc.page_info.print_paper_color?
|
276
|
-
#
|
277
|
-
# @return [Boolean]
|
278
|
-
#
|
279
|
-
# @version LayOut 2018
|
280
|
-
def print_paper_color?
|
281
|
-
end
|
282
|
-
|
283
|
-
# The {#right_margin} method returns the paper's right margin in document units.
|
284
|
-
#
|
285
|
-
# @example
|
286
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
287
|
-
# right_margin = doc.page_info.right_margin
|
288
|
-
#
|
289
|
-
# @return [Numeric]
|
290
|
-
#
|
291
|
-
# @version LayOut 2018
|
292
|
-
def right_margin
|
293
|
-
end
|
294
|
-
|
295
|
-
# The {#right_margin=} sets the paper's right margin in document units.
|
296
|
-
#
|
297
|
-
# @example
|
298
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
299
|
-
# doc.page_info.right_margin = 0.40
|
300
|
-
#
|
301
|
-
# @param [Numeric] margin
|
302
|
-
#
|
303
|
-
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
304
|
-
# width
|
305
|
-
#
|
306
|
-
# @version LayOut 2018
|
307
|
-
def right_margin=(margin)
|
308
|
-
end
|
309
|
-
|
310
|
-
# The {#show_margins=} method sets whether the paper's margins are visible.
|
311
|
-
#
|
312
|
-
# @example
|
313
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
314
|
-
# doc.page_info.show_margins = false
|
315
|
-
#
|
316
|
-
# @param [Boolean] margins_visible
|
317
|
-
#
|
318
|
-
# @version LayOut 2018
|
319
|
-
def show_margins=(margins_visible)
|
320
|
-
end
|
321
|
-
|
322
|
-
# The {#show_margins?} method returns whether the paper's margins are visible.
|
323
|
-
#
|
324
|
-
# @example
|
325
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
326
|
-
# show_margins = doc.page_info.show_margins?
|
327
|
-
#
|
328
|
-
# @return [Boolean]
|
329
|
-
#
|
330
|
-
# @version LayOut 2018
|
331
|
-
def show_margins?
|
332
|
-
end
|
333
|
-
|
334
|
-
# The {#top_margin} method returns the paper's top margin in document units.
|
335
|
-
#
|
336
|
-
# @example
|
337
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
338
|
-
# top_margin = doc.page_info.top_margin
|
339
|
-
#
|
340
|
-
# @return [Numeric]
|
341
|
-
#
|
342
|
-
# @version LayOut 2018
|
343
|
-
def top_margin
|
344
|
-
end
|
345
|
-
|
346
|
-
# The {#top_margin} method sets the paper's top margin in document units.
|
347
|
-
#
|
348
|
-
# @example
|
349
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
350
|
-
# doc.page_info.top_margin = 0.40
|
351
|
-
#
|
352
|
-
# @param [Numeric] margin
|
353
|
-
#
|
354
|
-
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
355
|
-
# height
|
356
|
-
#
|
357
|
-
# @version LayOut 2018
|
358
|
-
def top_margin=(margin)
|
359
|
-
end
|
360
|
-
|
361
|
-
# The {#width} method returns the paper width in document units.
|
362
|
-
#
|
363
|
-
# @example
|
364
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
365
|
-
# width = doc.page_info.width
|
366
|
-
#
|
367
|
-
# @return [Numeric]
|
368
|
-
#
|
369
|
-
# @version LayOut 2018
|
370
|
-
def width
|
371
|
-
end
|
372
|
-
|
373
|
-
# The {#width=} method sets the paper width in document units.
|
374
|
-
#
|
375
|
-
# @example
|
376
|
-
# doc = Layout::Document.open("C:/path/to/document.layout")
|
377
|
-
# doc.page_info.width = 8.5
|
378
|
-
#
|
379
|
-
# @param [Numeric] width
|
380
|
-
#
|
381
|
-
# @raise [ArgumentError] if width is less than 1 or greater than 200
|
382
|
-
#
|
383
|
-
# @version LayOut 2018
|
384
|
-
def width=(width)
|
385
|
-
end
|
386
|
-
|
387
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This is the interface to a {Layout::Document}'s paper space information. The
|
5
|
+
# paper size and margins, display resolution, and colors can all be accessed
|
6
|
+
# and set through this class.
|
7
|
+
#
|
8
|
+
# @example
|
9
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
10
|
+
# page_info = doc.page_info
|
11
|
+
# # Get the paper height and width and set the output resolution
|
12
|
+
# width = page_info.width
|
13
|
+
# height = page_info.height
|
14
|
+
# page_info.output_resolution = Layout::PageInfo::RESOLUTION_HIGH
|
15
|
+
#
|
16
|
+
# @version LayOut 2018
|
17
|
+
class Layout::PageInfo
|
18
|
+
|
19
|
+
# Constants
|
20
|
+
|
21
|
+
RESOLUTION_HIGH = nil # Stub value.
|
22
|
+
RESOLUTION_LOW = nil # Stub value.
|
23
|
+
RESOLUTION_MEDIUM = nil # Stub value.
|
24
|
+
|
25
|
+
# Instance Methods
|
26
|
+
|
27
|
+
# The {bottom_margin} method returns the paper's bottom margin in document
|
28
|
+
# units.
|
29
|
+
#
|
30
|
+
# @example
|
31
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
32
|
+
# bottom_margin = doc.page_info.bottom_margin
|
33
|
+
#
|
34
|
+
# @return [Numeric]
|
35
|
+
#
|
36
|
+
# @version LayOut 2018
|
37
|
+
def bottom_margin
|
38
|
+
end
|
39
|
+
|
40
|
+
# The {#bottom_margin=} method sets the paper's bottom margin in document units.
|
41
|
+
#
|
42
|
+
# @example
|
43
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
44
|
+
# doc.page_info.bottom_margin = 0.40
|
45
|
+
#
|
46
|
+
# @param [Numeric] margin
|
47
|
+
#
|
48
|
+
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
49
|
+
# height
|
50
|
+
#
|
51
|
+
# @version LayOut 2018
|
52
|
+
def bottom_margin=(margin)
|
53
|
+
end
|
54
|
+
|
55
|
+
# The {#color} method returns the paper's color.
|
56
|
+
#
|
57
|
+
# @example
|
58
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
59
|
+
# paper_color = Layout.page_info.color
|
60
|
+
#
|
61
|
+
# @return [Sketchup::Color]
|
62
|
+
#
|
63
|
+
# @version LayOut 2018
|
64
|
+
def color
|
65
|
+
end
|
66
|
+
|
67
|
+
# The {#color=} method sets the paper's color.
|
68
|
+
#
|
69
|
+
# @example
|
70
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
71
|
+
# doc.page_info.color = Sketchup::Color.new(45, 45, 75, 255)
|
72
|
+
#
|
73
|
+
# @param [Sketchup::Color] new_color
|
74
|
+
#
|
75
|
+
# @version LayOut 2018
|
76
|
+
def color=(new_color)
|
77
|
+
end
|
78
|
+
|
79
|
+
# The {#display_resolution} method returns the on screen rendering resolution
|
80
|
+
# quality.
|
81
|
+
#
|
82
|
+
# The resolution can be one of the following values:
|
83
|
+
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
84
|
+
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
85
|
+
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
86
|
+
#
|
87
|
+
# @example
|
88
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
89
|
+
# display_resolution = doc.page_info.display_resolution
|
90
|
+
#
|
91
|
+
# @return [Integer]
|
92
|
+
#
|
93
|
+
# @version LayOut 2018
|
94
|
+
def display_resolution
|
95
|
+
end
|
96
|
+
|
97
|
+
# The {#display_resolution=} method sets the on screen rendering resolution
|
98
|
+
# quality.
|
99
|
+
#
|
100
|
+
# The resolution can be one of the following values:
|
101
|
+
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
102
|
+
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
103
|
+
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
104
|
+
#
|
105
|
+
# @example
|
106
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
107
|
+
# doc.page_info.display_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
|
108
|
+
#
|
109
|
+
# @param [Integer] resolution
|
110
|
+
#
|
111
|
+
# @raise [ArgumentError] if resolution is not a valid resolution value
|
112
|
+
#
|
113
|
+
# @version LayOut 2018
|
114
|
+
def display_resolution=(resolution)
|
115
|
+
end
|
116
|
+
|
117
|
+
# The {#height} method returns the paper height in document units.
|
118
|
+
#
|
119
|
+
# @example
|
120
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
121
|
+
# height = doc.page_info.height
|
122
|
+
#
|
123
|
+
# @return [Numeric]
|
124
|
+
#
|
125
|
+
# @version LayOut 2018
|
126
|
+
def height
|
127
|
+
end
|
128
|
+
|
129
|
+
# The {#height=} method sets the paper height in document units.
|
130
|
+
#
|
131
|
+
# @example
|
132
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
133
|
+
# doc.page_info.height = 8.5
|
134
|
+
#
|
135
|
+
# @param [Numeric] height
|
136
|
+
#
|
137
|
+
# @raise [ArgumentError] if height is less than 1 or greater than 200
|
138
|
+
#
|
139
|
+
# @version LayOut 2018
|
140
|
+
def height=(height)
|
141
|
+
end
|
142
|
+
|
143
|
+
# The {#left_margin} method returns the paper's left margin in document units.
|
144
|
+
#
|
145
|
+
# @example
|
146
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
147
|
+
# left_margin = doc.page_info.left_margin
|
148
|
+
#
|
149
|
+
# @return [Numeric]
|
150
|
+
#
|
151
|
+
# @version LayOut 2018
|
152
|
+
def left_margin
|
153
|
+
end
|
154
|
+
|
155
|
+
# The {#left_margin=} method sets the paper's left margin in document units.
|
156
|
+
#
|
157
|
+
# @example
|
158
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
159
|
+
# doc.page_info.left_margin = 0.40
|
160
|
+
#
|
161
|
+
# @param [Numeric] margin
|
162
|
+
#
|
163
|
+
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
164
|
+
# width
|
165
|
+
#
|
166
|
+
# @version LayOut 2018
|
167
|
+
def left_margin=(margin)
|
168
|
+
end
|
169
|
+
|
170
|
+
# The {#margin_color} method returns the color of the paper's margin.
|
171
|
+
#
|
172
|
+
# @example
|
173
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
174
|
+
# margin_color = doc.page_info.margin_color
|
175
|
+
#
|
176
|
+
# @return [Sketchup::Color]
|
177
|
+
#
|
178
|
+
# @version LayOut 2018
|
179
|
+
def margin_color
|
180
|
+
end
|
181
|
+
|
182
|
+
# The {#margin_color=} sets the color of paper's margin.
|
183
|
+
#
|
184
|
+
# @example
|
185
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
186
|
+
# new_color = Sketchup::Color("Red")
|
187
|
+
# doc.page_info.margin_color = new_color
|
188
|
+
#
|
189
|
+
# @param [Sketchup::Color] color
|
190
|
+
#
|
191
|
+
# @version LayOut 2018
|
192
|
+
def margin_color=(color)
|
193
|
+
end
|
194
|
+
|
195
|
+
# The {#output_resolution} method returns the output rendering resolution
|
196
|
+
# quality.
|
197
|
+
#
|
198
|
+
# The resolution can be one of the following values:
|
199
|
+
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
200
|
+
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
201
|
+
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
202
|
+
#
|
203
|
+
# @example
|
204
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
205
|
+
# output_resolution = doc.page_info.output_resolution
|
206
|
+
#
|
207
|
+
# @return [Integer]
|
208
|
+
#
|
209
|
+
# @version LayOut 2018
|
210
|
+
def output_resolution
|
211
|
+
end
|
212
|
+
|
213
|
+
# The {#output_resolution=} method sets the output rendering resolution
|
214
|
+
# quality.
|
215
|
+
#
|
216
|
+
# The resolution can be one of the following values:
|
217
|
+
# [+Layout::PageInfo::RESOLUTION_LOW+]
|
218
|
+
# [+Layout::PageInfo::RESOLUTION_MEDIUM+]
|
219
|
+
# [+Layout::PageInfo::RESOLUTION_HIGH+]
|
220
|
+
#
|
221
|
+
# @example
|
222
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
223
|
+
# doc.page_info.output_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
|
224
|
+
#
|
225
|
+
# @param [Integer] resolution
|
226
|
+
#
|
227
|
+
# @raise [ArgumentError] if resolution is not a valid resolution value
|
228
|
+
#
|
229
|
+
# @version LayOut 2018
|
230
|
+
def output_resolution=(resolution)
|
231
|
+
end
|
232
|
+
|
233
|
+
# The {#print_margins=} method sets whether to print the paper's margins.
|
234
|
+
#
|
235
|
+
# @example
|
236
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
237
|
+
# doc.page_info.print_margins=true
|
238
|
+
#
|
239
|
+
# @param [Boolean] print
|
240
|
+
#
|
241
|
+
# @version LayOut 2018
|
242
|
+
def print_margins=(print)
|
243
|
+
end
|
244
|
+
|
245
|
+
# The {#print_margins?} method returns whether to print the paper's margins.
|
246
|
+
#
|
247
|
+
# @example
|
248
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
249
|
+
# margins_printed = doc.page_info.print_margins?
|
250
|
+
#
|
251
|
+
# @return [Boolean]
|
252
|
+
#
|
253
|
+
# @version LayOut 2018
|
254
|
+
def print_margins?
|
255
|
+
end
|
256
|
+
|
257
|
+
# The {#print_paper_color=} method sets whether or not the page color should be
|
258
|
+
# printed.
|
259
|
+
#
|
260
|
+
# @example
|
261
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
262
|
+
# doc.page_info.print_color = true
|
263
|
+
#
|
264
|
+
# @param [Boolean] print_paper_color
|
265
|
+
#
|
266
|
+
# @version LayOut 2018
|
267
|
+
def print_paper_color=(print_paper_color)
|
268
|
+
end
|
269
|
+
|
270
|
+
# The {#print_paper_color?} method returns whether or not the page color should
|
271
|
+
# be printed.
|
272
|
+
#
|
273
|
+
# @example
|
274
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
275
|
+
# paper_color = doc.page_info.print_paper_color?
|
276
|
+
#
|
277
|
+
# @return [Boolean]
|
278
|
+
#
|
279
|
+
# @version LayOut 2018
|
280
|
+
def print_paper_color?
|
281
|
+
end
|
282
|
+
|
283
|
+
# The {#right_margin} method returns the paper's right margin in document units.
|
284
|
+
#
|
285
|
+
# @example
|
286
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
287
|
+
# right_margin = doc.page_info.right_margin
|
288
|
+
#
|
289
|
+
# @return [Numeric]
|
290
|
+
#
|
291
|
+
# @version LayOut 2018
|
292
|
+
def right_margin
|
293
|
+
end
|
294
|
+
|
295
|
+
# The {#right_margin=} sets the paper's right margin in document units.
|
296
|
+
#
|
297
|
+
# @example
|
298
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
299
|
+
# doc.page_info.right_margin = 0.40
|
300
|
+
#
|
301
|
+
# @param [Numeric] margin
|
302
|
+
#
|
303
|
+
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
304
|
+
# width
|
305
|
+
#
|
306
|
+
# @version LayOut 2018
|
307
|
+
def right_margin=(margin)
|
308
|
+
end
|
309
|
+
|
310
|
+
# The {#show_margins=} method sets whether the paper's margins are visible.
|
311
|
+
#
|
312
|
+
# @example
|
313
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
314
|
+
# doc.page_info.show_margins = false
|
315
|
+
#
|
316
|
+
# @param [Boolean] margins_visible
|
317
|
+
#
|
318
|
+
# @version LayOut 2018
|
319
|
+
def show_margins=(margins_visible)
|
320
|
+
end
|
321
|
+
|
322
|
+
# The {#show_margins?} method returns whether the paper's margins are visible.
|
323
|
+
#
|
324
|
+
# @example
|
325
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
326
|
+
# show_margins = doc.page_info.show_margins?
|
327
|
+
#
|
328
|
+
# @return [Boolean]
|
329
|
+
#
|
330
|
+
# @version LayOut 2018
|
331
|
+
def show_margins?
|
332
|
+
end
|
333
|
+
|
334
|
+
# The {#top_margin} method returns the paper's top margin in document units.
|
335
|
+
#
|
336
|
+
# @example
|
337
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
338
|
+
# top_margin = doc.page_info.top_margin
|
339
|
+
#
|
340
|
+
# @return [Numeric]
|
341
|
+
#
|
342
|
+
# @version LayOut 2018
|
343
|
+
def top_margin
|
344
|
+
end
|
345
|
+
|
346
|
+
# The {#top_margin} method sets the paper's top margin in document units.
|
347
|
+
#
|
348
|
+
# @example
|
349
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
350
|
+
# doc.page_info.top_margin = 0.40
|
351
|
+
#
|
352
|
+
# @param [Numeric] margin
|
353
|
+
#
|
354
|
+
# @raise [ArgumentError] if margin is less than 0 or greater than the page
|
355
|
+
# height
|
356
|
+
#
|
357
|
+
# @version LayOut 2018
|
358
|
+
def top_margin=(margin)
|
359
|
+
end
|
360
|
+
|
361
|
+
# The {#width} method returns the paper width in document units.
|
362
|
+
#
|
363
|
+
# @example
|
364
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
365
|
+
# width = doc.page_info.width
|
366
|
+
#
|
367
|
+
# @return [Numeric]
|
368
|
+
#
|
369
|
+
# @version LayOut 2018
|
370
|
+
def width
|
371
|
+
end
|
372
|
+
|
373
|
+
# The {#width=} method sets the paper width in document units.
|
374
|
+
#
|
375
|
+
# @example
|
376
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
377
|
+
# doc.page_info.width = 8.5
|
378
|
+
#
|
379
|
+
# @param [Numeric] width
|
380
|
+
#
|
381
|
+
# @raise [ArgumentError] if width is less than 1 or greater than 200
|
382
|
+
#
|
383
|
+
# @version LayOut 2018
|
384
|
+
def width=(width)
|
385
|
+
end
|
386
|
+
|
387
|
+
end
|