sketchup-api-stubs 0.6.1 → 0.7.4

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 (149) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -0
  3. data/lib/sketchup-api-stubs.rb +1 -1
  4. data/lib/sketchup-api-stubs/sketchup.rb +145 -145
  5. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
  6. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  7. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  8. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -401
  10. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  11. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  13. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  14. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -523
  16. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
  17. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -569
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -455
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -359
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -123
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -86
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +371 -371
  31. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  32. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  33. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +220 -232
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -563
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  37. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  38. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  39. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +204 -216
  40. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  41. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  42. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -547
  43. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  44. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  45. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  48. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +140 -140
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -554
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1097
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -537
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -262
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -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 -123
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1483
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -282
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -650
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -356
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -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 +57 -57
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -995
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
  134. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
  135. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
  136. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
  137. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  138. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
  139. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -303
  140. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  141. data/lib/sketchup-api-stubs/stubs/geom.rb +348 -233
  142. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  143. data/lib/sketchup-api-stubs/stubs/length.rb +278 -262
  144. data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
  145. data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
  146. data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
  147. data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
  148. data/lib/sketchup-api-stubs/stubs/ui.rb +667 -660
  149. metadata +2 -16
@@ -1,43 +1,43 @@
1
- # Copyright:: Copyright 2019 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The {Sketchup::RegionalSettings} module contains methods getting information about the
5
- # user's locale settings.
6
- #
7
- # Note that when you convert between units and strings you don't need to parse
8
- # it yourself and you can instead use {String#to_l} and {Length#to_s}.
9
- #
10
- # @version SketchUp 2016 M1
11
- module Sketchup::RegionalSettings
12
-
13
- # Class Methods
14
-
15
- # Returns the decimal character for the current user's locale.
16
- #
17
- # @example
18
- # # Format a Float using the user's locale settings.
19
- # # Ruby's Float.to_s always use period as decimal separator.
20
- # formatted = 0.123.to_s.tr('.', Sketchup::RegionalSettings.decimal_separator)
21
- #
22
- # @return [String] the decimal separator character
23
- #
24
- # @version SketchUp 2016 M1
25
- def self.decimal_separator
26
- end
27
-
28
- # Returns the list separator character for the current user's locale.
29
- #
30
- # @example
31
- # # Format a CSV list in user's locale:
32
- # decimal = Sketchup::RegionalSettings.decimal_separator
33
- # list = Sketchup::RegionalSettings.list_separator
34
- # row = [3.14, 1.618, 2.718]
35
- # csv = row.map { |value| value.to_s.tr('.', decimal) }.join(list)
36
- #
37
- # @return [String] the list separator character
38
- #
39
- # @version SketchUp 2016 M1
40
- def self.list_separator
41
- end
42
-
43
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The {Sketchup::RegionalSettings} module contains methods getting information about the
5
+ # user's locale settings.
6
+ #
7
+ # Note that when you convert between units and strings you don't need to parse
8
+ # it yourself and you can instead use {String#to_l} and {Length#to_s}.
9
+ #
10
+ # @version SketchUp 2016 M1
11
+ module Sketchup::RegionalSettings
12
+
13
+ # Class Methods
14
+
15
+ # Returns the decimal character for the current user's locale.
16
+ #
17
+ # @example
18
+ # # Format a Float using the user's locale settings.
19
+ # # Ruby's Float.to_s always use period as decimal separator.
20
+ # formatted = 0.123.to_s.tr('.', Sketchup::RegionalSettings.decimal_separator)
21
+ #
22
+ # @return [String] the decimal separator character
23
+ #
24
+ # @version SketchUp 2016 M1
25
+ def self.decimal_separator
26
+ end
27
+
28
+ # Returns the list separator character for the current user's locale.
29
+ #
30
+ # @example
31
+ # # Format a CSV list in user's locale:
32
+ # decimal = Sketchup::RegionalSettings.decimal_separator
33
+ # list = Sketchup::RegionalSettings.list_separator
34
+ # row = [3.14, 1.618, 2.718]
35
+ # csv = row.map { |value| value.to_s.tr('.', decimal) }.join(list)
36
+ #
37
+ # @return [String] the list separator character
38
+ #
39
+ # @version SketchUp 2016 M1
40
+ def self.list_separator
41
+ end
42
+
43
+ end
@@ -1,356 +1,364 @@
1
- # Copyright:: Copyright 2019 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The RenderingOptions class contains method to extract the rendering
5
- # information for a model. The majority of the rendering information returned
6
- # exists in the Styles dialog. The following
7
- # rendering information keys are maintained in SketchUp:
8
- #
9
- # - +BackgroundColor+
10
- # - +BandColor+
11
- # - +ConstructionColor+
12
- # - +DepthQueWidth+
13
- # - +DisplayColorByLayer+
14
- # - +DisplayFog+
15
- # - +DisplayInstanceAxes+
16
- # - +DisplayWatermarks+
17
- # - +DrawDepthQue+
18
- # - +DrawGround+
19
- # - +DrawHidden+
20
- # - +DrawHorizon+
21
- # - +DrawLineEnds+
22
- # - +DrawProfilesOnly+
23
- # - +DrawSilhouettes+
24
- # - +DrawUnderground+
25
- # - +EdgeColorMode+
26
- # - +EdgeDisplayMode+
27
- # - +EdgeType+
28
- # - +ExtendLines+
29
- # - +FaceBackColor+
30
- # - +FaceFrontColor+
31
- # - +FogColor+
32
- # - +FogEndDist+
33
- # - +FogStartDist+
34
- # - +FogUseBkColor+
35
- # - +ForegroundColor+
36
- # - +GroundColor+
37
- # - +GroundTransparency+
38
- # - +HideConstructionGeometry+
39
- # - +HighlightColor+
40
- # - +HorizonColor+
41
- # - +InactiveHidden+
42
- # - +InstanceHidden+
43
- # - +JitterEdges+
44
- # - +LineEndWidth+
45
- # - +LineExtension+
46
- # - +LockedColor+
47
- # - +MaterialTransparency+
48
- # - +ModelTransparency+
49
- # - +RenderMode+
50
- # - +SectionActiveColor+
51
- # - +SectionCutWidth+
52
- # - +SectionDefaultCutColor+
53
- # - +SectionInactiveColor+
54
- # - +ShowViewName+
55
- # - +SilhouetteWidth+
56
- # - +SkyColor+
57
- # - +Texture+
58
- # - +TransparencySort+ SketchUp 2017 treats Medium transparency as Faster.
59
- #
60
- # Removed in SketchUp 2019.1
61
- # - +FaceColorMode+ This option was previously included but it was ineffective.
62
- #
63
- # Added in SketchUp 7:
64
- # - +DisplayDims+
65
- # - +DisplaySketchAxes+
66
- # - +DisplayText+
67
- #
68
- # Added in SketchUp 8:
69
- # - +InactiveFade+
70
- # - +InstanceFade+
71
- #
72
- # Added in SketchUp 2014:
73
- # - +DisplaySectionPlanes+
74
- #
75
- # Added in SketchUp 2015:
76
- # - +DisplaySectionCuts+
77
- # - +DrawBackEdges+
78
- # - +SectionCutDrawEdges+
79
- #
80
- # Added in SketchUp 2018:
81
- # - +SectionCutFilled+
82
- # - +SectionDefaultFillColor+
83
- #
84
- # @version SketchUp 6.0
85
- class Sketchup::RenderingOptions < Sketchup::Entity
86
-
87
- # Includes
88
-
89
- include Enumerable
90
-
91
- # Constants
92
-
93
- ROPAssign = nil # Stub value.
94
- ROPDrawHidden = nil # Stub value.
95
- ROPEditComponent = nil # Stub value.
96
- ROPSetBackgroundColor = nil # Stub value.
97
- ROPSetConstructionColor = nil # Stub value.
98
- ROPSetDepthQueEdges = nil # Stub value.
99
- ROPSetDepthQueWidth = nil # Stub value.
100
- ROPSetDisplayColorByLayer = nil # Stub value.
101
- ROPSetDisplayDims = nil # Stub value.
102
- ROPSetDisplayFog = nil # Stub value.
103
- ROPSetDisplayInstanceAxes = nil # Stub value.
104
- ROPSetDisplaySketchAxes = nil # Stub value.
105
- ROPSetDisplayText = nil # Stub value.
106
- ROPSetDisplayWatermarks = nil # Stub value.
107
- ROPSetDrawBackEdges = nil # Stub value.
108
- ROPSetDrawGround = nil # Stub value.
109
- ROPSetDrawHorizon = nil # Stub value.
110
- ROPSetDrawUnderground = nil # Stub value.
111
- ROPSetEdgeColorMode = nil # Stub value.
112
- ROPSetEdgeDisplayMode = nil # Stub value.
113
- ROPSetEdgeType = nil # Stub value.
114
- ROPSetExtendEdges = nil # Stub value.
115
- ROPSetExtendLines = nil # Stub value.
116
- ROPSetFaceColor = nil # Stub value.
117
- ROPSetFaceColorMode = nil # Stub value.
118
- ROPSetFogColor = nil # Stub value.
119
- ROPSetFogDist = nil # Stub value.
120
- ROPSetFogHint = nil # Stub value.
121
- ROPSetFogUseBkColor = nil # Stub value.
122
- ROPSetForegroundColor = nil # Stub value.
123
- ROPSetGroundColor = nil # Stub value.
124
- ROPSetGroundTransparency = nil # Stub value.
125
- ROPSetHideConstructionGeometry = nil # Stub value.
126
- ROPSetHighlightColor = nil # Stub value.
127
- ROPSetJitterEdges = nil # Stub value.
128
- ROPSetLineEndEdges = nil # Stub value.
129
- ROPSetLineEndWidth = nil # Stub value.
130
- ROPSetLineExtension = nil # Stub value.
131
- ROPSetLockedColor = nil # Stub value.
132
- ROPSetMaterialTransparency = nil # Stub value.
133
- ROPSetModelTransparency = nil # Stub value.
134
- ROPSetPhotomatchBackgroundOpacity = nil # Stub value.
135
- ROPSetPhotomatchDrawBackground = nil # Stub value.
136
- ROPSetPhotomatchDrawOverlay = nil # Stub value.
137
- ROPSetPhotomatchOverlayOpacity = nil # Stub value.
138
- ROPSetProfileEdges = nil # Stub value.
139
- ROPSetProfileWidth = nil # Stub value.
140
- ROPSetProfilesOnlyEdges = nil # Stub value.
141
- ROPSetRenderMode = nil # Stub value.
142
- ROPSetSectionActiveColor = nil # Stub value.
143
- ROPSetSectionCutFilled = nil # Stub value.
144
- ROPSetSectionCutWidth = nil # Stub value.
145
- ROPSetSectionDefaultCutColor = nil # Stub value.
146
- ROPSetSectionDefaultFillColor = nil # Stub value.
147
- ROPSetSectionDisplayMode = nil # Stub value.
148
- ROPSetSectionInactiveColor = nil # Stub value.
149
- ROPSetSkyColor = nil # Stub value.
150
- ROPSetTexture = nil # Stub value.
151
- ROPSetTransparencyObsolete = nil # Stub value.
152
- ROPSetXRayOpacity = nil # Stub value.
153
- ROPTransparencySortMethod = nil # Stub value.
154
-
155
- # Class Methods
156
-
157
- # The each_key method iterates through all of the rendering options keys.
158
- #
159
- # @example
160
- # Sketchup.active_model.rendering_options.each_key { |key|
161
- # puts key
162
- # }
163
- #
164
- # @return [nil]
165
- #
166
- # @version SketchUp 6.0
167
- #
168
- # @yield [key] Variable to hold each key as they are found.
169
- def self.each_key
170
- end
171
-
172
- # The keys method returns an array with all of the attribute keys.
173
- #
174
- # @example
175
- # keys = Sketchup.active_model.rendering_options.keys
176
- #
177
- # @return [Array<String>] an array of keys
178
- #
179
- # @version SketchUp 6.0
180
- def self.keys
181
- end
182
-
183
- # Instance Methods
184
-
185
- # The {#[]} method is used to get the value of a rendering option.
186
- #
187
- # @example
188
- # result = Sketchup.active_model.rendering_options["DisplayInstanceAxes"]
189
- #
190
- # @param [String] key
191
- # The key of the rendering option value to get.
192
- #
193
- # @return [Object, nil]
194
- #
195
- # @version SketchUp 6.0
196
- def [](key)
197
- end
198
-
199
- # The set value []= method is used to set the value in the array of
200
- # rendering options.
201
- #
202
- # @example
203
- # Sketchup.active_model.rendering_options["DisplayInstanceAxes"] = false
204
- #
205
- # @param [String] key
206
- # The key of the rendering option value to set.
207
- #
208
- # @param [Object] value
209
- # The value to be set.
210
- #
211
- # @return [Object] the value that was set
212
- #
213
- # @version SketchUp 6.0
214
- def []=(key, value)
215
- end
216
-
217
- # The add_observer method is used to add an observer to the current object.
218
- #
219
- # @example
220
- # observer = Sketchup::RenderingOptionsObserver.new # Dummy observer.
221
- # result = Sketchup.active_model.rendering_options.add_observer(observer)
222
- #
223
- # @param [Object] observer
224
- # An observer.
225
- #
226
- # @return [Boolean] true if successful, false if unsuccessful.
227
- #
228
- # @version SketchUp 6.0
229
- def add_observer(observer)
230
- end
231
-
232
- # The {#count} method is inherited from the +Enumerable+ mix-in module.
233
- #
234
- # @example
235
- # options = Sketchup.active_model.rendering_options
236
- # number = options.count
237
- #
238
- # @return [Integer]
239
- #
240
- # @version SketchUp 2014
241
- def count
242
- end
243
-
244
- # The {#each} method iterates through all of the rendering options key/value
245
- # pairs.
246
- #
247
- # @example
248
- # Sketchup.active_model.rendering_options.each { |key, value|
249
- # puts "#{key} : #{value}"
250
- # }
251
- #
252
- # @return [nil]
253
- #
254
- # @see #each_pair
255
- #
256
- # @version SketchUp 6.0
257
- #
258
- # @yield [key, value]
259
- #
260
- # @yieldparam [String] key
261
- # The key of each pair found.
262
- #
263
- # @yieldparam [Object] value
264
- # The value of each pair found.
265
- def each
266
- end
267
-
268
- # The each_key method iterates through all of the rendering options keys.
269
- #
270
- # @example
271
- # Sketchup.active_model.rendering_options.each_key { |key|
272
- # puts key
273
- # }
274
- #
275
- # @return [nil]
276
- #
277
- # @version SketchUp 6.0
278
- #
279
- # @yield [key] Variable to hold each key as they are found.
280
- def each_key
281
- end
282
-
283
- # The {#each_pair} method is an alias for {#each}.
284
- #
285
- # @example
286
- # Sketchup.active_model.rendering_options.each_pair { |key, value|
287
- # puts "#{key} : #{value}"
288
- # }
289
- #
290
- # @return [nil]
291
- #
292
- # @see #each
293
- #
294
- # @version SketchUp 6.0
295
- def each_pair
296
- end
297
-
298
- # The keys method returns an array with all of the attribute keys.
299
- #
300
- # @example
301
- # keys = Sketchup.active_model.rendering_options.keys
302
- #
303
- # @return [Array<String>] an array of keys
304
- #
305
- # @version SketchUp 6.0
306
- def keys
307
- end
308
-
309
- # The {#length} method returns the number of options in the rendering options
310
- # collection.
311
- #
312
- # @example
313
- # options = Sketchup.active_model.rendering_options
314
- # number = options.length
315
- #
316
- # @return [Integer]
317
- #
318
- # @see #size
319
- #
320
- # @version SketchUp 2014
321
- def length
322
- end
323
-
324
- # The remove_observer method is used to remove an observer from the current
325
- # object.
326
- #
327
- # @example
328
- # observer = Sketchup::RenderingOptionsObserver.new # Dummy observer.
329
- # options = Sketchup.active_model.rendering_options
330
- # options.add_observer(observer)
331
- # result = options.remove_observer(observer)
332
- #
333
- # @param [Object] observer
334
- # An observer.
335
- #
336
- # @return [Boolean] true if successful, false if unsuccessful.
337
- #
338
- # @version SketchUp 6.0
339
- def remove_observer(observer)
340
- end
341
-
342
- # The {#size} method is an alias for {#length}.
343
- #
344
- # @example
345
- # options = Sketchup.active_model.rendering_options
346
- # number = options.size
347
- #
348
- # @return [Integer]
349
- #
350
- # @see #length
351
- #
352
- # @version SketchUp 2014
353
- def size
354
- end
355
-
356
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The RenderingOptions class contains method to extract the rendering
5
+ # information for a model. The majority of the rendering information returned
6
+ # exists in the Styles dialog. The following
7
+ # rendering information keys are maintained in SketchUp:
8
+ #
9
+ # - +BackgroundColor+
10
+ # - +BandColor+
11
+ # - +ConstructionColor+
12
+ # - +DepthQueWidth+
13
+ # - +DisplayColorByLayer+
14
+ # - +DisplayFog+
15
+ # - +DisplayInstanceAxes+
16
+ # - +DisplayWatermarks+
17
+ # - +DrawDepthQue+
18
+ # - +DrawGround+
19
+ # - +DrawHidden+
20
+ # - +DrawHorizon+
21
+ # - +DrawLineEnds+
22
+ # - +DrawProfilesOnly+
23
+ # - +DrawSilhouettes+
24
+ # - +DrawUnderground+
25
+ # - +EdgeColorMode+
26
+ # - +EdgeDisplayMode+
27
+ # - +EdgeType+
28
+ # - +ExtendLines+
29
+ # - +FaceBackColor+
30
+ # - +FaceFrontColor+
31
+ # - +FogColor+
32
+ # - +FogEndDist+
33
+ # - +FogStartDist+
34
+ # - +FogUseBkColor+
35
+ # - +ForegroundColor+
36
+ # - +GroundColor+
37
+ # - +GroundTransparency+
38
+ # - +HideConstructionGeometry+
39
+ # - +HighlightColor+
40
+ # - +HorizonColor+
41
+ # - +InactiveHidden+
42
+ # - +InstanceHidden+
43
+ # - +JitterEdges+
44
+ # - +LineEndWidth+
45
+ # - +LineExtension+
46
+ # - +LockedColor+
47
+ # - +MaterialTransparency+
48
+ # - +ModelTransparency+
49
+ # - +RenderMode+
50
+ # - +SectionActiveColor+
51
+ # - +SectionCutWidth+
52
+ # - +SectionDefaultCutColor+
53
+ # - +SectionInactiveColor+
54
+ # - +ShowViewName+
55
+ # - +SilhouetteWidth+
56
+ # - +SkyColor+
57
+ # - +Texture+
58
+ # - +TransparencySort+ SketchUp 2017 treats Medium transparency as Faster.
59
+ #
60
+ # Added in SketchUp 7:
61
+ # - +DisplayDims+
62
+ # - +DisplaySketchAxes+
63
+ # - +DisplayText+
64
+ #
65
+ # Added in SketchUp 8:
66
+ # - +InactiveFade+
67
+ # - +InstanceFade+
68
+ #
69
+ # Added in SketchUp 2014:
70
+ # - +DisplaySectionPlanes+
71
+ #
72
+ # Added in SketchUp 2015:
73
+ # - +DisplaySectionCuts+
74
+ # - +DrawBackEdges+
75
+ # - +SectionCutDrawEdges+
76
+ #
77
+ # Added in SketchUp 2018:
78
+ # - +SectionCutFilled+
79
+ # - +SectionDefaultFillColor+
80
+ #
81
+ # Removed in SketchUp 2019.1
82
+ # - +FaceColorMode+ This option was previously included but it was ineffective.
83
+ #
84
+ # Added in SketchUp 2020.0:
85
+ # - +ROPDrawHiddenGeometry+
86
+ # - +ROPDrawHiddenObjects+
87
+ #
88
+ # @version SketchUp 6.0
89
+ class Sketchup::RenderingOptions < Sketchup::Entity
90
+
91
+ # Includes
92
+
93
+ include Enumerable
94
+
95
+ # Constants
96
+
97
+ ROPAssign = nil # Stub value.
98
+ ROPDrawHidden = nil # Stub value.
99
+ ROPDrawHiddenGeometry = nil # Stub value.
100
+ ROPDrawHiddenObjects = nil # Stub value.
101
+ ROPEditComponent = nil # Stub value.
102
+ ROPSectionDisplayTurnedOff = nil # Stub value.
103
+ ROPSetBackgroundColor = nil # Stub value.
104
+ ROPSetConstructionColor = nil # Stub value.
105
+ ROPSetDepthQueEdges = nil # Stub value.
106
+ ROPSetDepthQueWidth = nil # Stub value.
107
+ ROPSetDisplayColorByLayer = nil # Stub value.
108
+ ROPSetDisplayDims = nil # Stub value.
109
+ ROPSetDisplayFog = nil # Stub value.
110
+ ROPSetDisplayInstanceAxes = nil # Stub value.
111
+ ROPSetDisplaySketchAxes = nil # Stub value.
112
+ ROPSetDisplayText = nil # Stub value.
113
+ ROPSetDisplayWatermarks = nil # Stub value.
114
+ ROPSetDrawBackEdges = nil # Stub value.
115
+ ROPSetDrawGround = nil # Stub value.
116
+ ROPSetDrawHorizon = nil # Stub value.
117
+ ROPSetDrawUnderground = nil # Stub value.
118
+ ROPSetEdgeColorMode = nil # Stub value.
119
+ ROPSetEdgeDisplayMode = nil # Stub value.
120
+ ROPSetEdgeType = nil # Stub value.
121
+ ROPSetExtendEdges = nil # Stub value.
122
+ ROPSetExtendLines = nil # Stub value.
123
+ ROPSetFaceColor = nil # Stub value.
124
+ ROPSetFaceColorMode = nil # Stub value.
125
+ ROPSetFogColor = nil # Stub value.
126
+ ROPSetFogDist = nil # Stub value.
127
+ ROPSetFogHint = nil # Stub value.
128
+ ROPSetFogUseBkColor = nil # Stub value.
129
+ ROPSetForegroundColor = nil # Stub value.
130
+ ROPSetGroundColor = nil # Stub value.
131
+ ROPSetGroundTransparency = nil # Stub value.
132
+ ROPSetHideConstructionGeometry = nil # Stub value.
133
+ ROPSetHighlightColor = nil # Stub value.
134
+ ROPSetJitterEdges = nil # Stub value.
135
+ ROPSetLineEndEdges = nil # Stub value.
136
+ ROPSetLineEndWidth = nil # Stub value.
137
+ ROPSetLineExtension = nil # Stub value.
138
+ ROPSetLineStyleEdges = nil # Stub value.
139
+ ROPSetLockedColor = nil # Stub value.
140
+ ROPSetMaterialTransparency = nil # Stub value.
141
+ ROPSetModelTransparency = nil # Stub value.
142
+ ROPSetPhotomatchBackgroundOpacity = nil # Stub value.
143
+ ROPSetPhotomatchDrawBackground = nil # Stub value.
144
+ ROPSetPhotomatchDrawOverlay = nil # Stub value.
145
+ ROPSetPhotomatchOverlayOpacity = nil # Stub value.
146
+ ROPSetProfileEdges = nil # Stub value.
147
+ ROPSetProfileWidth = nil # Stub value.
148
+ ROPSetProfilesOnlyEdges = nil # Stub value.
149
+ ROPSetRenderMode = nil # Stub value.
150
+ ROPSetSectionActiveColor = nil # Stub value.
151
+ ROPSetSectionCutFilled = nil # Stub value.
152
+ ROPSetSectionCutWidth = nil # Stub value.
153
+ ROPSetSectionDefaultCutColor = nil # Stub value.
154
+ ROPSetSectionDefaultFillColor = nil # Stub value.
155
+ ROPSetSectionDisplayMode = nil # Stub value.
156
+ ROPSetSectionInactiveColor = nil # Stub value.
157
+ ROPSetSkyColor = nil # Stub value.
158
+ ROPSetTexture = nil # Stub value.
159
+ ROPSetTransparencyObsolete = nil # Stub value.
160
+ ROPSetXRayOpacity = nil # Stub value.
161
+ ROPTransparencySortMethod = nil # Stub value.
162
+
163
+ # Class Methods
164
+
165
+ # The each_key method iterates through all of the rendering options keys.
166
+ #
167
+ # @example
168
+ # Sketchup.active_model.rendering_options.each_key { |key|
169
+ # puts key
170
+ # }
171
+ #
172
+ # @return [nil]
173
+ #
174
+ # @version SketchUp 6.0
175
+ #
176
+ # @yield [key] Variable to hold each key as they are found.
177
+ def self.each_key
178
+ end
179
+
180
+ # The keys method returns an array with all of the attribute keys.
181
+ #
182
+ # @example
183
+ # keys = Sketchup.active_model.rendering_options.keys
184
+ #
185
+ # @return [Array<String>] an array of keys
186
+ #
187
+ # @version SketchUp 6.0
188
+ def self.keys
189
+ end
190
+
191
+ # Instance Methods
192
+
193
+ # The {#[]} method is used to get the value of a rendering option.
194
+ #
195
+ # @example
196
+ # result = Sketchup.active_model.rendering_options["DisplayInstanceAxes"]
197
+ #
198
+ # @param [String] key
199
+ # The key of the rendering option value to get.
200
+ #
201
+ # @return [Object, nil]
202
+ #
203
+ # @version SketchUp 6.0
204
+ def [](key)
205
+ end
206
+
207
+ # The set value []= method is used to set the value in the array of
208
+ # rendering options.
209
+ #
210
+ # @example
211
+ # Sketchup.active_model.rendering_options["DisplayInstanceAxes"] = false
212
+ #
213
+ # @param [String] key
214
+ # The key of the rendering option value to set.
215
+ #
216
+ # @param [Object] value
217
+ # The value to be set.
218
+ #
219
+ # @return [Object] the value that was set
220
+ #
221
+ # @version SketchUp 6.0
222
+ def []=(key, value)
223
+ end
224
+
225
+ # The add_observer method is used to add an observer to the current object.
226
+ #
227
+ # @example
228
+ # observer = Sketchup::RenderingOptionsObserver.new # Dummy observer.
229
+ # result = Sketchup.active_model.rendering_options.add_observer(observer)
230
+ #
231
+ # @param [Object] observer
232
+ # An observer.
233
+ #
234
+ # @return [Boolean] true if successful, false if unsuccessful.
235
+ #
236
+ # @version SketchUp 6.0
237
+ def add_observer(observer)
238
+ end
239
+
240
+ # The {#count} method is inherited from the +Enumerable+ mix-in module.
241
+ #
242
+ # @example
243
+ # options = Sketchup.active_model.rendering_options
244
+ # number = options.count
245
+ #
246
+ # @return [Integer]
247
+ #
248
+ # @version SketchUp 2014
249
+ def count
250
+ end
251
+
252
+ # The {#each} method iterates through all of the rendering options key/value
253
+ # pairs.
254
+ #
255
+ # @example
256
+ # Sketchup.active_model.rendering_options.each { |key, value|
257
+ # puts "#{key} : #{value}"
258
+ # }
259
+ #
260
+ # @return [nil]
261
+ #
262
+ # @see #each_pair
263
+ #
264
+ # @version SketchUp 6.0
265
+ #
266
+ # @yield [key, value]
267
+ #
268
+ # @yieldparam [String] key
269
+ # The key of each pair found.
270
+ #
271
+ # @yieldparam [Object] value
272
+ # The value of each pair found.
273
+ def each
274
+ end
275
+
276
+ # The each_key method iterates through all of the rendering options keys.
277
+ #
278
+ # @example
279
+ # Sketchup.active_model.rendering_options.each_key { |key|
280
+ # puts key
281
+ # }
282
+ #
283
+ # @return [nil]
284
+ #
285
+ # @version SketchUp 6.0
286
+ #
287
+ # @yield [key] Variable to hold each key as they are found.
288
+ def each_key
289
+ end
290
+
291
+ # The {#each_pair} method is an alias for {#each}.
292
+ #
293
+ # @example
294
+ # Sketchup.active_model.rendering_options.each_pair { |key, value|
295
+ # puts "#{key} : #{value}"
296
+ # }
297
+ #
298
+ # @return [nil]
299
+ #
300
+ # @see #each
301
+ #
302
+ # @version SketchUp 6.0
303
+ def each_pair
304
+ end
305
+
306
+ # The keys method returns an array with all of the attribute keys.
307
+ #
308
+ # @example
309
+ # keys = Sketchup.active_model.rendering_options.keys
310
+ #
311
+ # @return [Array<String>] an array of keys
312
+ #
313
+ # @version SketchUp 6.0
314
+ def keys
315
+ end
316
+
317
+ # The {#length} method returns the number of options in the rendering options
318
+ # collection.
319
+ #
320
+ # @example
321
+ # options = Sketchup.active_model.rendering_options
322
+ # number = options.length
323
+ #
324
+ # @return [Integer]
325
+ #
326
+ # @see #size
327
+ #
328
+ # @version SketchUp 2014
329
+ def length
330
+ end
331
+
332
+ # The remove_observer method is used to remove an observer from the current
333
+ # object.
334
+ #
335
+ # @example
336
+ # observer = Sketchup::RenderingOptionsObserver.new # Dummy observer.
337
+ # options = Sketchup.active_model.rendering_options
338
+ # options.add_observer(observer)
339
+ # result = options.remove_observer(observer)
340
+ #
341
+ # @param [Object] observer
342
+ # An observer.
343
+ #
344
+ # @return [Boolean] true if successful, false if unsuccessful.
345
+ #
346
+ # @version SketchUp 6.0
347
+ def remove_observer(observer)
348
+ end
349
+
350
+ # The {#size} method is an alias for {#length}.
351
+ #
352
+ # @example
353
+ # options = Sketchup.active_model.rendering_options
354
+ # number = options.size
355
+ #
356
+ # @return [Integer]
357
+ #
358
+ # @see #length
359
+ #
360
+ # @version SketchUp 2014
361
+ def size
362
+ end
363
+
364
+ end