sketchup-api-stubs 0.7.4 → 0.7.8

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 (151) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +148 -145
  3. data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
  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 +523 -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 +693 -691
  16. data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -348
  17. data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +698 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -174
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +516 -514
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -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 +225 -220
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
  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 +209 -204
  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 +692 -694
  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/Layout.rb +25 -25
  49. data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
  50. data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +286 -281
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -577
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -281
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +619 -562
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -194
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +426 -329
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1205 -1119
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +272 -0
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -750
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -697
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +292 -285
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -409
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +407 -393
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -285
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -136
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -112
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -132
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -770
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +477 -456
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -44
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -454
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +260 -257
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -57
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +837 -829
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -61
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1317 -1301
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
  140. data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1360 -1310
  141. data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
  142. data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
  143. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -310
  144. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +496 -356
  145. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -229
  146. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  147. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
  148. data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -667
  149. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  150. data/lib/sketchup-api-stubs.rb +1 -1
  151. metadata +15 -12
@@ -1,1301 +1,1317 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This class contains methods to manipulate the current point of view of the
5
- # model. The drawing methods here (draw_line, draw_polyline, etc) are meant to
6
- # be invoked within a tool's Tool.draw method. Calling them outside Tool.draw
7
- # will have no effect.
8
- #
9
- # You access the View by calling the Model.active_view method.
10
- #
11
- # @example
12
- # view = Sketchup.active_model.active_view
13
- #
14
- # @version SketchUp 6.0
15
- class Sketchup::View
16
-
17
- # Instance Methods
18
-
19
- # The add_observer method is used to add an observer to the current object.
20
- #
21
- # @example
22
- # view = Sketchup.active_model.active_view
23
- # status = view.add_observer observer
24
- #
25
- # @param [Object] observer
26
- # An observer.
27
- #
28
- # @return [Boolean] true if successful, false if unsuccessful.
29
- #
30
- # @version SketchUp 6.0
31
- def add_observer(observer)
32
- end
33
-
34
- # The animation= method is used to set an animation that is displayed for a
35
- # view. See Animation for details on how to create an animation object.
36
- #
37
- # @example
38
- # animation = ViewSpinner.new
39
- # model = Sketchup.active_model
40
- # view = model.active_view
41
- # anim = view.animation=animation
42
- # if (anim)
43
- # UI.messagebox anim
44
- # else
45
- # UI.messagebox "Failure"
46
- # end
47
- #
48
- # @param [#nextFrame] animation
49
- # An Animation object.
50
- #
51
- # @return [#nextFrame] the newly set Animation object
52
- #
53
- # @version SketchUp 6.0
54
- def animation=(animation)
55
- end
56
-
57
- # The average_refresh_time is used to set the average time used to refresh the
58
- # current model in the view. This can be used to estimate the frame rate for
59
- # an animation.
60
- #
61
- # @example
62
- # model = Sketchup.active_model
63
- # view = model.active_view
64
- # time = view.average_refresh_time
65
- #
66
- # @return [Float] the time in seconds
67
- #
68
- # @version SketchUp 6.0
69
- def average_refresh_time
70
- end
71
-
72
- # The camera method is used to retrieve the camera for the view.
73
- #
74
- # @example
75
- # camera = view.camera
76
- #
77
- # @return [Sketchup::Camera] a Camera object
78
- #
79
- # @version SketchUp 6.0
80
- def camera
81
- end
82
-
83
- # The {#camera=} method is used to set the camera for the view. If a transition
84
- # time is given, then it will animate the transition from the current camera
85
- # to the new one.
86
- #
87
- # @example
88
- # camera = Sketchup::Camera.new([5, 5, 9], [5, 10, 0], Z_AXIS)
89
- # view = Sketchup.active_model.active_view
90
- # view.camera = camera
91
- #
92
- # @overload camera=(camera)
93
- #
94
- # @param camera [Sketchup::Camera] The new Camera object.
95
- # @return [Sketchup::Camera]
96
- #
97
- # @overload camera=(camera_and_transition)
98
- #
99
- # @param camera_and_transition [Array(Sketchup::Camera, Float)]
100
- # The second item in the array represents the transition time from the
101
- # existing camera to the new one
102
- # @return [Array(Sketchup::Camera, Float)]
103
- #
104
- # @version SketchUp 6.0
105
- def camera=(arg)
106
- end
107
-
108
- # The center method is used to retrieve the coordinates of the center of the
109
- # view in pixels. It is returned as an array of 2 values for x and y.
110
- #
111
- # @example
112
- # model = Sketchup.active_model
113
- # view = model.active_view
114
- # c = view.center
115
- #
116
- # @return [Geom::Point3d] the center of the view
117
- #
118
- # @version SketchUp 6.0
119
- def center
120
- end
121
-
122
- # The corner method is used to retrieve the coordinates of one of the corners
123
- # of the view. The argument is an index between 0 and 3 that identifies which
124
- # corner you want. This method returns an array with two integers which are
125
- # the coordinates of the corner of the view in the view space. If the view
126
- # uses a Camera with a fixed aspect ratio, then the corners are the corners of
127
- # the viewing are of the camera which might be different than the actual
128
- # corners of the view itself.
129
- #
130
- # The index numbers are as follows:
131
- # - 0: top left,
132
- # - 1: top right,
133
- # - 2: bottom left,
134
- # - 3: bottom right.
135
- #
136
- # @example
137
- # point = view.corner index
138
- #
139
- # @param [Integer] index
140
- # A value between (or including) 0 and 3 identifying the
141
- # corner whose coordinate you want to retrieve.
142
- #
143
- # @return [Array(Integer, Integer)] a 2d array [w,h] representing the screen point
144
- #
145
- # @version SketchUp 6.0
146
- def corner(index)
147
- end
148
-
149
- # The {#draw} method is used to do basic drawing. This method can only be
150
- # called from within the {Tool#draw} method of a tool that you implement in
151
- # Ruby.
152
- #
153
- # The following constants are all OpenGL terms and have been externalized to
154
- # Ruby. Here is a summary of their meanings:
155
- #
156
- # [GL_POINTS]
157
- # Treats each vertex as a single point. Vertex n defines point n. N
158
- # points are drawn.
159
- #
160
- # [GL_LINES]
161
- # Treats each pair of vertices as
162
- # an independent line segment. Vertices 2n-1 and 2n define line n. N/2 lines
163
- # are drawn.
164
- #
165
- # [GL_LINE_STRIP]
166
- # Draws a connected group of line
167
- # segments from the first vertex to the last. Vertices n and n+1 define
168
- # line n. N-1 lines are drawn.
169
- #
170
- # [GL_LINE_LOOP]
171
- # Draws a connected group of line segments from the first vertex to the last,
172
- # then back to the first. Vertices n and n+1 define line n. The last line,
173
- # however, is defined by vertices N and 1. N lines are drawn.
174
- #
175
- # [GL_TRIANGLES]
176
- # Treats each triplet of vertices as an independent
177
- # triangle. Vertices 3n-2, 3n-1, and 3n define triangle n. N/3 triangles are
178
- # drawn.
179
- #
180
- # [GL_TRIANGLE_STRIP]
181
- # Draws a connected group of triangles. One triangle is defined for each
182
- # vertex presented after the first two vertices. For odd n, vertices n, n+1,
183
- # and n+2 define triangle n. For even n, vertices n+1, n, and n+2 define
184
- # triangle n. N-2 triangles are drawn.
185
- #
186
- # [GL_TRIANGLE_FAN]
187
- # Draws a connected group of triangles.
188
- # One triangle is defined for each vertex presented after the first two
189
- # vertices. Vertices 1, n+1, and n+2 define triangle n. N-2 triangles are
190
- # drawn.
191
- #
192
- # [GL_QUADS]
193
- # Treats each group of four vertices as an
194
- # independent quadrilateral. Vertices 4n-3, 4n-2, 4n-1, and 4n define
195
- # quadrilateral n. N/4 quadrilaterals are drawn.
196
- #
197
- # [GL_QUAD_STRIP]
198
- # Draws a connected group of quadrilaterals. One quadrilateral is
199
- # defined for each pair of vertices presented after the first pair.
200
- # Vertices 2n-1, 2n, 2n+2, and 2n+1 define quadrilateral n. N/2-1
201
- # quadrilaterals are drawn. Note that the order in which vertices are used to
202
- # construct a quadrilateral from strip data is different from that used with
203
- # independent data.
204
- #
205
- # [GL_POLYGON]
206
- # Draws a single, convex polygon. Vertices 1
207
- # through N define this polygon.
208
- #
209
- # @example
210
- # points = [
211
- # Geom::Point3d.new(0, 0, 0),
212
- # Geom::Point3d.new(9, 0, 0),
213
- # Geom::Point3d.new(9, 9, 0),
214
- # Geom::Point3d.new(0, 9, 0)
215
- # ]
216
- # view.draw(GL_LINE_LOOP, points)
217
- #
218
- # @note If you draw outside the model bounds you need to implement
219
- # {Tool#getExtents} which returns a bounding box large enough to include the
220
- # points you draw. Otherwise your drawing will be clipped.
221
- #
222
- # @overload draw(openglenum, points)
223
- #
224
- # @param [Integer] openglenum
225
- # The item you are going to draw, one of the constants
226
- # from the comments, such as +GL_LINES+.
227
- # @param [Array<Geom::Point3d>] points
228
- #
229
- # @overload draw(openglenum, *points)
230
- #
231
- # @param [Integer] openglenum
232
- # The item you are going to draw, one of the constants
233
- # from the comments, such as +GL_LINES+.
234
- # @param [Array<Geom::Point3d>] points
235
- #
236
- # @overload draw(openglenum, points, **options)
237
- #
238
- # @version SketchUp 2020.0
239
- # @param [Integer] openglenum
240
- # The item you are going to draw, one of the constants
241
- # from the comments, such as +GL_LINES+.
242
- # @param [Array<Geom::Point3d>] points
243
- # @param [Hash] options
244
- # @option options [Array<Geom::Vector3d>] :normals
245
- # Without normals the polygons will be rendered with flat shading. No
246
- # light will affect it. By providing an array of vertex normals lighting
247
- # is turned on and will use the model's current light. Note that the number
248
- # of normals must match the number of points provided.
249
- # @option options [Integer] :texture_id
250
- # A texture id provided by {#load_texture}.
251
- # @option options [Array<Geom::Vector3d>] :uvs
252
- # Set of UV (Not UVQ) coordinates matching the number of points provided.
253
- # This must be used along with the +:texture_id+ option.
254
- #
255
- # @overload draw(openglenum, *points, **options)
256
- #
257
- # @version SketchUp 2020.0
258
- # @param [Integer] openglenum
259
- # The item you are going to draw, one of the constants
260
- # from the comments, such as +GL_LINES+.
261
- # @param [Array<Geom::Point3d>] points
262
- # @param [Hash] options
263
- # @option options [Array<Geom::Vector3d>] :normals ([])
264
- # Without normals the polygons will be rendered with flat shading. No
265
- # light will affect it. By providing an array of vertex normals lighting
266
- # is turned on and will use the model's current light. Note that the number
267
- # of normals must match the number of points provided.
268
- # @option options [Integer] :texture_id
269
- # A texture id provided by {#load_texture}.
270
- # @option options [Array<Geom::Vector3d>] :uvs
271
- # Set of UV (Not UVQ) coordinates matching the number of points provided.
272
- # This must be used along with the +:texture_id+ option.
273
- #
274
- # @return [Sketchup::View]
275
- #
276
- # @see Tool#getExtents
277
- #
278
- # @version SketchUp 6.0
279
- def draw(*args)
280
- end
281
-
282
- # The {#draw2d} method is used to draw in screen space (using 2D screen
283
- # coordinates) instead of 3D space.
284
- #
285
- # The second parameter is an {Array} of {Geom::Point3d} objects (or several
286
- # individual {Geom::Point3d} objects). These {Geom::Point3d} objects are in
287
- # screen space, not 3D space.
288
- # The X value corresponds to the number of pixels from the left edge of the
289
- # drawing area. The Y value corresponds to the number of pixels down from
290
- # the top of the drawing area. The Z value is not used.
291
- #
292
- # @example
293
- # points = [
294
- # Geom::Point3d.new(0, 0, 0),
295
- # Geom::Point3d.new(8, 0, 0),
296
- # Geom::Point3d.new(8, 4, 0),
297
- # Geom::Point3d.new(0, 4, 0)
298
- # ]
299
- # view.draw2d(GL_LINE_STRIP, points)
300
- #
301
- # @overload draw2d(openglenum, points)
302
- #
303
- # @param [Integer] openglenum
304
- # The item you are going to draw, one of the constants
305
- # from the comments, such as +GL_LINES+.
306
- # @param [Array<Geom::Point3d>] points
307
- #
308
- # @overload draw2d(openglenum, *points)
309
- #
310
- # @param [Integer] openglenum
311
- # The item you are going to draw, one of the constants
312
- # from the comments, such as +GL_LINES+.
313
- # @param [Array<Geom::Point3d>] points
314
- #
315
- # @overload draw2d(openglenum, points, **options)
316
- #
317
- # @version SketchUp 2020.0
318
- # @param [Integer] openglenum
319
- # The item you are going to draw, one of the constants
320
- # from the comments, such as +GL_LINES+.
321
- # @param [Array<Geom::Point3d>] points
322
- # @param [Hash] options
323
- # @option options [Integer] :texture_id
324
- # A texture id provided by {#load_texture}.
325
- # @option options [Array<Geom::Vector3d>] :uvs
326
- # Set of UV (Not UVQ) coordinates matching the number of points provided.
327
- # This must be used along with the +:texture_id+ option.
328
- #
329
- # @overload draw2d(openglenum, *points, **options)
330
- #
331
- # @version SketchUp 2020.0
332
- # @param [Integer] openglenum
333
- # The item you are going to draw, one of the constants
334
- # from the comments, such as +GL_LINES+.
335
- # @param [Array<Geom::Point3d>] points
336
- # @param [Hash] options
337
- # @option options [Integer] :texture_id
338
- # A texture id provided by {#load_texture}.
339
- # @option options [Array<Geom::Vector3d>] :uvs
340
- # Set of UV (Not UVQ) coordinates matching the number of points provided.
341
- # This must be used along with the +:texture_id+ option.
342
- #
343
- # @return [Sketchup::View]
344
- #
345
- # @see #draw
346
- #
347
- # @see UI.scale_factor
348
- #
349
- # @version SketchUp 6.0
350
- def draw2d(*args)
351
- end
352
-
353
- # The draw_lines method is used to draw disconnected lines.
354
- #
355
- # You must have an even number of points. This method is usually invoked
356
- # within the draw method of a tool.
357
- #
358
- # @example
359
- # point4 = Geom::Point3d.new 0,0,0
360
- # point5 = Geom::Point3d.new 100,100,100
361
- # # returns a view
362
- # status = view.drawing_color="red"
363
- # status = view.draw_lines point4, point5
364
- #
365
- # @overload draw_lines(point_list, ...)
366
- #
367
- # @param point_list [Array<Geom::Point3d>] An even number of Point3d objects.
368
- # @return [Sketchup::View] returns the View object
369
- #
370
- # @overload draw_lines(pts)
371
- #
372
- # @param pts [Array<Geom::Point3d>] An array of Point3d objects.
373
- # @return [Sketchup::View] returns the View object
374
- #
375
- # @version SketchUp 6.0
376
- def draw_line(*args)
377
- end
378
-
379
- # The draw_lines method is used to draw disconnected lines.
380
- #
381
- # You must have an even number of points. This method is usually invoked
382
- # within the draw method of a tool.
383
- #
384
- # @example
385
- # point4 = Geom::Point3d.new 0,0,0
386
- # point5 = Geom::Point3d.new 100,100,100
387
- # # returns a view
388
- # status = view.drawing_color="red"
389
- # status = view.draw_lines point4, point5
390
- #
391
- # @overload draw_lines(point_list, ...)
392
- #
393
- # @param point_list [Array<Geom::Point3d>] An even number of Point3d objects.
394
- # @return [Sketchup::View] returns the View object
395
- #
396
- # @overload draw_lines(pts)
397
- #
398
- # @param pts [Array<Geom::Point3d>] An array of Point3d objects.
399
- # @return [Sketchup::View] returns the View object
400
- #
401
- # @version SketchUp 6.0
402
- def draw_lines(*args)
403
- end
404
-
405
- # This method is used to draw points.
406
- #
407
- # This method is usually invoked within the draw method of a tool.
408
- #
409
- # @example
410
- # point3 = Geom::Point3d.new 0,0,0
411
- # # returns a view
412
- # status = view.draw_points point3, 10, 1, "red"
413
- #
414
- # @param [Array<Geom::Point3d>] pts
415
- # An array of Point3d objects.
416
- #
417
- # @param [Integer] pointsize
418
- # Size of the point in pixels.
419
- #
420
- # @param [Sketchup::Color] pointcolor
421
- # Color of the point.
422
- #
423
- # @param [Integer] pointstyle
424
- # Style of the point. 1 = open square,
425
- # 2 = filled square, 3 = "+", 4 = "X", 5 = "*",
426
- # 6 = open triangle, 7 = filled triangle.
427
- #
428
- # @return [Sketchup::View] a View object
429
- #
430
- # @version SketchUp 6.0
431
- def draw_points(pts, pointsize = 6, pointstyle = 3, pointcolor = 'black')
432
- end
433
-
434
- # The draw_polyline method is used to draw a series of connected line segments
435
- # from pt1 to pt2 to pt3, and so on.
436
- #
437
- # This method is usually invoked within the draw method of a tool.
438
- #
439
- # @example
440
- # point12 = Geom::Point3d.new 0,0,0
441
- # point13 = Geom::Point3d.new 10,10,10
442
- # point14 = Geom::Point3d.new 20,20,20
443
- # point15 = Geom::Point3d.new 30,30,30
444
- # status = view.draw_polyline point12, point13, point14, point15
445
- #
446
- # @overload draw_polyline(point_list, ...)
447
- #
448
- # @param point_list [Array<Geom::Point3d>] An even number of Point3d objects.
449
- # @return [Sketchup::View] a View object
450
- #
451
- # @overload draw_polyline(pts)
452
- #
453
- # @param pts [Array<Geom::Point3d>] An array of Point3d objects.
454
- # @return [Sketchup::View] a View object
455
- #
456
- # @version SketchUp 6.0
457
- def draw_polyline(*args)
458
- end
459
-
460
- # This method is used to draw text on the screen and is usually invoked within
461
- # the draw method of a tool.
462
- #
463
- # The {TextVerticalAlignCenter} option will align the text to the center of the
464
- # height of the first line, not the whole boundingbox of the text. To align
465
- # around the full bounds of the text, use {#text_bounds} to compute the
466
- # desired alignment.
467
- #
468
- # <b>Example of different vertical alignment and text bounds:</b>
469
- #
470
- # rdoc-image:../images/view-draw-text-with-bounds.png
471
- #
472
- # @example
473
- # class ExampleTool
474
- # def draw(view)
475
- # # This works in all SketchUp versions and draws the text using the
476
- # # default font, color and size.
477
- # point = Geom::Point3d.new(200, 100, 0)
478
- # view.draw_text(point, "This is a test")
479
- #
480
- # # This works in SketchUp 2016 and up.
481
- # options = {
482
- # :font => "Arial",
483
- # :size => 20,
484
- # :bold => true,
485
- # :align => TextAlignRight
486
- # }
487
- # point = Geom::Point3d.new(200, 200, 0)
488
- # view.draw_text(point, "This is another\ntest", options)
489
- #
490
- # # You can also use Ruby 2.0's named arguments:
491
- # point = Geom::Point3d.new(200, 200, 0)
492
- # view.draw_text(point, "Hello world!", color: "Red")
493
- # end
494
- # end
495
- #
496
- # @example Cross Platform Font Size
497
- # class ExampleTool
498
- # IS_WIN = Sketchup.platform == :platform_win
499
- #
500
- # def draw(view)
501
- # draw_text(view, [100, 200, 0], "Hello World", size: 20)
502
- # end
503
- #
504
- # private
505
- #
506
- # # This will ensure text is drawn with consistent size across platforms,
507
- # # using pixels as size units.
508
- # def draw_text(view, position, text, **options)
509
- # native_options = options.dup
510
- # if IS_WIN && options.key?(:size)
511
- # native_options[:size] = pixels_to_points(size)
512
- # end
513
- # view.draw_text(position, text, **native_options)
514
- # end
515
- #
516
- # def pixels_to_points(pixels)
517
- # ((pixels.to_f / 96.0) * 72.0).round
518
- # end
519
- # end
520
- #
521
- # @note Under Windows the font name must be less than 32 characters - due to
522
- # system limitations.
523
- #
524
- # @note As of SU2017 this will automatically scale the font-size by the same
525
- # factor as {UI.scale_factor}.
526
- #
527
- # @note The font size is platform dependent. On Windows the method expects
528
- # points, where on Mac it's pixels. See "Cross Platform Font Size" example
529
- # for details.
530
- #
531
- # @overload draw_text(point, text)
532
- #
533
- # @param [Geom::Point3d] point A Point3d object representing a 2D coordinate
534
- # in view space.
535
- # @param [String] text The text string to draw.
536
- #
537
- # @overload draw_text(point, text, options = {})
538
- #
539
- # @version SketchUp 2016
540
- # @param [Geom::Point3d] point A Point3d object representing a 2D coordinate
541
- # in view space.
542
- # @param [String] text The text string to draw.
543
- # @param [Hash] options The text can be customized by providing a hash or
544
- # named arguments of options.
545
- # @option options [String] :font The name of the font to use. If it does not
546
- # exist on the system, a default font will be used instead.
547
- # @option options [Integer] :size The size of the font in points
548
- # @option options [Boolean] :bold Controls the Bold property of the font.
549
- # @option options [Boolean] :italic Controls the Italic property of the font.
550
- # @option options [Sketchup::Color] :color The color to draw the text with.
551
- # @option options [Integer] :align The text alignment, one of the following
552
- # constants: {TextAlignLeft}, {TextAlignCenter} or {TextAlignRight}.
553
- # @option options [Integer] :vertical_align <b>Added SketchUp 2020.0.</b>
554
- # The vertical text alignment, one of the following constants:
555
- # {TextVerticalAlignBoundsTop}, {TextVerticalAlignBaseline},
556
- # {TextVerticalAlignCapHeight} or {TextVerticalAlignCenter}. Note that
557
- # some fonts on Mac might not align as expected due to the system
558
- # reporting incorrect font metrics.
559
- #
560
- # @return [Sketchup::View]
561
- #
562
- # @version SketchUp 6.0
563
- def draw_text(*args)
564
- end
565
-
566
- # The drawing_color method is used to set the color that is used for drawing
567
- # to the view.
568
- #
569
- # This method is usually invoked within the draw method of a tool.
570
- #
571
- # @example
572
- # view = view.drawing_color = color
573
- #
574
- # @param [Sketchup::Color, String] color
575
- # A Color object.
576
- #
577
- # @return [Sketchup::View]
578
- #
579
- # @version SketchUp 6.0
580
- def drawing_color=(color)
581
- end
582
-
583
- # The dynamic= method allows you to degrade visual quality while improving
584
- # performance when a model is large and view refresh time is slow. For
585
- # example, if you were using a Ruby script to animate the camera through
586
- # a large scene, you may want to set dynamic to true during that time.
587
- #
588
- # See also camera.rb which is part of the film and stage ruby
589
- # scripts.
590
- #
591
- # @deprecated This method is no longer doing anything.
592
- #
593
- # @example
594
- # view.dynamic = true
595
- #
596
- # @param [Boolean] value
597
- #
598
- # @return [Boolean]
599
- #
600
- # @version SketchUp 6.0
601
- def dynamic=(value)
602
- end
603
-
604
- # The field_of_view method is used get the view's field of view setting, in
605
- # degrees.
606
- #
607
- # @example
608
- # fov = Sketchup.active_model.active_view.field_of_view
609
- #
610
- # @return [Float] the field of view
611
- #
612
- # @version SketchUp 6.0
613
- def field_of_view
614
- end
615
-
616
- # The field_of_view= method is used set the view's field of view setting,
617
- # in degrees.
618
- #
619
- # @example
620
- # my_view = Sketchup.active_model.active_view
621
- # my_view.field_of_view = 45
622
- # my_view.invalidate
623
- #
624
- # @param [Numeric] fov
625
- # the field of view
626
- #
627
- # @return [Numeric]
628
- #
629
- # @version SketchUp 6.0
630
- def field_of_view=(fov)
631
- end
632
-
633
- # The guess_target method is used to guess at what the user is looking at when
634
- # you have a perspective view.
635
- #
636
- # This method is useful when writing a viewing tool. See also camera.rb which
637
- # is part of the film and stage ruby scripts.
638
- #
639
- # @example
640
- # target = view.guess_target
641
- #
642
- # @return [Geom::Point3d] a Point3d object representing the point in the
643
- # model that the user is likely interested in.
644
- #
645
- # @version SketchUp 6.0
646
- def guess_target(*args)
647
- end
648
-
649
- # The inference_locked? method is used to determine if inference locking is on
650
- # for the view.
651
- #
652
- # @example
653
- # model = Sketchup.active_model
654
- # view = model.active_view
655
- # status = view.inference_locked
656
- #
657
- # @return [Boolean]
658
- #
659
- # @version SketchUp 6.0
660
- def inference_locked?
661
- end
662
-
663
- # The inputpoint method is used to retrieve an input point.
664
- #
665
- # This will normally be used inside one of the mouse event handling methods in
666
- # a tool. Usually, it is preferable to create the InputPoint first and then
667
- # use the pick method on it.
668
- #
669
- # @example
670
- # inputpoint = view.inputpoint x, y, inputpoint1
671
- #
672
- # @param [Numeric] x
673
- # A x value.
674
- #
675
- # @param [Numeric] y
676
- # A y value.
677
- #
678
- # @param [Sketchup::InputPoint] inputpoint1
679
- # An InputPoint object.
680
- #
681
- # @return [Sketchup::InputPoint]
682
- #
683
- # @version SketchUp 6.0
684
- def inputpoint(x, y, inputpoint1)
685
- end
686
-
687
- # The invalidate method is used mark the view as in need of a redraw.
688
- #
689
- # @example
690
- # model = Sketchup.active_model
691
- # view = model.active_view
692
- # invalidated_view = view.invalidate
693
- #
694
- # @note This is the preferred method to update the viewport. Use this before
695
- # trying to use {#refresh}.
696
- #
697
- # @return [Sketchup::View] the invalidated View object
698
- #
699
- # @version SketchUp 6.0
700
- def invalidate
701
- end
702
-
703
- # The last_refresh_time method is used to retrieve the time for the last full
704
- # view refresh.
705
- #
706
- # @example
707
- # time = view.last_refresh_time
708
- #
709
- # @return [Float] time in milliseconds
710
- #
711
- # @version SketchUp 6.0
712
- def last_refresh_time(*args)
713
- end
714
-
715
- # The line_stipple= method is used to set the line pattern to use for drawing.
716
- # The stipple pattern is given as a string.
717
- # Valid strings are:
718
- # "." (Dotted Line),
719
- # "-" (Short Dashes Line),
720
- # "_" (Long Dashes Line),
721
- # "-.-" (Dash Dot Dash Line),
722
- # "" (Solid Line).
723
- #
724
- # This method is usually invoked within the draw method of a tool.
725
- #
726
- # @example
727
- # point8 = Geom::Point3d.new 0,0,0
728
- # point9 = Geom::Point3d.new 100,100,100
729
- # view.line_stipple = "-.-"
730
- # view = view.draw_lines point8, point9
731
- #
732
- # @param [String] pattern
733
- # A string stipple pattern, such as "-.-"
734
- #
735
- # @return [Sketchup::View] the View object
736
- #
737
- # @version SketchUp 6.0
738
- def line_stipple=(pattern)
739
- end
740
-
741
- # The line_width= method is used to set the line width to use for drawing. The
742
- # value is a Double indicating the desired width in pixels.
743
- #
744
- # This method is usually invoked within the draw method of a tool.
745
- #
746
- # @example
747
- # view.line_width = width
748
- #
749
- # @note As of SU2017 this will automatically scale the line width by the same
750
- # factor as {UI.scale_factor}.
751
- #
752
- # @param [Integer] width
753
- # The width in pixels.
754
- #
755
- # @return [Integer]
756
- #
757
- # @version SketchUp 6.0
758
- def line_width=(width)
759
- end
760
-
761
- # Loads a texture to be drawn with {#draw} or {#draw2d}.
762
- #
763
- # @example
764
- # module Example
765
- # class MyTool
766
- #
767
- # def activate
768
- # view = Sketchup.active_model.active_view
769
- # image_rep = view.model.materials.current.texture.image_rep
770
- # @texture_id = view.load_texture(image_rep)
771
- # end
772
- #
773
- # def deactivate(view)
774
- # view.release_texture(@texture_id)
775
- # end
776
- #
777
- # def draw(view)
778
- # points = [ [0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0] ]
779
- # uvs = [ [0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0] ]
780
- # view.draw(points, texture_id: @texture_id, uvs: uvs)
781
- # end
782
- #
783
- # end
784
- # end
785
- # Sketchup.active_model.select_tool(Example::MyTool.new)
786
- #
787
- # @note To conserve resources on the user's machine, textures can be loaded
788
- # only when there is a Ruby tool on the tool stack. Make sure to release the
789
- # texture when it's no longer needed. Any textures not already released
790
- # when the last Ruby tool on the tool stack is removed will be automatically
791
- # released by SketchUp.
792
- #
793
- # @note Avoid loading and releasing textures within the {Sketchup::Tool#draw}
794
- # event as that is not efficient.
795
- #
796
- # @param [Sketchup::ImageRep] image_rep
797
- #
798
- # @raise [ArgumentError] if the provided {Sketchup::ImageRep} is not valid.
799
- #
800
- # @raise [RuntimeError] if a Ruby tool was not on the tool stack.
801
- #
802
- # @return [Integer] A resource ID referring to the image loaded.
803
- #
804
- # @see #release_texture
805
- #
806
- # @see #draw
807
- def load_texture(image_rep)
808
- end
809
-
810
- # The lock_inference method is used to lock or unlock an inference.
811
- #
812
- # This method will typically be called from inside a tool class when the user
813
- # presses the shift key.
814
- #
815
- # With no arguments it unlocks all inferences. With one or two arguments, it
816
- # locks the inference based on the given InputPoint(s).
817
- #
818
- # @example
819
- # view = view.lock_inference
820
- # view = view.lock_inference(inputpoint)
821
- # view = view.lock_inference(inputpoint1, inputpoint2)
822
- #
823
- # @overload lock_inference
824
- #
825
- #
826
- # @overload lock_inference(inputpoint)
827
- #
828
- # @param [Sketchup::InputPoint] inputpoint
829
- # 1st InputPoint to inference to.
830
- #
831
- # @overload lock_inference(inputpoint, inputpoint2)
832
- #
833
- # @param [Sketchup::InputPoint] inputpoint
834
- # 1st InputPoint to inference to.
835
- # @param [Sketchup::InputPoint] inputpoint2
836
- # 2nd InputPoint to inference to.
837
- #
838
- # @return [Sketchup::View] a View object
839
- #
840
- # @version SketchUp 6.0
841
- def lock_inference(*args)
842
- end
843
-
844
- # The model method is used to retrieve the model for the current view.
845
- #
846
- # @example
847
- # model = view.model
848
- #
849
- # @return [Sketchup::Model] the model for this view
850
- #
851
- # @version SketchUp 6.0
852
- def model
853
- end
854
-
855
- # The pick_helper method is used to retrieve a pick helper for the view. See
856
- # the PickHelper class for information on pick helpers.
857
- #
858
- # This call returns an initialized PickHelper.
859
- #
860
- # @example
861
- # model = Sketchup.active_model
862
- # view = model.active_view
863
- # ph = view.pick_helper
864
- #
865
- # @overload pick_helper
866
- #
867
- # @return [Sketchup::PickHelper] a PickHelper object
868
- #
869
- # @overload pick_helper(x, y, aperture = 0)
870
- #
871
- # @param [Integer] x
872
- # @param [Integer] y
873
- # @param [Integer] aperture
874
- # @return [Sketchup::PickHelper] a PickHelper object
875
- #
876
- # @version SketchUp 6.0
877
- def pick_helper(*args)
878
- end
879
-
880
- # The pickray method is used to retrieve a ray passing through a given screen
881
- # position in the viewing direction.
882
- #
883
- # @example
884
- # ray = view.pickray x, y
885
- #
886
- # @overload pickray(screen_point)
887
- #
888
- # @param [Array(Integer, Integer)] screen_point
889
- # @return [Array(Geom::Point3d, Geom::Vector3d)] a ray
890
- #
891
- # @overload pickray(x, y)
892
- #
893
- # @param [Integer] x
894
- # @param [Integer] y
895
- # @return [Array(Geom::Point3d, Geom::Vector3d)] a ray
896
- #
897
- # @version SketchUp 6.0
898
- def pickray(*args)
899
- end
900
-
901
- # The pixels_to_model method is used to compute a model size from a pixel size
902
- # at a given point.
903
- #
904
- # This method is useful for deciding how big to draw something based on a
905
- # desired size in pixels.
906
- #
907
- # @example
908
- # size = view.pixels_to_model(pixels, point)
909
- #
910
- # @note As of SU2017 this will automatically scale the pixel-size by the same
911
- # factor as {UI.scale_factor}.
912
- #
913
- # @param [Numeric] pixels
914
- # The pixel size.
915
- #
916
- # @param [Geom::Point3d] point
917
- # A Point3d object where the size will be calculated from.
918
- #
919
- # @return [Float] the model size
920
- #
921
- # @version SketchUp 6.0
922
- def pixels_to_model(pixels, point)
923
- end
924
-
925
- # The refresh method is used to immediately force a redraw of the view.
926
- #
927
- # @example
928
- # model = Sketchup.active_model
929
- # view = model.active_view
930
- # refreshed_view = view.refresh
931
- #
932
- # @note This method might impact performance and if used incorrectly cause
933
- # instability or crashes. Don't use this unless you have verified that
934
- # you cannot use {#invalidate} instead.
935
- #
936
- # @return [Sketchup::View] the refreshed View object
937
- #
938
- # @version SketchUp 7.1
939
- def refresh
940
- end
941
-
942
- # Releases a texture loaded via {#load_texture}, freeing up it's memory.
943
- # It's good practice to do so whenever there is no longer any need for the
944
- # resource.
945
- #
946
- # For example, when your tool deactivates you probably want to release your
947
- # resources as you don't know if your tool will be used again.
948
- #
949
- # @example
950
- # module Example
951
- # class MyTool
952
- #
953
- # def activate
954
- # view = Sketchup.active_model.active_view
955
- # image_rep = view.model.materials.current.texture.image_rep
956
- # @texture_id = view.load_texture(image_rep)
957
- # end
958
- #
959
- # def deactivate(view)
960
- # view.release_texture(@texture_id)
961
- # end
962
- #
963
- # def draw(view)
964
- # points = [ [0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0] ]
965
- # uvs = [ [0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0] ]
966
- # view.draw(points, texture_id: @texture_id, uvs: uvs)
967
- # end
968
- #
969
- # end
970
- # end
971
- # Sketchup.active_model.select_tool(Example::MyTool.new)
972
- #
973
- # @param [Integer] texture_id
974
- #
975
- # @return [Boolean] +true+ if texture was released. +false+ otherwise.
976
- #
977
- # @see #load_texture
978
- def release_texture(texture_id)
979
- end
980
-
981
- # The remove_observer method is used to remove an observer from the current
982
- # object.
983
- #
984
- # @example
985
- # view = Sketchup.active_model.active_view
986
- # status = view.remove_observer observer
987
- #
988
- # @param [Object] observer
989
- # An observer.
990
- #
991
- # @return [Boolean] true if successful, false if unsuccessful.
992
- #
993
- # @version SketchUp 6.0
994
- def remove_observer(observer)
995
- end
996
-
997
- # The screen_coords method is used to retrieve the screen coordinates of the
998
- # given point on the screen.
999
- #
1000
- # The x and y values returned correspond to the x and y screen coordinates.
1001
- # Ignore the z values. If the referenced point is not in the current
1002
- # viewport, the x and/or y value may be negative.
1003
- #
1004
- # @example
1005
- # point = view.screen_coords(ORIGIN)
1006
- #
1007
- # @param [Geom::Point3d] point3d
1008
- # A Point3d object.
1009
- #
1010
- # @return [Geom::Point3d] A Point3d containing the screen position
1011
- #
1012
- # @version SketchUp 6.0
1013
- def screen_coords(point3d)
1014
- end
1015
-
1016
- # Set the drawing color for the view based on the direction of a line that you
1017
- # want to draw. These colors will match the axes colors in the SketchUp model
1018
- # (typically blue for straight up and down, etc.)
1019
- #
1020
- # This method is usually invoked within the draw method of a tool.
1021
- #
1022
- # @example
1023
- # view = view.set_color_from_line point1, point2
1024
- #
1025
- # @param [Geom::Point3d] point1
1026
- # Point3d object representing first point in the line.
1027
- #
1028
- # @param [Geom::Point3d] point2
1029
- # Point3d object representing the second point in the line.
1030
- #
1031
- # @return [Sketchup::View] a View object
1032
- #
1033
- # @version SketchUp 6.0
1034
- def set_color_from_line(point1, point2)
1035
- end
1036
-
1037
- # The show_frame method is used to show a frame of an Animation object in the
1038
- # current view.
1039
- #
1040
- # You can supply an optional delay in seconds to wait before showing the next
1041
- # frame. This can be useful to control the speed at which the animation runs.
1042
- #
1043
- # @example
1044
- # status = view.show_frame delay
1045
- #
1046
- # @param [Numeric] delay
1047
- # An optional delay in seconds.
1048
- #
1049
- # @return [Sketchup::View]
1050
- #
1051
- # @version SketchUp 6.0
1052
- def show_frame(delay)
1053
- end
1054
-
1055
- # This method is used to compute the bounds of the text when
1056
- # using {#draw_text}. The bounds are not a tight fit around the top and bottom
1057
- # as they include varying amount of line spacing depending on the font used.
1058
- #
1059
- # The {TextVerticalAlignCenter} option will align the text to the center of the
1060
- # height of the first line, not the whole boundingbox of the text.
1061
- #
1062
- # <b>Example of different vertical alignment and text bounds:</b>
1063
- #
1064
- # rdoc-image:../images/view-draw-text-with-bounds.png
1065
- #
1066
- # @example
1067
- # class ExampleTool
1068
- # TEXT_OPTIONS = {
1069
- # :font => "Arial",
1070
- # :size => 20,
1071
- # :bold => true,
1072
- # :align => TextAlignRight,
1073
- # :align => TextVerticalAlignBaseline
1074
- # }
1075
- #
1076
- # # Since `draw` is called frequently it can be useful to pre-compute and
1077
- # # cache values used by `draw`.
1078
- # def activate
1079
- # @text = "Hello SketchUp"
1080
- # @position = Geom::Point3d.new(200, 200, 0)
1081
- #
1082
- # # Compute text bounds
1083
- # view = Sketchup.active_model.active_view
1084
- # bounds = view.text_bounds(@position, @text, TEXT_OPTIONS)
1085
- #
1086
- # # Compute polygon for the text bounds
1087
- # x1, y1 = bounds.upper_left.to_a
1088
- # x2, y2 = bounds.lower_right.to_a
1089
- # @points = [
1090
- # Geom::Point3d.new(x1, y1),
1091
- # Geom::Point3d.new(x1, y2),
1092
- # Geom::Point3d.new(x2, y2),
1093
- # Geom::Point3d.new(x2, y1),
1094
- # ]
1095
- # end
1096
- #
1097
- # def draw(view)
1098
- # # Draw text bounds
1099
- # view.drawing_color = Sketchup::Color.new(255, 0, 0, 64)
1100
- # view.draw2d(GL_QUADS, @points)
1101
- #
1102
- # # Draw text
1103
- # view.draw_text(@position, @text, TEXT_OPTIONS)
1104
- # end
1105
- # end
1106
- #
1107
- # @note Under Windows the font name must be less than 32 characters - due to
1108
- # system limitations.
1109
- #
1110
- # @option options [String] :font The name of the font to use. If it does not
1111
- # exist on the system, a default font will be used instead.
1112
- #
1113
- # @option options [Integer] :size The size of the font in points
1114
- #
1115
- # @option options [Boolean] :bold Controls the Bold property of the font.
1116
- #
1117
- # @option options [Boolean] :italic Controls the Italic property of the font.
1118
- #
1119
- # @option options [Integer] :align The text alignment, one of the following
1120
- # constants: {TextAlignLeft}, {TextAlignCenter} or {TextAlignRight}.
1121
- #
1122
- # @option options [Integer] :vertical_align The vertical text alignment
1123
- # one of the following constants:
1124
- # {TextVerticalAlignBoundsTop}, {TextVerticalAlignBaseline},
1125
- # {TextVerticalAlignCapHeight} or {TextVerticalAlignCenter}.
1126
- #
1127
- # @param [Geom::Point3d] point
1128
- # A Point3d object representing a 2D coordinate
1129
- # in view space.
1130
- #
1131
- # @param [String] text
1132
- # The text string to draw.
1133
- #
1134
- # @param [Hash] options
1135
- # The text can be customized by providing a hash or
1136
- # named arguments of options.
1137
- #
1138
- # @return [Geom::Bounds2d]
1139
- #
1140
- # @see #draw_text
1141
- #
1142
- # @version SketchUp 2020.0
1143
- def text_bounds(point, text, options = {})
1144
- end
1145
-
1146
- # Set a tooltip to display in the view. This is useful for displaying tooltips
1147
- # in a tool that you write in Ruby.
1148
- #
1149
- # @example
1150
- # tooltip = view.tooltip = string
1151
- #
1152
- # @param [String] string
1153
- # The string tooltip.
1154
- #
1155
- # @return [String] the new tooltip string
1156
- #
1157
- # @version SketchUp 6.0
1158
- def tooltip=(string)
1159
- end
1160
-
1161
- # The vpheight method is used to retrieve the height of the viewport for the
1162
- # view.
1163
- #
1164
- # @example
1165
- # model = Sketchup.active_model
1166
- # view = model.active_view
1167
- # height = view.vpheight
1168
- #
1169
- # @return [Integer] the height of the viewport in pixels.
1170
- #
1171
- # @version SketchUp 6.0
1172
- def vpheight
1173
- end
1174
-
1175
- # The vpwidth method is used to retrieve the width of the viewport for the
1176
- # view.
1177
- #
1178
- # @example
1179
- # width = view.vpwidth
1180
- #
1181
- # @return [Integer] the width of the viewport in pixels.
1182
- #
1183
- # @version SketchUp 6.0
1184
- def vpwidth
1185
- end
1186
-
1187
- # The {#write_image} method is used to write the current view to an image file.
1188
- #
1189
- # @overload write_image(filename, width = view.vpwidth, height = view.vpheight, antialias = false, compression = 1.0)
1190
- #
1191
- # @note Prefer the overload with option hash instead of this variant. This
1192
- # overload is not updated with new options.
1193
- #
1194
- # @example
1195
- # filename => "c:/tmp/write_image.png"
1196
- # antialias => false
1197
- # compression => 0.9
1198
- # model = Sketchup.active_model
1199
- # view = model.active_view
1200
- # view.write_image(filename, 640, 480, antialias, compression)
1201
- #
1202
- # @param [String] filename
1203
- # The filename for the saved image
1204
- # @param [Integer] width
1205
- # Width in pixels, defaults to the current viewport width {#vpwidth}.
1206
- # @param [Integer] height
1207
- # Height in pixels, defaults to the current viewport height {#vpheight}.
1208
- # @param [Boolean] antialias
1209
- # @param [Float] compression
1210
- # Compression factor for JPEG images, between +0.0+ and +1.0+.
1211
- #
1212
- # @overload write_image(options)
1213
- #
1214
- # @example
1215
- # options = {
1216
- # :filename => "c:/tmp/write_image.png",
1217
- # :width => 640,
1218
- # :height => 480,
1219
- # :antialias => false,
1220
- # :compression => 0.9,
1221
- # :transparent => true
1222
- # }
1223
- # model = Sketchup.active_model
1224
- # view = model.active_view
1225
- # view.write_image(options)
1226
- #
1227
- # @version SketchUp 7
1228
- # @param [Hash] options
1229
- # @option options [String] filename The filename for the saved image.
1230
- # @option options [Integer] width (#vpwidth) Width in pixels (max +1600+).
1231
- # @option options [Integer] height (#vpheight) Height in pixels (max +16000+).
1232
- # @option options [Float] scale_factor (1.0) Scaling factor for
1233
- # elements that are viewport dependent, such as text heights, arrow heads,
1234
- # line widths, stipple patterns, etc. (Added in SketchUp 2019.2)
1235
- # @option options [Boolean] antialias (false)
1236
- # @option options [Float] compression (1.0) Compression factor for JPEG,
1237
- # images between +0.0+ and +1.0+.
1238
- # @option options [Boolean] transparent (false) Added in SketchUp 8.
1239
- #
1240
- # @overload write_image(options)
1241
- #
1242
- # It is possible to dump the framebuffer to file by setting +:source+ to
1243
- # +:framebuffer+. When saving the framebuffer only the following options are
1244
- # valid.
1245
- #
1246
- # @example
1247
- # options = {
1248
- # :filename => "c:/tmp/write_image.png",
1249
- # :source => :framebuffer,
1250
- # :compression => 0.9,
1251
- # }
1252
- # model = Sketchup.active_model
1253
- # view = model.active_view
1254
- # view.write_image(options)
1255
- #
1256
- # @version SketchUp 7
1257
- # @param [Hash] options
1258
- # @option options [String] filename The filename for the saved image.
1259
- # @option options [Boolean] source (:image) Set to +:framebuffer+ to dump the
1260
- # current framebuffer.
1261
- # @option options [Float] compression (1.0) Compression factor for JPEG,
1262
- # images between +0.0+ and +1.0+.
1263
- #
1264
- # @return [Boolean]
1265
- #
1266
- # @version SketchUp 6.0
1267
- def write_image(*args)
1268
- end
1269
-
1270
- # The zoom method is used to zoom in or out by some zoom factor.
1271
- #
1272
- # @example
1273
- # view = view.zoom factor
1274
- # view = view.zoom selection
1275
- # view = view.zoom entity
1276
- # view = view.zoom array_of_entities
1277
- #
1278
- # @param [Numeric, Sketchup::Selection, Sketchup::Entity, Array<Sketchup::Entity>] zoom_or_ents
1279
- # A Float zoom factor from 1.0 or larger or an Array or
1280
- # collection of entities to "zoom extents" around.
1281
- #
1282
- # @return [Sketchup::View] the zoomed View object
1283
- #
1284
- # @version SketchUp 6.0
1285
- def zoom(zoom_or_ents)
1286
- end
1287
-
1288
- # The zoom_extents method is used to zoom to the extents about the entire
1289
- # model, as if the user has selected the zoom extents command from the menu.
1290
- #
1291
- # @example
1292
- # view = Sketchup.active_model.active_view
1293
- # new_view = view.zoom_extents
1294
- #
1295
- # @return [Sketchup::View] the zoomed View object
1296
- #
1297
- # @version SketchUp 6.0
1298
- def zoom_extents
1299
- end
1300
-
1301
- end
1
+ # Copyright:: Copyright 2022 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This class contains methods to manipulate the current point of view of the
5
+ # model. The drawing methods here (draw_line, draw_polyline, etc) are meant to
6
+ # be invoked within a tool's Tool.draw method. Calling them outside Tool.draw
7
+ # will have no effect.
8
+ #
9
+ # You access the View by calling the Model.active_view method.
10
+ #
11
+ # @example
12
+ # view = Sketchup.active_model.active_view
13
+ #
14
+ # @version SketchUp 6.0
15
+ class Sketchup::View
16
+
17
+ # Instance Methods
18
+
19
+ # The add_observer method is used to add an observer to the current object.
20
+ #
21
+ # @example
22
+ # view = Sketchup.active_model.active_view
23
+ # status = view.add_observer observer
24
+ #
25
+ # @param [Object] observer
26
+ # An observer.
27
+ #
28
+ # @return [Boolean] true if successful, false if unsuccessful.
29
+ #
30
+ # @version SketchUp 6.0
31
+ def add_observer(observer)
32
+ end
33
+
34
+ # The animation= method is used to set an animation that is displayed for a
35
+ # view. See Animation for details on how to create an animation object.
36
+ #
37
+ # @example
38
+ # animation = ViewSpinner.new
39
+ # model = Sketchup.active_model
40
+ # view = model.active_view
41
+ # anim = view.animation=animation
42
+ # if (anim)
43
+ # UI.messagebox anim
44
+ # else
45
+ # UI.messagebox "Failure"
46
+ # end
47
+ #
48
+ # @param [#nextFrame] animation
49
+ # An Animation object.
50
+ #
51
+ # @return [#nextFrame] the newly set Animation object
52
+ #
53
+ # @version SketchUp 6.0
54
+ def animation=(animation)
55
+ end
56
+
57
+ # The average_refresh_time is used to set the average time used to refresh the
58
+ # current model in the view. This can be used to estimate the frame rate for
59
+ # an animation.
60
+ #
61
+ # @example
62
+ # model = Sketchup.active_model
63
+ # view = model.active_view
64
+ # time = view.average_refresh_time
65
+ #
66
+ # @return [Float] the time in seconds
67
+ #
68
+ # @version SketchUp 6.0
69
+ def average_refresh_time
70
+ end
71
+
72
+ # The camera method is used to retrieve the camera for the view.
73
+ #
74
+ # @example
75
+ # camera = view.camera
76
+ #
77
+ # @return [Sketchup::Camera] a Camera object
78
+ #
79
+ # @version SketchUp 6.0
80
+ def camera
81
+ end
82
+
83
+ # The {#camera=} method is used to set the camera for the view. If a transition
84
+ # time is given, then it will animate the transition from the current camera
85
+ # to the new one.
86
+ #
87
+ # @example
88
+ # camera = Sketchup::Camera.new([5, 5, 9], [5, 10, 0], Z_AXIS)
89
+ # view = Sketchup.active_model.active_view
90
+ # view.camera = camera
91
+ #
92
+ # @overload camera=(camera)
93
+ #
94
+ # @param [Sketchup::Camera] camera The new camera object.
95
+ #
96
+ # @overload camera=(camera_and_transition)
97
+ #
98
+ # @param [Array(Sketchup::Camera, Float)] camera_and_transition
99
+ # The second item in the array represents the transition time from the
100
+ # existing camera to the new one.
101
+ #
102
+ # @version SketchUp 6.0
103
+ def camera=(arg)
104
+ end
105
+
106
+ # The center method is used to retrieve the coordinates of the center of the
107
+ # view in pixels. It is returned as an array of 2 values for x and y.
108
+ #
109
+ # @example
110
+ # model = Sketchup.active_model
111
+ # view = model.active_view
112
+ # c = view.center
113
+ #
114
+ # @return [Geom::Point3d] the center of the view
115
+ #
116
+ # @version SketchUp 6.0
117
+ def center
118
+ end
119
+
120
+ # The corner method is used to retrieve the coordinates of one of the corners
121
+ # of the view. The argument is an index between 0 and 3 that identifies which
122
+ # corner you want. This method returns an array with two integers which are
123
+ # the coordinates of the corner of the view in the view space. If the view
124
+ # uses a Camera with a fixed aspect ratio, then the corners are the corners of
125
+ # the viewing are of the camera which might be different than the actual
126
+ # corners of the view itself.
127
+ #
128
+ # The index numbers are as follows:
129
+ # - 0: top left,
130
+ # - 1: top right,
131
+ # - 2: bottom left,
132
+ # - 3: bottom right.
133
+ #
134
+ # @example
135
+ # point = view.corner index
136
+ #
137
+ # @param [Integer] index
138
+ # A value between (or including) 0 and 3 identifying the
139
+ # corner whose coordinate you want to retrieve.
140
+ #
141
+ # @return [Array(Integer, Integer)] a 2d array [w,h] representing the screen point
142
+ #
143
+ # @version SketchUp 6.0
144
+ def corner(index)
145
+ end
146
+
147
+ # The {#draw} method is used to do basic drawing. This method can only be
148
+ # called from within the {Tool#draw} method of a tool that you implement in
149
+ # Ruby.
150
+ #
151
+ # The following constants are all OpenGL terms and have been externalized to
152
+ # Ruby. Here is a summary of their meanings:
153
+ #
154
+ # [GL_POINTS]
155
+ # Treats each vertex as a single point. Vertex n defines point n. N
156
+ # points are drawn.
157
+ #
158
+ # [GL_LINES]
159
+ # Treats each pair of vertices as
160
+ # an independent line segment. Vertices 2n-1 and 2n define line n. N/2 lines
161
+ # are drawn.
162
+ #
163
+ # [GL_LINE_STRIP]
164
+ # Draws a connected group of line
165
+ # segments from the first vertex to the last. Vertices n and n+1 define
166
+ # line n. N-1 lines are drawn.
167
+ #
168
+ # [GL_LINE_LOOP]
169
+ # Draws a connected group of line segments from the first vertex to the last,
170
+ # then back to the first. Vertices n and n+1 define line n. The last line,
171
+ # however, is defined by vertices N and 1. N lines are drawn.
172
+ #
173
+ # [GL_TRIANGLES]
174
+ # Treats each triplet of vertices as an independent
175
+ # triangle. Vertices 3n-2, 3n-1, and 3n define triangle n. N/3 triangles are
176
+ # drawn.
177
+ #
178
+ # [GL_TRIANGLE_STRIP]
179
+ # Draws a connected group of triangles. One triangle is defined for each
180
+ # vertex presented after the first two vertices. For odd n, vertices n, n+1,
181
+ # and n+2 define triangle n. For even n, vertices n+1, n, and n+2 define
182
+ # triangle n. N-2 triangles are drawn.
183
+ #
184
+ # [GL_TRIANGLE_FAN]
185
+ # Draws a connected group of triangles.
186
+ # One triangle is defined for each vertex presented after the first two
187
+ # vertices. Vertices 1, n+1, and n+2 define triangle n. N-2 triangles are
188
+ # drawn.
189
+ #
190
+ # [GL_QUADS]
191
+ # Treats each group of four vertices as an
192
+ # independent quadrilateral. Vertices 4n-3, 4n-2, 4n-1, and 4n define
193
+ # quadrilateral n. N/4 quadrilaterals are drawn.
194
+ #
195
+ # [GL_QUAD_STRIP]
196
+ # Draws a connected group of quadrilaterals. One quadrilateral is
197
+ # defined for each pair of vertices presented after the first pair.
198
+ # Vertices 2n-1, 2n, 2n+2, and 2n+1 define quadrilateral n. N/2-1
199
+ # quadrilaterals are drawn. Note that the order in which vertices are used to
200
+ # construct a quadrilateral from strip data is different from that used with
201
+ # independent data.
202
+ #
203
+ # [GL_POLYGON]
204
+ # Draws a single, convex polygon. Vertices 1
205
+ # through N define this polygon.
206
+ #
207
+ # @example
208
+ # points = [
209
+ # Geom::Point3d.new(0, 0, 0),
210
+ # Geom::Point3d.new(9, 0, 0),
211
+ # Geom::Point3d.new(9, 9, 0),
212
+ # Geom::Point3d.new(0, 9, 0)
213
+ # ]
214
+ # view.draw(GL_LINE_LOOP, points)
215
+ #
216
+ # @note If you draw outside the model bounds you need to implement
217
+ # {Tool#getExtents} which returns a bounding box large enough to include the
218
+ # points you draw. Otherwise your drawing will be clipped.
219
+ #
220
+ # @overload draw(openglenum, points)
221
+ #
222
+ # @param [Integer] openglenum
223
+ # The item you are going to draw, one of the constants
224
+ # from the comments, such as +GL_LINES+.
225
+ # @param [Array<Geom::Point3d>] points
226
+ #
227
+ # @overload draw(openglenum, *points)
228
+ #
229
+ # @param [Integer] openglenum
230
+ # The item you are going to draw, one of the constants
231
+ # from the comments, such as +GL_LINES+.
232
+ # @param [Array<Geom::Point3d>] points
233
+ #
234
+ # @overload draw(openglenum, points, **options)
235
+ #
236
+ # @version SketchUp 2020.0
237
+ # @param [Integer] openglenum
238
+ # The item you are going to draw, one of the constants
239
+ # from the comments, such as +GL_LINES+.
240
+ # @param [Array<Geom::Point3d>] points
241
+ # @param [Hash] options
242
+ # @option options [Array<Geom::Vector3d>] :normals
243
+ # Without normals the polygons will be rendered with flat shading. No
244
+ # light will affect it. By providing an array of vertex normals lighting
245
+ # is turned on and will use the model's current light. Note that the number
246
+ # of normals must match the number of points provided.
247
+ # @option options [Integer] :texture
248
+ # A texture id provided by {#load_texture}.
249
+ # @option options [Array<Geom::Vector3d>] :uvs
250
+ # Set of UV (Not UVQ) coordinates matching the number of points provided.
251
+ # This must be used along with the +:texture+ option.
252
+ #
253
+ # @overload draw(openglenum, *points, **options)
254
+ #
255
+ # @version SketchUp 2020.0
256
+ # @param [Integer] openglenum
257
+ # The item you are going to draw, one of the constants
258
+ # from the comments, such as +GL_LINES+.
259
+ # @param [Array<Geom::Point3d>] points
260
+ # @param [Hash] options
261
+ # @option options [Array<Geom::Vector3d>] :normals ([])
262
+ # Without normals the polygons will be rendered with flat shading. No
263
+ # light will affect it. By providing an array of vertex normals lighting
264
+ # is turned on and will use the model's current light. Note that the number
265
+ # of normals must match the number of points provided.
266
+ # @option options [Integer] :texture
267
+ # A texture id provided by {#load_texture}.
268
+ # @option options [Array<Geom::Vector3d>] :uvs
269
+ # Set of UV (Not UVQ) coordinates matching the number of points provided.
270
+ # This must be used along with the +:texture+ option.
271
+ #
272
+ # @return [Sketchup::View]
273
+ #
274
+ # @see Tool#getExtents
275
+ #
276
+ # @version SketchUp 6.0
277
+ def draw(*args)
278
+ end
279
+
280
+ # The {#draw2d} method is used to draw in screen space (using 2D screen
281
+ # coordinates) instead of 3D space.
282
+ #
283
+ # The second parameter is an {Array} of {Geom::Point3d} objects (or several
284
+ # individual {Geom::Point3d} objects). These {Geom::Point3d} objects are in
285
+ # screen space, not 3D space.
286
+ # The X value corresponds to the number of pixels from the left edge of the
287
+ # drawing area. The Y value corresponds to the number of pixels down from
288
+ # the top of the drawing area. The Z value is not used.
289
+ #
290
+ # @example
291
+ # points = [
292
+ # Geom::Point3d.new(0, 0, 0),
293
+ # Geom::Point3d.new(8, 0, 0),
294
+ # Geom::Point3d.new(8, 4, 0),
295
+ # Geom::Point3d.new(0, 4, 0)
296
+ # ]
297
+ # view.draw2d(GL_LINE_STRIP, points)
298
+ #
299
+ # @overload draw2d(openglenum, points)
300
+ #
301
+ # @param [Integer] openglenum
302
+ # The item you are going to draw, one of the constants
303
+ # from the comments, such as +GL_LINES+.
304
+ # @param [Array<Geom::Point3d>] points
305
+ #
306
+ # @overload draw2d(openglenum, *points)
307
+ #
308
+ # @param [Integer] openglenum
309
+ # The item you are going to draw, one of the constants
310
+ # from the comments, such as +GL_LINES+.
311
+ # @param [Array<Geom::Point3d>] points
312
+ #
313
+ # @overload draw2d(openglenum, points, **options)
314
+ #
315
+ # @version SketchUp 2020.0
316
+ # @param [Integer] openglenum
317
+ # The item you are going to draw, one of the constants
318
+ # from the comments, such as +GL_LINES+.
319
+ # @param [Array<Geom::Point3d>] points
320
+ # @param [Hash] options
321
+ # @option options [Integer] :texture
322
+ # A texture id provided by {#load_texture}.
323
+ # @option options [Array<Geom::Vector3d>] :uvs
324
+ # Set of UV (Not UVQ) coordinates matching the number of points provided.
325
+ # This must be used along with the +:texture+ option.
326
+ #
327
+ # @overload draw2d(openglenum, *points, **options)
328
+ #
329
+ # @version SketchUp 2020.0
330
+ # @param [Integer] openglenum
331
+ # The item you are going to draw, one of the constants
332
+ # from the comments, such as +GL_LINES+.
333
+ # @param [Array<Geom::Point3d>] points
334
+ # @param [Hash] options
335
+ # @option options [Integer] :texture
336
+ # A texture id provided by {#load_texture}.
337
+ # @option options [Array<Geom::Vector3d>] :uvs
338
+ # Set of UV (Not UVQ) coordinates matching the number of points provided.
339
+ # This must be used along with the +:texture+ option.
340
+ #
341
+ # @return [Sketchup::View]
342
+ #
343
+ # @see #draw
344
+ #
345
+ # @see UI.scale_factor
346
+ #
347
+ # @version SketchUp 6.0
348
+ def draw2d(*args)
349
+ end
350
+
351
+ # The draw_lines method is used to draw disconnected lines.
352
+ #
353
+ # You must have an even number of points. This method is usually invoked
354
+ # within the draw method of a tool.
355
+ #
356
+ # @example
357
+ # point4 = Geom::Point3d.new 0,0,0
358
+ # point5 = Geom::Point3d.new 100,100,100
359
+ # # returns a view
360
+ # status = view.drawing_color="red"
361
+ # status = view.draw_lines point4, point5
362
+ #
363
+ # @overload draw_lines(points, ...)
364
+ #
365
+ # @param [Array<Geom::Point3d>] points
366
+ # An even number of Point3d objects.
367
+ # @return [Sketchup::View]
368
+ #
369
+ # @overload draw_lines(points)
370
+ #
371
+ # @param [Array<Geom::Point3d>] points An array of Point3d objects.
372
+ # @return [Sketchup::View]
373
+ #
374
+ # @version SketchUp 6.0
375
+ def draw_line(*args)
376
+ end
377
+
378
+ # The draw_lines method is used to draw disconnected lines.
379
+ #
380
+ # You must have an even number of points. This method is usually invoked
381
+ # within the draw method of a tool.
382
+ #
383
+ # @example
384
+ # point4 = Geom::Point3d.new 0,0,0
385
+ # point5 = Geom::Point3d.new 100,100,100
386
+ # # returns a view
387
+ # status = view.drawing_color="red"
388
+ # status = view.draw_lines point4, point5
389
+ #
390
+ # @overload draw_lines(points, ...)
391
+ #
392
+ # @param [Array<Geom::Point3d>] points
393
+ # An even number of Point3d objects.
394
+ # @return [Sketchup::View]
395
+ #
396
+ # @overload draw_lines(points)
397
+ #
398
+ # @param [Array<Geom::Point3d>] points An array of Point3d objects.
399
+ # @return [Sketchup::View]
400
+ #
401
+ # @version SketchUp 6.0
402
+ def draw_lines(*args)
403
+ end
404
+
405
+ # This method is used to draw points.
406
+ #
407
+ # This method is usually invoked within the draw method of a tool.
408
+ #
409
+ # @example
410
+ # point3 = Geom::Point3d.new 0,0,0
411
+ # # returns a view
412
+ # status = view.draw_points(point3, 10, 1, "red")
413
+ #
414
+ # @param [Array<Geom::Point3d>] points
415
+ #
416
+ # @param [Integer] size
417
+ # Size of the point in pixels.
418
+ #
419
+ # @param [Integer] style
420
+ # 1 = open square, 2 = filled square, 3 = "+", 4 = "X", 5 = "*",
421
+ # 6 = open triangle, 7 = filled triangle.
422
+ #
423
+ # @param [Sketchup::Color] color
424
+ #
425
+ # @return [Sketchup::View] a View object
426
+ #
427
+ # @version SketchUp 6.0
428
+ def draw_points(points, size = 6, style = 3, color = 'black')
429
+ end
430
+
431
+ # The draw_polyline method is used to draw a series of connected line segments
432
+ # from pt1 to pt2 to pt3, and so on.
433
+ #
434
+ # This method is usually invoked within the draw method of a tool.
435
+ #
436
+ # @example
437
+ # point12 = Geom::Point3d.new 0,0,0
438
+ # point13 = Geom::Point3d.new 10,10,10
439
+ # point14 = Geom::Point3d.new 20,20,20
440
+ # point15 = Geom::Point3d.new 30,30,30
441
+ # status = view.draw_polyline point12, point13, point14, point15
442
+ #
443
+ # @overload draw_polyline(points, ...)
444
+ #
445
+ # @param [Array<Geom::Point3d>] points An even number of Point3d objects.
446
+ # @return [Sketchup::View]
447
+ #
448
+ # @overload draw_polyline(points)
449
+ #
450
+ # @param [Array<Geom::Point3d>] points An array of Point3d objects.
451
+ # @return [Sketchup::View]
452
+ #
453
+ # @version SketchUp 6.0
454
+ def draw_polyline(*args)
455
+ end
456
+
457
+ # This method is used to draw text on the screen and is usually invoked within
458
+ # the draw method of a tool.
459
+ #
460
+ # The {TextVerticalAlignCenter} option will align the text to the center of the
461
+ # height of the first line, not the whole boundingbox of the text. To align
462
+ # around the full bounds of the text, use {#text_bounds} to compute the
463
+ # desired alignment.
464
+ #
465
+ # The vertical alignment can vary between fonts and platforms. It's recommended
466
+ # to test different fonts and find one that fits well across both platforms
467
+ # for your purposes.
468
+ #
469
+ # <b>Example of different vertical alignment and text bounds:</b>
470
+ #
471
+ # rdoc-image:../images/view-draw-text-with-bounds.png
472
+ #
473
+ # @bug Prior to SU2022.0, on macOS, the vertical text alignment for some fonts
474
+ # could appear to be offset from their expected positions. As of SU2022.0 the
475
+ # vertical alignment should be more accurate and consistent.
476
+ #
477
+ # @example
478
+ # class ExampleTool
479
+ # def draw(view)
480
+ # # This works in all SketchUp versions and draws the text using the
481
+ # # default font, size and color (i.e. the model edge color).
482
+ # point = Geom::Point3d.new(200, 100, 0)
483
+ # view.draw_text(point, "This is a test")
484
+ #
485
+ # # This works in SketchUp 2016 and up.
486
+ # options = {
487
+ # :font => "Arial",
488
+ # :size => 20,
489
+ # :bold => true,
490
+ # :align => TextAlignRight
491
+ # }
492
+ # point = Geom::Point3d.new(200, 200, 0)
493
+ # view.draw_text(point, "This is another\ntest", options)
494
+ #
495
+ # # You can also use Ruby 2.0's named arguments:
496
+ # point = Geom::Point3d.new(200, 200, 0)
497
+ # view.draw_text(point, "Hello world!", color: "Red")
498
+ # end
499
+ # end
500
+ #
501
+ # @example Cross Platform Font Size
502
+ # class ExampleTool
503
+ # IS_WIN = Sketchup.platform == :platform_win
504
+ #
505
+ # def draw(view)
506
+ # draw_text(view, [100, 200, 0], "Hello World", size: 20)
507
+ # end
508
+ #
509
+ # private
510
+ #
511
+ # # This will ensure text is drawn with consistent size across platforms,
512
+ # # using pixels as size units.
513
+ # def draw_text(view, position, text, **options)
514
+ # native_options = options.dup
515
+ # if IS_WIN && options.key?(:size)
516
+ # native_options[:size] = pixels_to_points(options[:size])
517
+ # end
518
+ # view.draw_text(position, text, **native_options)
519
+ # end
520
+ #
521
+ # def pixels_to_points(pixels)
522
+ # ((pixels.to_f / 96.0) * 72.0).round
523
+ # end
524
+ # end
525
+ #
526
+ # @note Under Windows the font name must be less than 32 characters - due to
527
+ # system limitations.
528
+ #
529
+ # @note As of SU2017 this will automatically scale the font-size by the same
530
+ # factor as {UI.scale_factor}.
531
+ #
532
+ # @note The font size is platform dependent. On Windows the method expects
533
+ # points, where on Mac it's pixels. See "Cross Platform Font Size" example
534
+ # for details.
535
+ #
536
+ # @overload draw_text(point, text)
537
+ #
538
+ # @param [Geom::Point3d] point A Point3d object representing a 2D coordinate
539
+ # in view space.
540
+ # @param [String] text The text string to draw.
541
+ #
542
+ # @overload draw_text(point, text, options = {})
543
+ #
544
+ # @version SketchUp 2016
545
+ # @param [Geom::Point3d] point A Point3d object representing a 2D coordinate
546
+ # in view space.
547
+ # @param [String] text The text string to draw.
548
+ # @param [Hash] options The text can be customized by providing a hash or
549
+ # named arguments of options.
550
+ # @option options [String] :font The name of the font to use. If it does not
551
+ # exist on the system, a default font will be used instead.
552
+ # @option options [Integer] :size The size of the font in points
553
+ # @option options [Boolean] :bold Controls the Bold property of the font.
554
+ # @option options [Boolean] :italic Controls the Italic property of the font.
555
+ # @option options [Sketchup::Color] :color The color to draw the text with.
556
+ # @option options [Integer] :align The text alignment, one of the following
557
+ # constants: {TextAlignLeft}, {TextAlignCenter} or {TextAlignRight}.
558
+ # @option options [Integer] :vertical_align <b>Added SketchUp 2020.0.</b>
559
+ # The vertical text alignment, one of the following constants:
560
+ # {TextVerticalAlignBoundsTop}, {TextVerticalAlignBaseline},
561
+ # {TextVerticalAlignCapHeight} or {TextVerticalAlignCenter}. Note that
562
+ # some fonts on Mac might not align as expected due to the system
563
+ # reporting incorrect font metrics.
564
+ #
565
+ # @return [Sketchup::View]
566
+ #
567
+ # @version SketchUp 6.0
568
+ def draw_text(*args)
569
+ end
570
+
571
+ # The drawing_color method is used to set the color that is used for drawing
572
+ # to the view.
573
+ #
574
+ # This method is usually invoked within the draw method of a tool.
575
+ #
576
+ # @example
577
+ # view = view.drawing_color = color
578
+ #
579
+ # @param [Sketchup::Color, String] color
580
+ # A Color object.
581
+ #
582
+ # @return [Sketchup::View]
583
+ #
584
+ # @version SketchUp 6.0
585
+ def drawing_color=(color)
586
+ end
587
+
588
+ # The dynamic= method allows you to degrade visual quality while improving
589
+ # performance when a model is large and view refresh time is slow. For
590
+ # example, if you were using a Ruby script to animate the camera through
591
+ # a large scene, you may want to set dynamic to true during that time.
592
+ #
593
+ # See also camera.rb which is part of the film and stage ruby
594
+ # scripts.
595
+ #
596
+ # @deprecated This method is no longer doing anything.
597
+ #
598
+ # @example
599
+ # view.dynamic = true
600
+ #
601
+ # @param [Boolean] value
602
+ #
603
+ # @return [Boolean]
604
+ #
605
+ # @version SketchUp 6.0
606
+ def dynamic=(value)
607
+ end
608
+
609
+ # The field_of_view method is used get the view's field of view setting, in
610
+ # degrees.
611
+ #
612
+ # @example
613
+ # fov = Sketchup.active_model.active_view.field_of_view
614
+ #
615
+ # @return [Float] the field of view
616
+ #
617
+ # @version SketchUp 6.0
618
+ def field_of_view
619
+ end
620
+
621
+ # The field_of_view= method is used set the view's field of view setting,
622
+ # in degrees.
623
+ #
624
+ # @example
625
+ # my_view = Sketchup.active_model.active_view
626
+ # my_view.field_of_view = 45
627
+ # my_view.invalidate
628
+ #
629
+ # @param [Numeric] fov
630
+ # the field of view
631
+ #
632
+ # @return [Numeric]
633
+ #
634
+ # @version SketchUp 6.0
635
+ def field_of_view=(fov)
636
+ end
637
+
638
+ # The guess_target method is used to guess at what the user is looking at when
639
+ # you have a perspective view.
640
+ #
641
+ # This method is useful when writing a viewing tool. See also camera.rb which
642
+ # is part of the film and stage ruby scripts.
643
+ #
644
+ # @example
645
+ # target = view.guess_target
646
+ #
647
+ # @return [Geom::Point3d] a Point3d object representing the point in the
648
+ # model that the user is likely interested in.
649
+ #
650
+ # @version SketchUp 6.0
651
+ def guess_target(*args)
652
+ end
653
+
654
+ # The inference_locked? method is used to determine if inference locking is on
655
+ # for the view.
656
+ #
657
+ # @example
658
+ # model = Sketchup.active_model
659
+ # view = model.active_view
660
+ # status = view.inference_locked
661
+ #
662
+ # @return [Boolean]
663
+ #
664
+ # @version SketchUp 6.0
665
+ def inference_locked?
666
+ end
667
+
668
+ # The inputpoint method is used to retrieve an input point.
669
+ #
670
+ # This will normally be used inside one of the mouse event handling methods in
671
+ # a tool. Usually, it is preferable to create the InputPoint first and then
672
+ # use the pick method on it.
673
+ #
674
+ # @example
675
+ # inputpoint = view.inputpoint x, y, inputpoint1
676
+ #
677
+ # @param [Numeric] x
678
+ # A x value.
679
+ #
680
+ # @param [Numeric] y
681
+ # A y value.
682
+ #
683
+ # @param [Sketchup::InputPoint] inputpoint1
684
+ # An InputPoint object.
685
+ #
686
+ # @return [Sketchup::InputPoint]
687
+ #
688
+ # @version SketchUp 6.0
689
+ def inputpoint(x, y, inputpoint1)
690
+ end
691
+
692
+ # The invalidate method is used mark the view as in need of a redraw.
693
+ #
694
+ # @example
695
+ # model = Sketchup.active_model
696
+ # view = model.active_view
697
+ # invalidated_view = view.invalidate
698
+ #
699
+ # @note This is the preferred method to update the viewport. Use this before
700
+ # trying to use {#refresh}.
701
+ #
702
+ # @return [Sketchup::View] the invalidated View object
703
+ #
704
+ # @version SketchUp 6.0
705
+ def invalidate
706
+ end
707
+
708
+ # The last_refresh_time method is used to retrieve the time for the last full
709
+ # view refresh.
710
+ #
711
+ # @example
712
+ # time = view.last_refresh_time
713
+ #
714
+ # @return [Float] time in milliseconds
715
+ #
716
+ # @version SketchUp 6.0
717
+ def last_refresh_time(*args)
718
+ end
719
+
720
+ # The line_stipple= method is used to set the line pattern to use for drawing.
721
+ # The stipple pattern is given as a string.
722
+ # Valid strings are:
723
+ # "." (Dotted Line),
724
+ # "-" (Short Dashes Line),
725
+ # "_" (Long Dashes Line),
726
+ # "-.-" (Dash Dot Dash Line),
727
+ # "" (Solid Line).
728
+ #
729
+ # This method is usually invoked within the draw method of a tool.
730
+ #
731
+ # @example
732
+ # point8 = Geom::Point3d.new 0,0,0
733
+ # point9 = Geom::Point3d.new 100,100,100
734
+ # view.line_stipple = "-.-"
735
+ # view = view.draw_lines point8, point9
736
+ #
737
+ # @param [String] pattern
738
+ # A string stipple pattern, such as "-.-"
739
+ #
740
+ # @return [Sketchup::View] the View object
741
+ #
742
+ # @version SketchUp 6.0
743
+ def line_stipple=(pattern)
744
+ end
745
+
746
+ # The line_width= method is used to set the line width to use for drawing. The
747
+ # value is a Double indicating the desired width in pixels.
748
+ #
749
+ # This method is usually invoked within the draw method of a tool.
750
+ #
751
+ # @example
752
+ # view.line_width = width
753
+ #
754
+ # @note As of SU2017 this will automatically scale the line width by the same
755
+ # factor as {UI.scale_factor}.
756
+ #
757
+ # @param [Integer] width
758
+ # The width in pixels.
759
+ #
760
+ # @return [Integer]
761
+ #
762
+ # @version SketchUp 6.0
763
+ def line_width=(width)
764
+ end
765
+
766
+ # Loads a texture to be drawn with {#draw} or {#draw2d}.
767
+ #
768
+ # @example
769
+ # module Example
770
+ # class MyTool
771
+ # def activate
772
+ # view = Sketchup.active_model.active_view
773
+ # image_rep = view.model.materials.current.texture.image_rep
774
+ # @texture_id = view.load_texture(image_rep)
775
+ # end
776
+ #
777
+ # def deactivate(view)
778
+ # view.release_texture(@texture_id)
779
+ # end
780
+ #
781
+ # def draw(view)
782
+ # points = [ [0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0] ]
783
+ # uvs = [ [0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0] ]
784
+ # view.draw(GL_QUADS, points, texture: @texture_id, uvs: uvs)
785
+ # end
786
+ # end
787
+ # end
788
+ # Sketchup.active_model.select_tool(Example::MyTool.new)
789
+ #
790
+ # @note To conserve resources on the user's machine, textures can be loaded
791
+ # only when there is a Ruby tool on the tool stack. Make sure to release the
792
+ # texture when it's no longer needed. Any textures not already released
793
+ # when the last Ruby tool on the tool stack is removed will be automatically
794
+ # released by SketchUp.
795
+ #
796
+ # @note Avoid loading and releasing textures within the {Sketchup::Tool#draw}
797
+ # event as that is not efficient.
798
+ #
799
+ # @param [Sketchup::ImageRep] image_rep
800
+ #
801
+ # @raise [ArgumentError] if the provided {Sketchup::ImageRep} is not valid.
802
+ #
803
+ # @raise [RuntimeError] if a Ruby tool was not on the tool stack.
804
+ #
805
+ # @return [Integer] A resource ID referring to the image loaded.
806
+ #
807
+ # @see #release_texture
808
+ #
809
+ # @see #draw
810
+ #
811
+ # @version SketchUp 2020.0
812
+ def load_texture(image_rep)
813
+ end
814
+
815
+ # The {#lock_inference} method is used to lock or unlock an inference.
816
+ #
817
+ # This method will typically be called from inside a tool class when the user
818
+ # presses the shift key or arrow keys.
819
+ #
820
+ # With no arguments it unlocks all inferences. With one argument it locks
821
+ # inference based on that passed {Sketchup::InputPoint}'s entities, e.g. along
822
+ # a {Sketchup::Edge}'s line or a {Sketchup::Face}'s plane. With two arguments,
823
+ # it locks inference along an axis.
824
+ #
825
+ # @example
826
+ # view = view.lock_inference
827
+ # view = view.lock_inference(inputpoint)
828
+ # view = view.lock_inference(inputpoint1, inputpoint2)
829
+ #
830
+ # @overload lock_inference
831
+ #
832
+ #
833
+ # @overload lock_inference(inputpoint)
834
+ #
835
+ # @param [Sketchup::InputPoint] inputpoint
836
+ #
837
+ # @overload lock_inference(inputpoint, inputpoint2)
838
+ #
839
+ # @param [Sketchup::InputPoint] inputpoint
840
+ # @param [Sketchup::InputPoint] inputpoint2
841
+ # @example
842
+ # # Lock inference to X axis.
843
+ # # The points can be anywhere; only the vector between them affects
844
+ # # the result.
845
+ # view.lock_inference(
846
+ # Sketchup::InputPoint.new(ORIGIN),
847
+ # Sketchup::InputPoint.new(Geom::Point3d.new(1, 0, 0))
848
+ # )
849
+ #
850
+ # @return [Sketchup::View] a View object
851
+ #
852
+ # @version SketchUp 6.0
853
+ def lock_inference(*args)
854
+ end
855
+
856
+ # The model method is used to retrieve the model for the current view.
857
+ #
858
+ # @example
859
+ # model = view.model
860
+ #
861
+ # @return [Sketchup::Model] the model for this view
862
+ #
863
+ # @version SketchUp 6.0
864
+ def model
865
+ end
866
+
867
+ # The pick_helper method is used to retrieve a pick helper for the view. See
868
+ # the PickHelper class for information on pick helpers.
869
+ #
870
+ # This call returns an initialized PickHelper.
871
+ #
872
+ # @example
873
+ # model = Sketchup.active_model
874
+ # view = model.active_view
875
+ # ph = view.pick_helper
876
+ #
877
+ # @overload pick_helper
878
+ #
879
+ # @return [Sketchup::PickHelper] a PickHelper object
880
+ #
881
+ # @overload pick_helper(x, y, aperture = 0)
882
+ #
883
+ # @param [Integer] x
884
+ # @param [Integer] y
885
+ # @param [Integer] aperture
886
+ # @return [Sketchup::PickHelper] a PickHelper object
887
+ #
888
+ # @version SketchUp 6.0
889
+ def pick_helper(*args)
890
+ end
891
+
892
+ # The pickray method is used to retrieve a ray passing through a given screen
893
+ # position in the viewing direction.
894
+ #
895
+ # @example
896
+ # ray = view.pickray x, y
897
+ #
898
+ # @overload pickray(screen_point)
899
+ #
900
+ # @param [Array(Integer, Integer)] screen_point
901
+ # @return [Array(Geom::Point3d, Geom::Vector3d)] a ray
902
+ #
903
+ # @overload pickray(x, y)
904
+ #
905
+ # @param [Integer] x
906
+ # @param [Integer] y
907
+ # @return [Array(Geom::Point3d, Geom::Vector3d)] a ray
908
+ #
909
+ # @version SketchUp 6.0
910
+ def pickray(*args)
911
+ end
912
+
913
+ # The pixels_to_model method is used to compute a model size from a pixel size
914
+ # at a given point.
915
+ #
916
+ # This method is useful for deciding how big to draw something based on a
917
+ # desired size in pixels.
918
+ #
919
+ # @example
920
+ # size = view.pixels_to_model(pixels, point)
921
+ #
922
+ # @note As of SU2017 this will automatically scale the pixel-size by the same
923
+ # factor as {UI.scale_factor}.
924
+ #
925
+ # @param [Numeric] pixels
926
+ # The pixel size.
927
+ #
928
+ # @param [Geom::Point3d] point
929
+ # A Point3d object where the size will be calculated from.
930
+ #
931
+ # @return [Float] the model size
932
+ #
933
+ # @version SketchUp 6.0
934
+ def pixels_to_model(pixels, point)
935
+ end
936
+
937
+ # The refresh method is used to immediately force a redraw of the view.
938
+ #
939
+ # @example
940
+ # model = Sketchup.active_model
941
+ # view = model.active_view
942
+ # refreshed_view = view.refresh
943
+ #
944
+ # @note This method might impact performance and if used incorrectly cause
945
+ # instability or crashes. Don't use this unless you have verified that
946
+ # you cannot use {#invalidate} instead.
947
+ #
948
+ # @return [Sketchup::View] the refreshed View object
949
+ #
950
+ # @version SketchUp 7.1
951
+ def refresh
952
+ end
953
+
954
+ # Releases a texture loaded via {#load_texture}, freeing up it's memory.
955
+ # It's good practice to do so whenever there is no longer any need for the
956
+ # resource.
957
+ #
958
+ # For example, when your tool deactivates you probably want to release your
959
+ # resources as you don't know if your tool will be used again.
960
+ #
961
+ # @example
962
+ # module Example
963
+ # class MyTool
964
+ # def activate
965
+ # view = Sketchup.active_model.active_view
966
+ # image_rep = view.model.materials.current.texture.image_rep
967
+ # @texture_id = view.load_texture(image_rep)
968
+ # end
969
+ #
970
+ # def deactivate(view)
971
+ # view.release_texture(@texture_id)
972
+ # end
973
+ #
974
+ # def draw(view)
975
+ # points = [ [0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0] ]
976
+ # uvs = [ [0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0] ]
977
+ # view.draw(GL_QUADS, points, texture: @texture_id, uvs: uvs)
978
+ # end
979
+ # end
980
+ # end
981
+ # Sketchup.active_model.select_tool(Example::MyTool.new)
982
+ #
983
+ # @param [Integer] texture_id
984
+ #
985
+ # @return [Boolean] +true+ if texture was released. +false+ otherwise.
986
+ #
987
+ # @see #load_texture
988
+ def release_texture(texture_id)
989
+ end
990
+
991
+ # The remove_observer method is used to remove an observer from the current
992
+ # object.
993
+ #
994
+ # @example
995
+ # view = Sketchup.active_model.active_view
996
+ # status = view.remove_observer observer
997
+ #
998
+ # @param [Object] observer
999
+ # An observer.
1000
+ #
1001
+ # @return [Boolean] true if successful, false if unsuccessful.
1002
+ #
1003
+ # @version SketchUp 6.0
1004
+ def remove_observer(observer)
1005
+ end
1006
+
1007
+ # The screen_coords method is used to retrieve the screen coordinates of the
1008
+ # given point on the screen.
1009
+ #
1010
+ # The x and y values returned correspond to the x and y screen coordinates.
1011
+ # Ignore the z values. If the referenced point is not in the current
1012
+ # viewport, the x and/or y value may be negative.
1013
+ #
1014
+ # @example
1015
+ # point = view.screen_coords(ORIGIN)
1016
+ #
1017
+ # @param [Geom::Point3d] point3d
1018
+ # A Point3d object.
1019
+ #
1020
+ # @return [Geom::Point3d] A Point3d containing the screen position
1021
+ #
1022
+ # @version SketchUp 6.0
1023
+ def screen_coords(point3d)
1024
+ end
1025
+
1026
+ # Set the drawing color for the view based on the direction of a line that you
1027
+ # want to draw. These colors will match the axes colors in the SketchUp model
1028
+ # (typically blue for straight up and down, etc.)
1029
+ #
1030
+ # This method is usually invoked within the draw method of a tool.
1031
+ #
1032
+ # @example
1033
+ # view = view.set_color_from_line point1, point2
1034
+ #
1035
+ # @param [Geom::Point3d] point1
1036
+ # Point3d object representing first point in the line.
1037
+ #
1038
+ # @param [Geom::Point3d] point2
1039
+ # Point3d object representing the second point in the line.
1040
+ #
1041
+ # @return [Sketchup::View] a View object
1042
+ #
1043
+ # @version SketchUp 6.0
1044
+ def set_color_from_line(point1, point2)
1045
+ end
1046
+
1047
+ # The show_frame method is used to show a frame of an Animation object in the
1048
+ # current view.
1049
+ #
1050
+ # You can supply an optional delay in seconds to wait before showing the next
1051
+ # frame. This can be useful to control the speed at which the animation runs.
1052
+ #
1053
+ # @example
1054
+ # status = view.show_frame delay
1055
+ #
1056
+ # @param [Numeric] delay
1057
+ # An optional delay in seconds.
1058
+ #
1059
+ # @return [Sketchup::View]
1060
+ #
1061
+ # @version SketchUp 6.0
1062
+ def show_frame(delay)
1063
+ end
1064
+
1065
+ # This method is used to compute the bounds of the text when
1066
+ # using {#draw_text}. The bounds are not a tight fit around the top and bottom
1067
+ # as they include varying amount of line spacing depending on the font used.
1068
+ #
1069
+ # The {TextVerticalAlignCenter} option will align the text to the center of the
1070
+ # height of the first line, not the whole boundingbox of the text.
1071
+ #
1072
+ # <b>Example of different vertical alignment and text bounds:</b>
1073
+ #
1074
+ # rdoc-image:../images/view-draw-text-with-bounds.png
1075
+ #
1076
+ # @example
1077
+ # class ExampleTool
1078
+ # TEXT_OPTIONS = {
1079
+ # :font => "Arial",
1080
+ # :size => 20,
1081
+ # :bold => true,
1082
+ # :align => TextAlignRight,
1083
+ # :align => TextVerticalAlignBaseline
1084
+ # }
1085
+ #
1086
+ # # Since `draw` is called frequently it can be useful to pre-compute and
1087
+ # # cache values used by `draw`.
1088
+ # def activate
1089
+ # @text = "Hello SketchUp"
1090
+ # @position = Geom::Point3d.new(200, 200, 0)
1091
+ #
1092
+ # # Compute text bounds
1093
+ # view = Sketchup.active_model.active_view
1094
+ # bounds = view.text_bounds(@position, @text, TEXT_OPTIONS)
1095
+ #
1096
+ # # Compute polygon for the text bounds
1097
+ # x1, y1 = bounds.upper_left.to_a
1098
+ # x2, y2 = bounds.lower_right.to_a
1099
+ # @points = [
1100
+ # Geom::Point3d.new(x1, y1),
1101
+ # Geom::Point3d.new(x1, y2),
1102
+ # Geom::Point3d.new(x2, y2),
1103
+ # Geom::Point3d.new(x2, y1),
1104
+ # ]
1105
+ # end
1106
+ #
1107
+ # def draw(view)
1108
+ # # Draw text bounds
1109
+ # view.drawing_color = Sketchup::Color.new(255, 0, 0, 64)
1110
+ # view.draw2d(GL_QUADS, @points)
1111
+ #
1112
+ # # Draw text
1113
+ # view.draw_text(@position, @text, TEXT_OPTIONS)
1114
+ # end
1115
+ # end
1116
+ #
1117
+ # @note Under Windows the font name must be less than 32 characters - due to
1118
+ # system limitations.
1119
+ #
1120
+ # @option options [String] :font The name of the font to use. If it does not
1121
+ # exist on the system, a default font will be used instead.
1122
+ #
1123
+ # @option options [Integer] :size The size of the font in points
1124
+ #
1125
+ # @option options [Boolean] :bold Controls the Bold property of the font.
1126
+ #
1127
+ # @option options [Boolean] :italic Controls the Italic property of the font.
1128
+ #
1129
+ # @option options [Integer] :align The text alignment, one of the following
1130
+ # constants: {TextAlignLeft}, {TextAlignCenter} or {TextAlignRight}.
1131
+ #
1132
+ # @option options [Integer] :vertical_align The vertical text alignment
1133
+ # one of the following constants:
1134
+ # {TextVerticalAlignBoundsTop}, {TextVerticalAlignBaseline},
1135
+ # {TextVerticalAlignCapHeight} or {TextVerticalAlignCenter}.
1136
+ #
1137
+ # @param [Geom::Point3d] point
1138
+ # A Point3d object representing a 2D coordinate
1139
+ # in view space.
1140
+ #
1141
+ # @param [String] text
1142
+ # The text string to draw.
1143
+ #
1144
+ # @param [Hash] options
1145
+ # The text can be customized by providing a hash or
1146
+ # named arguments of options.
1147
+ #
1148
+ # @return [Geom::Bounds2d]
1149
+ #
1150
+ # @see #draw_text
1151
+ #
1152
+ # @version SketchUp 2020.0
1153
+ def text_bounds(point, text, options = {})
1154
+ end
1155
+
1156
+ # Set a tooltip to display in the view. This is useful for displaying tooltips
1157
+ # in a tool that you write in Ruby.
1158
+ #
1159
+ # @example
1160
+ # tooltip = view.tooltip = string
1161
+ #
1162
+ # @param [String] string
1163
+ # The string tooltip.
1164
+ #
1165
+ # @return [String] the new tooltip string
1166
+ #
1167
+ # @version SketchUp 6.0
1168
+ def tooltip=(string)
1169
+ end
1170
+
1171
+ # The vpheight method is used to retrieve the height of the viewport for the
1172
+ # view.
1173
+ #
1174
+ # @example
1175
+ # model = Sketchup.active_model
1176
+ # view = model.active_view
1177
+ # height = view.vpheight
1178
+ #
1179
+ # @return [Integer] the height of the viewport in physical pixels.
1180
+ #
1181
+ # @version SketchUp 6.0
1182
+ def vpheight
1183
+ end
1184
+
1185
+ # The vpwidth method is used to retrieve the width of the viewport for the
1186
+ # view.
1187
+ #
1188
+ # @example
1189
+ # width = view.vpwidth
1190
+ #
1191
+ # @return [Integer] the width of the viewport in physical pixels.
1192
+ #
1193
+ # @version SketchUp 6.0
1194
+ def vpwidth
1195
+ end
1196
+
1197
+ # The {#write_image} method is used to write the current view to an image file.
1198
+ #
1199
+ # Supported file types are `.png`, `.jpg`, `.jpeg`, `gif`, `.bmp`, `.tif`.
1200
+ # For other file formats available from the GUI in File > Export > 2D
1201
+ # Graphics, .e.g `.pdf`, use {Sketchup::Model#export}.
1202
+ #
1203
+ # compression = 1.0)
1204
+ # @note Prefer the overload with option hash instead of this variant. This
1205
+ # overload is not updated with new options.
1206
+ #
1207
+ # @example
1208
+ # filename = File.join(Sketchup.temp_dir, 'example.png')
1209
+ # antialias = false
1210
+ # compression = 0.9
1211
+ # model = Sketchup.active_model
1212
+ # view = model.active_view
1213
+ # view.write_image(filename, 640, 480, antialias, compression)
1214
+ #
1215
+ # @param [String] filename
1216
+ # The filename for the saved image
1217
+ # @param [Integer] width
1218
+ # Width in pixels, defaults to the current viewport width {#vpwidth}.
1219
+ # @param [Integer] height
1220
+ # Height in pixels, defaults to the current viewport height {#vpheight}.
1221
+ # @param [Boolean] antialias
1222
+ # @param [Float] compression
1223
+ # Compression factor for JPEG images, between +0.0+ and +1.0+.
1224
+ #
1225
+ # @overload write_image(filename, width = view.vpwidth, height = view.vpheight, antialias = false,
1226
+ #
1227
+ #
1228
+ # @overload write_image(options)
1229
+ #
1230
+ # @example
1231
+ # options = {
1232
+ # :filename => File.join(Sketchup.temp_dir, 'example.png'),
1233
+ # :width => 640,
1234
+ # :height => 480,
1235
+ # :antialias => false,
1236
+ # :compression => 0.9,
1237
+ # :transparent => true
1238
+ # }
1239
+ # model = Sketchup.active_model
1240
+ # view = model.active_view
1241
+ # view.write_image(options)
1242
+ #
1243
+ # @version SketchUp 7
1244
+ # @param [Hash] options
1245
+ # @option options [String] filename The filename for the saved image.
1246
+ # @option options [Integer] width (#vpwidth) Width in pixels (max +16000+).
1247
+ # @option options [Integer] height (#vpheight) Height in pixels (max +16000+).
1248
+ # @option options [Float] scale_factor (1.0) Scaling factor for
1249
+ # elements that are viewport dependent, such as text heights, arrow heads,
1250
+ # line widths, stipple patterns, etc. (Added in SketchUp 2019.2)
1251
+ # @option options [Boolean] antialias (false)
1252
+ # @option options [Float] compression (1.0) Compression factor for JPEG,
1253
+ # images between +0.0+ and +1.0+.
1254
+ # @option options [Boolean] transparent (false) Added in SketchUp 8.
1255
+ #
1256
+ # @overload write_image(options)
1257
+ #
1258
+ # It is possible to dump the framebuffer to file by setting +:source+ to
1259
+ # +:framebuffer+. When saving the framebuffer only the following options are
1260
+ # valid.
1261
+ #
1262
+ # @example
1263
+ # options = {
1264
+ # :filename => File.join(Sketchup.temp_dir, 'example.png'),
1265
+ # :source => :framebuffer,
1266
+ # :compression => 0.9,
1267
+ # }
1268
+ # model = Sketchup.active_model
1269
+ # view = model.active_view
1270
+ # view.write_image(options)
1271
+ #
1272
+ # @version SketchUp 7
1273
+ # @param [Hash] options
1274
+ # @option options [String] filename The filename for the saved image.
1275
+ # @option options [Boolean] source (:image) Set to +:framebuffer+ to dump the
1276
+ # current framebuffer.
1277
+ # @option options [Float] compression (1.0) Compression factor for JPEG,
1278
+ # images between +0.0+ and +1.0+.
1279
+ #
1280
+ # @return [Boolean]
1281
+ #
1282
+ # @version SketchUp 6.0
1283
+ def write_image(*args)
1284
+ end
1285
+
1286
+ # The zoom method is used to zoom in or out by some zoom factor.
1287
+ #
1288
+ # @example
1289
+ # view = view.zoom factor
1290
+ # view = view.zoom selection
1291
+ # view = view.zoom entity
1292
+ # view = view.zoom array_of_entities
1293
+ #
1294
+ # @param [Numeric, Sketchup::Selection, Sketchup::Entity, Array<Sketchup::Entity>] zoom_or_ents
1295
+ # A Float zoom factor from 1.0 or larger or an Array or
1296
+ # collection of entities to "zoom extents" around.
1297
+ #
1298
+ # @return [Sketchup::View] the zoomed View object
1299
+ #
1300
+ # @version SketchUp 6.0
1301
+ def zoom(zoom_or_ents)
1302
+ end
1303
+
1304
+ # The zoom_extents method is used to zoom to the extents about the entire
1305
+ # model, as if the user has selected the zoom extents command from the menu.
1306
+ #
1307
+ # @example
1308
+ # view = Sketchup.active_model.active_view
1309
+ # new_view = view.zoom_extents
1310
+ #
1311
+ # @return [Sketchup::View] the zoomed View object
1312
+ #
1313
+ # @version SketchUp 6.0
1314
+ def zoom_extents
1315
+ end
1316
+
1317
+ end