sketchup-api-stubs 0.6.1 → 0.7.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -0
  3. data/lib/sketchup-api-stubs.rb +1 -1
  4. data/lib/sketchup-api-stubs/sketchup.rb +145 -145
  5. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
  6. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  7. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  8. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -401
  10. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  11. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  13. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  14. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -523
  16. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
  17. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -569
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -455
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -359
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -123
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -86
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +371 -371
  31. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  32. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  33. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +220 -232
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -563
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  37. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  38. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  39. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +204 -216
  40. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  41. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  42. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -547
  43. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  44. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  45. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  48. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +140 -140
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -554
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1097
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -537
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -262
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1483
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -282
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -650
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -356
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -995
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
  134. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
  135. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
  136. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
  137. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  138. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
  139. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -303
  140. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  141. data/lib/sketchup-api-stubs/stubs/geom.rb +348 -233
  142. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  143. data/lib/sketchup-api-stubs/stubs/length.rb +278 -262
  144. data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
  145. data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
  146. data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
  147. data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
  148. data/lib/sketchup-api-stubs/stubs/ui.rb +667 -660
  149. metadata +2 -16
@@ -1,149 +1,149 @@
1
- # Copyright:: Copyright 2019 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # SketchUp's drawing axes consist of three colored lines (red, green, blue),
5
- # usually perpendicular to each other, displayed in the drawing area. The
6
- # exception is when the user open an instance with a non-orthogonal
7
- # transformation. The root model transformation is always orthogonal.
8
- #
9
- # The drawing axes are used by drawing tools to align the geometry it creates
10
- # as well as affecting the inference engine.
11
- #
12
- # The plane where the red and green axes lines lie is called the ground plane.
13
- # The term origin, is used to define the place where all of axes lines start or
14
- # originate.
15
- #
16
- # @version SketchUp 2016
17
- class Sketchup::Axes < Sketchup::Entity
18
-
19
- # Instance Methods
20
-
21
- # The axes method returns the vectors representing the directions of the axes.
22
- #
23
- # @example
24
- # xaxis, yaxis, zaxis = Sketchup.active_model.axes.axes
25
- #
26
- # @return Array - an array of three vectors.
27
- #
28
- # @version SketchUp 2016
29
- def axes
30
- end
31
-
32
- # The origin method returns the origin of the axes.
33
- #
34
- # @example
35
- # point = Sketchup.active_model.axes.origin
36
- #
37
- # @return Point3d - the origin for the axes.
38
- #
39
- # @version SketchUp 2016
40
- def origin
41
- end
42
-
43
- # The set method allows the axes to be manipulated. The axes must always be
44
- # orthogonal, otherwise an error is thrown.
45
- #
46
- # @example
47
- # xaxis = Geom::Vector3d.new(3, 5, 0)
48
- # yaxis = xaxis * Z_AXIS
49
- # Sketchup.active_model.axes.set([10,0,0], xaxis, yaxis, Z_AXIS)
50
- #
51
- # @param origin
52
- # Point3d - The origin to set.
53
- #
54
- # @param xaxis
55
- # Vector3d - The x axis to set.
56
- #
57
- # @param yaxis
58
- # Vector3d - The y axis to set.
59
- #
60
- # @param zaxis
61
- # Vector3d - The z axis to set.
62
- #
63
- # @return Axes - the axes object being set.
64
- #
65
- # @version SketchUp 2016
66
- def set(origin, xaxis, yaxis, zaxis)
67
- end
68
-
69
- # The sketch_plane method returns a plane representing the ground plane of the
70
- # axes.
71
- #
72
- # @example
73
- # plane = Sketchup.active_model.axes.sketch_plane
74
- #
75
- # @return Array - of 4 numbers that give the coefficients of a
76
- # plane equation.
77
- #
78
- # @version SketchUp 2016
79
- def sketch_plane
80
- end
81
-
82
- # The axes method returns the origin and vectors representing the axes.
83
- #
84
- # @example
85
- # point, xaxis, yaxis, zaxis = Sketchup.active_model.axes.to_a
86
- #
87
- # @return Array - an array of a point and three vectors.
88
- #
89
- # @version SketchUp 2016
90
- def to_a
91
- end
92
-
93
- # The transformation method returns the transformation of the axes. This is
94
- # useful when creating tools that respect the model's drawing axes.
95
- #
96
- # @example
97
- # # Point for a rectangle.
98
- # points = [
99
- # Geom::Point3d.new( 0, 0, 0),
100
- # Geom::Point3d.new(10, 0, 0),
101
- # Geom::Point3d.new(10, 20, 0),
102
- # Geom::Point3d.new( 0, 20, 0)
103
- # ]
104
- # # Transform the points so they are local to the model axes. Otherwise
105
- # # they would be local to the model origin.
106
- # tr = Sketchup.active_model.axes.transformation
107
- # points.each { |point| point.transform!(tr) }
108
- # Sketchup.active_model.active_entities.add_face(points)
109
- #
110
- # @return Transformation - the transformation for the axes.
111
- #
112
- # @version SketchUp 2016
113
- def transformation
114
- end
115
-
116
- # The xaxis method returns the x axis of the axes.
117
- #
118
- # @example
119
- # vector = Sketchup.active_model.axes.xaxis
120
- #
121
- # @return Vector3d - the x axis for the axes.
122
- #
123
- # @version SketchUp 2016
124
- def xaxis
125
- end
126
-
127
- # The yaxis method returns the y axis of the axes.
128
- #
129
- # @example
130
- # vector = Sketchup.active_model.axes.yaxis
131
- #
132
- # @return Vector3d - the y axis for the axes.
133
- #
134
- # @version SketchUp 2016
135
- def yaxis
136
- end
137
-
138
- # The zaxis method returns the z axis of the axes.
139
- #
140
- # @example
141
- # vector = Sketchup.active_model.axes.zaxis
142
- #
143
- # @return Vector3d - the z axis for the axes.
144
- #
145
- # @version SketchUp 2016
146
- def zaxis
147
- end
148
-
149
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # SketchUp's drawing axes consist of three colored lines (red, green, blue),
5
+ # usually perpendicular to each other, displayed in the drawing area. The
6
+ # exception is when the user open an instance with a non-orthogonal
7
+ # transformation. The root model transformation is always orthogonal.
8
+ #
9
+ # The drawing axes are used by drawing tools to align the geometry it creates
10
+ # as well as affecting the inference engine.
11
+ #
12
+ # The plane where the red and green axes lines lie is called the ground plane.
13
+ # The term origin, is used to define the place where all of axes lines start or
14
+ # originate.
15
+ #
16
+ # @version SketchUp 2016
17
+ class Sketchup::Axes < Sketchup::Entity
18
+
19
+ # Instance Methods
20
+
21
+ # The axes method returns the vectors representing the directions of the axes.
22
+ #
23
+ # @example
24
+ # xaxis, yaxis, zaxis = Sketchup.active_model.axes.axes
25
+ #
26
+ # @return Array - an array of three vectors.
27
+ #
28
+ # @version SketchUp 2016
29
+ def axes
30
+ end
31
+
32
+ # The origin method returns the origin of the axes.
33
+ #
34
+ # @example
35
+ # point = Sketchup.active_model.axes.origin
36
+ #
37
+ # @return Point3d - the origin for the axes.
38
+ #
39
+ # @version SketchUp 2016
40
+ def origin
41
+ end
42
+
43
+ # The set method allows the axes to be manipulated. The axes must always be
44
+ # orthogonal, otherwise an error is thrown.
45
+ #
46
+ # @example
47
+ # xaxis = Geom::Vector3d.new(3, 5, 0)
48
+ # yaxis = xaxis * Z_AXIS
49
+ # Sketchup.active_model.axes.set([10,0,0], xaxis, yaxis, Z_AXIS)
50
+ #
51
+ # @param origin
52
+ # Point3d - The origin to set.
53
+ #
54
+ # @param xaxis
55
+ # Vector3d - The x axis to set.
56
+ #
57
+ # @param yaxis
58
+ # Vector3d - The y axis to set.
59
+ #
60
+ # @param zaxis
61
+ # Vector3d - The z axis to set.
62
+ #
63
+ # @return Axes - the axes object being set.
64
+ #
65
+ # @version SketchUp 2016
66
+ def set(origin, xaxis, yaxis, zaxis)
67
+ end
68
+
69
+ # The sketch_plane method returns a plane representing the ground plane of the
70
+ # axes.
71
+ #
72
+ # @example
73
+ # plane = Sketchup.active_model.axes.sketch_plane
74
+ #
75
+ # @return Array - of 4 numbers that give the coefficients of a
76
+ # plane equation.
77
+ #
78
+ # @version SketchUp 2016
79
+ def sketch_plane
80
+ end
81
+
82
+ # The axes method returns the origin and vectors representing the axes.
83
+ #
84
+ # @example
85
+ # point, xaxis, yaxis, zaxis = Sketchup.active_model.axes.to_a
86
+ #
87
+ # @return Array - an array of a point and three vectors.
88
+ #
89
+ # @version SketchUp 2016
90
+ def to_a
91
+ end
92
+
93
+ # The transformation method returns the transformation of the axes. This is
94
+ # useful when creating tools that respect the model's drawing axes.
95
+ #
96
+ # @example
97
+ # # Point for a rectangle.
98
+ # points = [
99
+ # Geom::Point3d.new( 0, 0, 0),
100
+ # Geom::Point3d.new(10, 0, 0),
101
+ # Geom::Point3d.new(10, 20, 0),
102
+ # Geom::Point3d.new( 0, 20, 0)
103
+ # ]
104
+ # # Transform the points so they are local to the model axes. Otherwise
105
+ # # they would be local to the model origin.
106
+ # tr = Sketchup.active_model.axes.transformation
107
+ # points.each { |point| point.transform!(tr) }
108
+ # Sketchup.active_model.active_entities.add_face(points)
109
+ #
110
+ # @return Transformation - the transformation for the axes.
111
+ #
112
+ # @version SketchUp 2016
113
+ def transformation
114
+ end
115
+
116
+ # The xaxis method returns the x axis of the axes.
117
+ #
118
+ # @example
119
+ # vector = Sketchup.active_model.axes.xaxis
120
+ #
121
+ # @return Vector3d - the x axis for the axes.
122
+ #
123
+ # @version SketchUp 2016
124
+ def xaxis
125
+ end
126
+
127
+ # The yaxis method returns the y axis of the axes.
128
+ #
129
+ # @example
130
+ # vector = Sketchup.active_model.axes.yaxis
131
+ #
132
+ # @return Vector3d - the y axis for the axes.
133
+ #
134
+ # @version SketchUp 2016
135
+ def yaxis
136
+ end
137
+
138
+ # The zaxis method returns the z axis of the axes.
139
+ #
140
+ # @example
141
+ # vector = Sketchup.active_model.axes.zaxis
142
+ #
143
+ # @return Vector3d - the z axis for the axes.
144
+ #
145
+ # @version SketchUp 2016
146
+ def zaxis
147
+ end
148
+
149
+ end
@@ -1,328 +1,328 @@
1
- # Copyright:: Copyright 2019 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The Behavior class is used to control the "behavior" of components, which
5
- # roughly correlates to the series of options that you see in the
6
- # Components dialog under the "edit" tab, such as whether it casts shadows,
7
- # glues to walls, etc.
8
- #
9
- # A Behavior object is accessed from a ComponentDefinition object, not created
10
- # with a Behavior.new call.
11
- #
12
- # @example
13
- # # Grab the Behavior object from the first component definition.
14
- # model = Sketchup.active_model
15
- # definition = model.definitions[0]
16
- # behavior = definition.behavior
17
- #
18
- # @version SketchUp 6.0
19
- class Sketchup::Behavior < Sketchup::Entity
20
-
21
- # Instance Methods
22
-
23
- # The always_face_camera= method is used to set the always_face_camera
24
- # behavior for a component.
25
- #
26
- # If the always_face_camera behavior is true, a component will always try to
27
- # orient itself so that the Y axis of the component is facing the camera.
28
- #
29
- # @example
30
- # model = Sketchup.active_model
31
- # behavior = model.definitions[0].behavior
32
- # status = behavior.always_face_camera = false
33
- #
34
- # @param setting
35
- # Sets the always_face_camera behavior to true or false.
36
- #
37
- # @return status - the status of the always_face_camera behavior.
38
- #
39
- # @version SketchUp 6.0
40
- def always_face_camera=(setting)
41
- end
42
-
43
- # The always_face_camera? method is used to retrieve the always_face_camera
44
- # behavior for a component.
45
- #
46
- # If the always_face_camera behavior is true, then a component will always try
47
- # to orient itself so that the -Y axis of the component is facing the camera.
48
- #
49
- # @example
50
- # model = Sketchup.active_model
51
- # # Returns a DefinitionList
52
- # definitions = model.definitions
53
- # path = Sketchup.find_support_file "Bed.skp",
54
- # "Components/Components Sampler/"
55
- #
56
- # begin
57
- # definition = definitions.load path
58
- # rescue
59
- # UI.messagebox $!.message
60
- # end
61
- #
62
- # behavior = definition.behavior
63
- # b = behavior.always_face_camera?
64
- # if (b)
65
- # UI.messagebox b
66
- # else
67
- # UI.messagebox "Always Face Camera is equal to false"
68
- # end
69
- # status = behavior.always_face_camera = true
70
- # b = behavior.always_face_camera?
71
- # if (b)
72
- # UI.messagebox b
73
- # else
74
- # UI.messagebox "Failure"
75
- # end
76
- #
77
- # @return [Boolean] behavior - true if the component is set to always face
78
- # the camera, false if the component is not set to always
79
- # face camera.
80
- #
81
- # @version SketchUp 6.0
82
- def always_face_camera?
83
- end
84
-
85
- # The cuts_opening= method is used to set the cut opening behavior for a
86
- # component.
87
- #
88
- # @example
89
- # model = Sketchup.active_model
90
- # behavior = model.definitions[0].behavior
91
- # status = behavior.cuts_opening = false
92
- # if (status)
93
- # # if status is true, print the status
94
- # UI.messagebox status
95
- # else
96
- # # code to respond cuts_opening being false
97
- # end
98
- #
99
- # @param setting
100
- # Sets the cuts_opening behavior to true or false.
101
- #
102
- # @return status - the status of the cuts_opening behavior
103
- # (either true or false)
104
- #
105
- # @version SketchUp 6.0
106
- def cuts_opening=(setting)
107
- end
108
-
109
- # The cuts_opening? method is used to get the status of a component's cut
110
- # opening behavior.
111
- #
112
- # @example
113
- # model = Sketchup.active_model
114
- # behavior = model.definitions[0].behavior
115
- # status = behavior.cuts_opening?
116
- # if (status)
117
- # # if status is true, do something
118
- # else
119
- # # if status is false, do something else
120
- # end
121
- #
122
- # @return [Boolean] status - the status of the cuts_opening behavior
123
- # (either true or false)
124
- #
125
- # @version SketchUp 6.0
126
- def cuts_opening?
127
- end
128
-
129
- # The is2d= method is used to set the 2D behavior for a component: whether it
130
- # can be glued or aligned to a face.
131
- #
132
- # @example
133
- # model = Sketchup.active_model
134
- # behavior = model.definitions[0].behavior
135
- # status = behavior.is2d = false
136
- # if (status)
137
- # # if status is true, print the status
138
- # UI.messagebox status
139
- # else
140
- # # code to respond is2d behavior being false
141
- # end
142
- #
143
- # @param setting
144
- # Sets the 2D behavior to true or false.
145
- #
146
- # @return status - the new setting
147
- #
148
- # @version SketchUp 6.0
149
- def is2d=(setting)
150
- end
151
-
152
- # The is2d? method is used to get the 2D behavior for a component: whether it
153
- # can be glued or aligned to a face.
154
- #
155
- # @example
156
- # model = Sketchup.active_model
157
- # behavior = model.definitions[0].behavior
158
- # status = behavior.is2d?
159
- # if (status)
160
- # # if status is true, do something
161
- # else
162
- # # if status is false, do something else
163
- # end
164
- #
165
- # @return [Boolean] status - the status of the 2D behavior (either true or
166
- # false)
167
- #
168
- # @version SketchUp 6.0
169
- def is2d?
170
- end
171
-
172
- # Sets an integer that is really a bit-by-bit description of which scale
173
- # tool handles are hidden on a given component. This is useful for creating
174
- # definitions that can only be scaled in particular ways. If a bit contains a
175
- # a 1, then a certain handle set will be hidden when the user selects the
176
- # component and activates the Scale tool. Here is the map of which bits
177
- # control which handles.
178
- #
179
- # - Bit0: disable scale along red (X),
180
- # - Bit1: disable scale along green (Y),
181
- # - Bit2: disable scale along blue (Z),
182
- # - Bit3: disable scale in red/blue plane (X+Z),
183
- # - Bit4: disable scale in green/blue plane (Y+Z),
184
- # - Bit5: disable scale in red/green plane (X+Y),
185
- # - Bit6: disable scale uniform (from corners) (XYZ).
186
- #
187
- # Note that for 2-dimensional components (such as face-me components), not all
188
- # of the handles in the list above are even used. Also, if the component you
189
- # are modifying is already selected with the scale tool, then you or your user
190
- # must deactivate and reactivate the scale tool for your new behavior to take
191
- # effect.
192
- #
193
- # @example
194
- # # Disable the green and red-axes handles by setting bits 1 and 2 to 1.
195
- # definition = Sketchup.active_model.definitions[0]
196
- # behavior = definition.behavior
197
- # behavior.no_scale_mask = (1 << 1) + (1 << 2)
198
- #
199
- # @param scale_mask
200
- # An integer describing which scale tool
201
- # handles are hidden.
202
- #
203
- # @return behavior - the Behavior object
204
- #
205
- # @version SketchUp 7.0
206
- def no_scale_mask=(scale_mask)
207
- end
208
-
209
- # The no_scale_mask? method returns an integer that is a bit-by-bit
210
- # description of which scale tool handles are hidden when the user selects
211
- # this single component with the scale tool. See the no_scale_mask=
212
- # method for details on the bit encodings used.
213
- #
214
- # @example
215
- # definition = Sketchup.active_model.definitions[0]
216
- # behavior = definition.behavior
217
- # no_scale_mask = behavior.no_scale_mask?
218
- #
219
- # @return [Boolean] scale_mask - an integer describing which scale tool
220
- # handles are hidden.
221
- #
222
- # @version SketchUp 7.0
223
- def no_scale_mask?
224
- end
225
-
226
- # The shadows_face_sun= method is used to identify whether the component's
227
- # shadow will be cast from the component's current position as though the
228
- # component were facing the sun. See the Component entity within the SketchUp
229
- # User's guide for more information on this feature.
230
- #
231
- # @example
232
- # model = Sketchup.active_model
233
- # behavior = model.definitions[0].behavior
234
- # behavior = behavior.shadows_face_sun = true
235
- #
236
- # @param status
237
- # true if the component's is to be cast from the
238
- # component's current position as though the component
239
- # were facing the sun. False to cause the shadow to be
240
- # cast from the component's current position.
241
- #
242
- # @return behavior - the Behavior object
243
- #
244
- # @version SketchUp 6.0
245
- def shadows_face_sun=(status)
246
- end
247
-
248
- # The shadows_face_sun? method is used to determine whether the component's
249
- # shadow is being cast from the component's current position (as though the
250
- # component were facing the sun). See the Component entity within the SketchUp
251
- # User's guide for more information on this feature.
252
- #
253
- # @example
254
- # model = Sketchup.active_model
255
- # # Returns a DefinitionList
256
- # definitions = model.definitions
257
- # path = Sketchup.find_support_file "Bed.skp",
258
- # "Components/Components Sampler/"
259
- # begin
260
- # definition = definitions.load path
261
- # rescue
262
- # UI.messagebox $!.message
263
- # end
264
- #
265
- # @return [Boolean] status - true if the component's is to be cast from the
266
- # component's current position as though the component
267
- # were facing the sun. False to cause the shadow to be
268
- # cast from the component's current position.
269
- #
270
- # @version SketchUp 6.0
271
- def shadows_face_sun?
272
- end
273
-
274
- # The snapto method is used to verify the status of a component's "snap to"
275
- # behavior.
276
- #
277
- # Returns a constant indicating the snapping behavior of the component
278
- # described by behavior. Snapping behavior is how the x-y plane of a component
279
- # instance will be snapped against a face. Possible values are:
280
- #
281
- # - +SnapTo_Arbitrary+ => Snap to any aribrary face,
282
- # - +SnapTo_Horizontal+ => Snap to horizontal face like floors,
283
- # - +SnapTo_Vertical+ => Snap to vertical face like walls,
284
- # - +SnapTo_Sloped+ => Snap to sloped face like sloping roofs.
285
- #
286
- # @example
287
- # model = Sketchup.active_model
288
- # behavior = model.definitions[0].behavior
289
- # status = behavior.snapto
290
- # if (status)
291
- # # if status is true, do something
292
- # else
293
- # # if status is false, do something else
294
- # end
295
- #
296
- # @return status - the status of the snapto behavior (either true
297
- # or false)
298
- #
299
- # @version SketchUp 6.0
300
- def snapto
301
- end
302
-
303
- # The snapto= method sets a component's "snap to" behavior.
304
- #
305
- # Snapping behavior is how the x-y plane of a component instance will be
306
- # snapped against a face. Possible constant values are:
307
- #
308
- # - +SnapTo_Arbitrary+ => Snap to any aribrary face,
309
- # - +SnapTo_Horizontal+ => Snap to horizontal face like floors,
310
- # - +SnapTo_Vertical+ => Snap to vertical face like walls,
311
- # - +SnapTo_Sloped+ => Snap to sloped face like sloping roofs.
312
- #
313
- # @example
314
- # model = Sketchup.active_model
315
- # behavior = model.definitions[0].behavior
316
- # behavior.snapto = SnapTo_Horizontal
317
- #
318
- # @param snapto
319
- # A numeric constant identifying one of the snapto
320
- # types.
321
- #
322
- # @return behavior - the Behavior object
323
- #
324
- # @version SketchUp 6.0
325
- def snapto=(snapto)
326
- end
327
-
328
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The Behavior class is used to control the "behavior" of components, which
5
+ # roughly correlates to the series of options that you see in the
6
+ # Components dialog under the "edit" tab, such as whether it casts shadows,
7
+ # glues to walls, etc.
8
+ #
9
+ # A Behavior object is accessed from a ComponentDefinition object, not created
10
+ # with a Behavior.new call.
11
+ #
12
+ # @example
13
+ # # Grab the Behavior object from the first component definition.
14
+ # model = Sketchup.active_model
15
+ # definition = model.definitions[0]
16
+ # behavior = definition.behavior
17
+ #
18
+ # @version SketchUp 6.0
19
+ class Sketchup::Behavior < Sketchup::Entity
20
+
21
+ # Instance Methods
22
+
23
+ # The always_face_camera= method is used to set the always_face_camera
24
+ # behavior for a component.
25
+ #
26
+ # If the always_face_camera behavior is true, a component will always try to
27
+ # orient itself so that the Y axis of the component is facing the camera.
28
+ #
29
+ # @example
30
+ # model = Sketchup.active_model
31
+ # behavior = model.definitions[0].behavior
32
+ # status = behavior.always_face_camera = false
33
+ #
34
+ # @param setting
35
+ # Sets the always_face_camera behavior to true or false.
36
+ #
37
+ # @return status - the status of the always_face_camera behavior.
38
+ #
39
+ # @version SketchUp 6.0
40
+ def always_face_camera=(setting)
41
+ end
42
+
43
+ # The always_face_camera? method is used to retrieve the always_face_camera
44
+ # behavior for a component.
45
+ #
46
+ # If the always_face_camera behavior is true, then a component will always try
47
+ # to orient itself so that the -Y axis of the component is facing the camera.
48
+ #
49
+ # @example
50
+ # model = Sketchup.active_model
51
+ # # Returns a DefinitionList
52
+ # definitions = model.definitions
53
+ # path = Sketchup.find_support_file "Bed.skp",
54
+ # "Components/Components Sampler/"
55
+ #
56
+ # begin
57
+ # definition = definitions.load path
58
+ # rescue
59
+ # UI.messagebox $!.message
60
+ # end
61
+ #
62
+ # behavior = definition.behavior
63
+ # b = behavior.always_face_camera?
64
+ # if (b)
65
+ # UI.messagebox b
66
+ # else
67
+ # UI.messagebox "Always Face Camera is equal to false"
68
+ # end
69
+ # status = behavior.always_face_camera = true
70
+ # b = behavior.always_face_camera?
71
+ # if (b)
72
+ # UI.messagebox b
73
+ # else
74
+ # UI.messagebox "Failure"
75
+ # end
76
+ #
77
+ # @return [Boolean] behavior - true if the component is set to always face
78
+ # the camera, false if the component is not set to always
79
+ # face camera.
80
+ #
81
+ # @version SketchUp 6.0
82
+ def always_face_camera?
83
+ end
84
+
85
+ # The cuts_opening= method is used to set the cut opening behavior for a
86
+ # component.
87
+ #
88
+ # @example
89
+ # model = Sketchup.active_model
90
+ # behavior = model.definitions[0].behavior
91
+ # status = behavior.cuts_opening = false
92
+ # if (status)
93
+ # # if status is true, print the status
94
+ # UI.messagebox status
95
+ # else
96
+ # # code to respond cuts_opening being false
97
+ # end
98
+ #
99
+ # @param setting
100
+ # Sets the cuts_opening behavior to true or false.
101
+ #
102
+ # @return status - the status of the cuts_opening behavior
103
+ # (either true or false)
104
+ #
105
+ # @version SketchUp 6.0
106
+ def cuts_opening=(setting)
107
+ end
108
+
109
+ # The cuts_opening? method is used to get the status of a component's cut
110
+ # opening behavior.
111
+ #
112
+ # @example
113
+ # model = Sketchup.active_model
114
+ # behavior = model.definitions[0].behavior
115
+ # status = behavior.cuts_opening?
116
+ # if (status)
117
+ # # if status is true, do something
118
+ # else
119
+ # # if status is false, do something else
120
+ # end
121
+ #
122
+ # @return [Boolean] status - the status of the cuts_opening behavior
123
+ # (either true or false)
124
+ #
125
+ # @version SketchUp 6.0
126
+ def cuts_opening?
127
+ end
128
+
129
+ # The is2d= method is used to set the 2D behavior for a component: whether it
130
+ # can be glued or aligned to a face.
131
+ #
132
+ # @example
133
+ # model = Sketchup.active_model
134
+ # behavior = model.definitions[0].behavior
135
+ # status = behavior.is2d = false
136
+ # if (status)
137
+ # # if status is true, print the status
138
+ # UI.messagebox status
139
+ # else
140
+ # # code to respond is2d behavior being false
141
+ # end
142
+ #
143
+ # @param setting
144
+ # Sets the 2D behavior to true or false.
145
+ #
146
+ # @return status - the new setting
147
+ #
148
+ # @version SketchUp 6.0
149
+ def is2d=(setting)
150
+ end
151
+
152
+ # The is2d? method is used to get the 2D behavior for a component: whether it
153
+ # can be glued or aligned to a face.
154
+ #
155
+ # @example
156
+ # model = Sketchup.active_model
157
+ # behavior = model.definitions[0].behavior
158
+ # status = behavior.is2d?
159
+ # if (status)
160
+ # # if status is true, do something
161
+ # else
162
+ # # if status is false, do something else
163
+ # end
164
+ #
165
+ # @return [Boolean] status - the status of the 2D behavior (either true or
166
+ # false)
167
+ #
168
+ # @version SketchUp 6.0
169
+ def is2d?
170
+ end
171
+
172
+ # Sets an integer that is really a bit-by-bit description of which scale
173
+ # tool handles are hidden on a given component. This is useful for creating
174
+ # definitions that can only be scaled in particular ways. If a bit contains a
175
+ # a 1, then a certain handle set will be hidden when the user selects the
176
+ # component and activates the Scale tool. Here is the map of which bits
177
+ # control which handles.
178
+ #
179
+ # - Bit0: disable scale along red (X),
180
+ # - Bit1: disable scale along green (Y),
181
+ # - Bit2: disable scale along blue (Z),
182
+ # - Bit3: disable scale in red/blue plane (X+Z),
183
+ # - Bit4: disable scale in green/blue plane (Y+Z),
184
+ # - Bit5: disable scale in red/green plane (X+Y),
185
+ # - Bit6: disable scale uniform (from corners) (XYZ).
186
+ #
187
+ # Note that for 2-dimensional components (such as face-me components), not all
188
+ # of the handles in the list above are even used. Also, if the component you
189
+ # are modifying is already selected with the scale tool, then you or your user
190
+ # must deactivate and reactivate the scale tool for your new behavior to take
191
+ # effect.
192
+ #
193
+ # @example
194
+ # # Disable the green and red-axes handles by setting bits 1 and 2 to 1.
195
+ # definition = Sketchup.active_model.definitions[0]
196
+ # behavior = definition.behavior
197
+ # behavior.no_scale_mask = (1 << 1) + (1 << 2)
198
+ #
199
+ # @param scale_mask
200
+ # An integer describing which scale tool
201
+ # handles are hidden.
202
+ #
203
+ # @return behavior - the Behavior object
204
+ #
205
+ # @version SketchUp 7.0
206
+ def no_scale_mask=(scale_mask)
207
+ end
208
+
209
+ # The no_scale_mask? method returns an integer that is a bit-by-bit
210
+ # description of which scale tool handles are hidden when the user selects
211
+ # this single component with the scale tool. See the no_scale_mask=
212
+ # method for details on the bit encodings used.
213
+ #
214
+ # @example
215
+ # definition = Sketchup.active_model.definitions[0]
216
+ # behavior = definition.behavior
217
+ # no_scale_mask = behavior.no_scale_mask?
218
+ #
219
+ # @return [Boolean] scale_mask - an integer describing which scale tool
220
+ # handles are hidden.
221
+ #
222
+ # @version SketchUp 7.0
223
+ def no_scale_mask?
224
+ end
225
+
226
+ # The shadows_face_sun= method is used to identify whether the component's
227
+ # shadow will be cast from the component's current position as though the
228
+ # component were facing the sun. See the Component entity within the SketchUp
229
+ # User's guide for more information on this feature.
230
+ #
231
+ # @example
232
+ # model = Sketchup.active_model
233
+ # behavior = model.definitions[0].behavior
234
+ # behavior = behavior.shadows_face_sun = true
235
+ #
236
+ # @param status
237
+ # true if the component's is to be cast from the
238
+ # component's current position as though the component
239
+ # were facing the sun. False to cause the shadow to be
240
+ # cast from the component's current position.
241
+ #
242
+ # @return behavior - the Behavior object
243
+ #
244
+ # @version SketchUp 6.0
245
+ def shadows_face_sun=(status)
246
+ end
247
+
248
+ # The shadows_face_sun? method is used to determine whether the component's
249
+ # shadow is being cast from the component's current position (as though the
250
+ # component were facing the sun). See the Component entity within the SketchUp
251
+ # User's guide for more information on this feature.
252
+ #
253
+ # @example
254
+ # model = Sketchup.active_model
255
+ # # Returns a DefinitionList
256
+ # definitions = model.definitions
257
+ # path = Sketchup.find_support_file "Bed.skp",
258
+ # "Components/Components Sampler/"
259
+ # begin
260
+ # definition = definitions.load path
261
+ # rescue
262
+ # UI.messagebox $!.message
263
+ # end
264
+ #
265
+ # @return [Boolean] status - true if the component's is to be cast from the
266
+ # component's current position as though the component
267
+ # were facing the sun. False to cause the shadow to be
268
+ # cast from the component's current position.
269
+ #
270
+ # @version SketchUp 6.0
271
+ def shadows_face_sun?
272
+ end
273
+
274
+ # The snapto method is used to verify the status of a component's "snap to"
275
+ # behavior.
276
+ #
277
+ # Returns a constant indicating the snapping behavior of the component
278
+ # described by behavior. Snapping behavior is how the x-y plane of a component
279
+ # instance will be snapped against a face. Possible values are:
280
+ #
281
+ # - +SnapTo_Arbitrary+ => Snap to any aribrary face,
282
+ # - +SnapTo_Horizontal+ => Snap to horizontal face like floors,
283
+ # - +SnapTo_Vertical+ => Snap to vertical face like walls,
284
+ # - +SnapTo_Sloped+ => Snap to sloped face like sloping roofs.
285
+ #
286
+ # @example
287
+ # model = Sketchup.active_model
288
+ # behavior = model.definitions[0].behavior
289
+ # status = behavior.snapto
290
+ # if (status)
291
+ # # if status is true, do something
292
+ # else
293
+ # # if status is false, do something else
294
+ # end
295
+ #
296
+ # @return status - the status of the snapto behavior (either true
297
+ # or false)
298
+ #
299
+ # @version SketchUp 6.0
300
+ def snapto
301
+ end
302
+
303
+ # The snapto= method sets a component's "snap to" behavior.
304
+ #
305
+ # Snapping behavior is how the x-y plane of a component instance will be
306
+ # snapped against a face. Possible constant values are:
307
+ #
308
+ # - +SnapTo_Arbitrary+ => Snap to any aribrary face,
309
+ # - +SnapTo_Horizontal+ => Snap to horizontal face like floors,
310
+ # - +SnapTo_Vertical+ => Snap to vertical face like walls,
311
+ # - +SnapTo_Sloped+ => Snap to sloped face like sloping roofs.
312
+ #
313
+ # @example
314
+ # model = Sketchup.active_model
315
+ # behavior = model.definitions[0].behavior
316
+ # behavior.snapto = SnapTo_Horizontal
317
+ #
318
+ # @param snapto
319
+ # A numeric constant identifying one of the snapto
320
+ # types.
321
+ #
322
+ # @return behavior - the Behavior object
323
+ #
324
+ # @version SketchUp 6.0
325
+ def snapto=(snapto)
326
+ end
327
+
328
+ end