sketchup-api-stubs 0.7.3 → 0.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.yardopts +9 -9
- data/lib/sketchup-api-stubs.rb +1 -1
- data/lib/sketchup-api-stubs/sketchup.rb +145 -145
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -514
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +371 -371
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +220 -232
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +204 -216
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -694
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +140 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -562
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -280
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1601
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -770
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
- data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
- data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
- data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
- data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/ui.rb +667 -667
- metadata +3 -4
@@ -1,508 +1,508 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Edge class contains methods modifying and extracting information for
|
5
|
-
# edges.
|
6
|
-
#
|
7
|
-
# @version SketchUp 6.0
|
8
|
-
class Sketchup::Edge < Sketchup::Drawingelement
|
9
|
-
|
10
|
-
# Instance Methods
|
11
|
-
|
12
|
-
# The all_connected method retrieves all of the entities connected to an edge,
|
13
|
-
# including the edge itself.
|
14
|
-
#
|
15
|
-
# @example
|
16
|
-
# depth = 100
|
17
|
-
# width = 100
|
18
|
-
# model = Sketchup.active_model
|
19
|
-
# entities = model.active_entities
|
20
|
-
# pts = []
|
21
|
-
# pts[0] = [0, 0, 0]
|
22
|
-
# pts[1] = [width, 0, 0]
|
23
|
-
# pts[2] = [width, depth, 0]
|
24
|
-
# pts[3] = [0, depth, 0]
|
25
|
-
# # Add the face to the entities in the model
|
26
|
-
# face = entities.add_face pts
|
27
|
-
# # I just happen to know that the second and third entities in the
|
28
|
-
# # entities objects are edges.
|
29
|
-
# entity1 = entities[1]
|
30
|
-
# entity2 = entities[2]
|
31
|
-
# edges = entity1.all_connected
|
32
|
-
# if (edges)
|
33
|
-
# UI.messagebox edges.to_s
|
34
|
-
# else
|
35
|
-
# UI.messagebox "Failure"
|
36
|
-
# end
|
37
|
-
#
|
38
|
-
# @return [Array<Sketchup::Entity>] the edge and entities connected to that edge
|
39
|
-
#
|
40
|
-
# @version SketchUp 6.0
|
41
|
-
def all_connected
|
42
|
-
end
|
43
|
-
|
44
|
-
# The common_face method is used to identify a face that is common to two
|
45
|
-
# edges.
|
46
|
-
#
|
47
|
-
# @example
|
48
|
-
# depth = 100
|
49
|
-
# width = 100
|
50
|
-
# model = Sketchup.active_model
|
51
|
-
# entities = model.active_entities
|
52
|
-
# pts = []
|
53
|
-
# pts[0] = [0,0,0]
|
54
|
-
# pts[1] = [width,0,0]
|
55
|
-
# pts[2] = [width,depth,0]
|
56
|
-
# pts[3] = [0,depth,0]
|
57
|
-
# # Add the face to the entities in the model
|
58
|
-
# face = entities.add_face pts
|
59
|
-
# # I know that the second and third entity objects are edges
|
60
|
-
# entity1 = entities[1]
|
61
|
-
# entity2 = entities[2]
|
62
|
-
# UI.messagebox entity1
|
63
|
-
# UI.messagebox entity2
|
64
|
-
# face = entity1.common_face entity2
|
65
|
-
# if (face)
|
66
|
-
# UI.messagebox face
|
67
|
-
# else
|
68
|
-
# UI.messagebox "Failure: No Common Face"
|
69
|
-
# end
|
70
|
-
#
|
71
|
-
# @param [Sketchup::Edge] edge2
|
72
|
-
# The face whose edge you are checking for commonality.
|
73
|
-
#
|
74
|
-
# @return [Sketchup::Face, nil] the Face object that is common to the two edges
|
75
|
-
# if successful
|
76
|
-
#
|
77
|
-
# @version SketchUp 6.0
|
78
|
-
def common_face(edge2)
|
79
|
-
end
|
80
|
-
|
81
|
-
# The curve method is used to get the Curve object that this edge belongs
|
82
|
-
# to, if any. Note that if the edge is part of an arc instead of a random
|
83
|
-
# curve, then this method will return an ArcCurve object.
|
84
|
-
#
|
85
|
-
# @example
|
86
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
87
|
-
# curve = edge.curve
|
88
|
-
# if (curve)
|
89
|
-
# # If it is a curve, display a pointer to the curve
|
90
|
-
# UI.messagebox curve
|
91
|
-
# else
|
92
|
-
# UI.messagebox "Failure: Not a Curve"
|
93
|
-
# end
|
94
|
-
#
|
95
|
-
# @return [Sketchup::Curve, nil] returns a Curve object if it is a
|
96
|
-
# curve, nil if it is not a curve
|
97
|
-
#
|
98
|
-
# @version SketchUp 6.0
|
99
|
-
def curve
|
100
|
-
end
|
101
|
-
|
102
|
-
# The end method is used to retrieve the Vertex object at the end of the edge.
|
103
|
-
#
|
104
|
-
# @example
|
105
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
106
|
-
# vertex = edge.end
|
107
|
-
# if (vertex)
|
108
|
-
# # display a pointer to the Vertex
|
109
|
-
# UI.messagebox vertex
|
110
|
-
# else
|
111
|
-
# UI.messagebox "Failure"
|
112
|
-
# end
|
113
|
-
# point = vertex.position
|
114
|
-
# # Let's get the Point3d of the vertex
|
115
|
-
# if (point)
|
116
|
-
# UI.messagebox point
|
117
|
-
# else
|
118
|
-
# UI.messagebox "Failure"
|
119
|
-
# end
|
120
|
-
#
|
121
|
-
# @return [Sketchup::Vertex] a Vertex object if successful
|
122
|
-
#
|
123
|
-
# @version SketchUp 6.0
|
124
|
-
def end
|
125
|
-
end
|
126
|
-
|
127
|
-
# The explode_curve method is used to explode an edge as though it were an
|
128
|
-
# ArcCurve.
|
129
|
-
#
|
130
|
-
# @example
|
131
|
-
# depth = 100
|
132
|
-
# width = 100
|
133
|
-
# model = Sketchup.active_model
|
134
|
-
# entities = model.active_entities
|
135
|
-
# pts = []
|
136
|
-
# pts[0] = [0, 0, 0]
|
137
|
-
# pts[1] = [width, 0, 0]
|
138
|
-
# pts[2] = [width, depth, 0]
|
139
|
-
# pts[3] = [0, depth, 0]
|
140
|
-
# # Add the face to the entities in the model
|
141
|
-
# face = entities.add_face pts
|
142
|
-
# # I just happen to know that the second entity in the
|
143
|
-
# # entities objects is an edge.
|
144
|
-
# entity1 = entities[1]
|
145
|
-
# curve = entity1.explode_curve
|
146
|
-
# if (curve)
|
147
|
-
# UI.messagebox curve
|
148
|
-
# else
|
149
|
-
# UI.messagebox "Failure"
|
150
|
-
# end
|
151
|
-
#
|
152
|
-
# @return [Sketchup::Edge] an exploded edge object if successful
|
153
|
-
#
|
154
|
-
# @version SketchUp 6.0
|
155
|
-
def explode_curve
|
156
|
-
end
|
157
|
-
|
158
|
-
# The faces method is used to retrieve all of the faces common to the edge.
|
159
|
-
#
|
160
|
-
# @example
|
161
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
162
|
-
# faces = edge.faces
|
163
|
-
# if (faces)
|
164
|
-
# # Display the pointer to the first face returned in the array
|
165
|
-
# UI.messagebox faces[0]
|
166
|
-
# else
|
167
|
-
# UI.messagebox "Failure: No Faces Found"
|
168
|
-
# end
|
169
|
-
#
|
170
|
-
# @return [Array<Sketchup::Face>] an array of Face objects if successful, false
|
171
|
-
# if unsuccessful
|
172
|
-
#
|
173
|
-
# @version SketchUp 6.0
|
174
|
-
def faces
|
175
|
-
end
|
176
|
-
|
177
|
-
# The find_faces method is used to create all of the Faces that can be created
|
178
|
-
# with this edge. For example, if you use the API to draw three edges that form
|
179
|
-
# a triangle, the face between them will not show up because you've only drawn
|
180
|
-
# the edges, but if you call find_faces on one of the edges, the triangle will
|
181
|
-
# be filled in.
|
182
|
-
#
|
183
|
-
# @example
|
184
|
-
# depth = 100
|
185
|
-
# width = 100
|
186
|
-
# model = Sketchup.active_model
|
187
|
-
# entities = model.active_entities
|
188
|
-
# pts = []
|
189
|
-
# pts[0] = [0, 0, 0]
|
190
|
-
# pts[1] = [width, 0, 0]
|
191
|
-
# pts[2] = [width, depth, 0]
|
192
|
-
# pts[3] = [0, depth, 0]
|
193
|
-
# # Add the face to the entities in the model
|
194
|
-
# face = entities.add_face pts
|
195
|
-
# # I just happen to know that the second entity in the
|
196
|
-
# # entities objects is an edge.
|
197
|
-
# entity1 = entities[1]
|
198
|
-
# # Getting zero.
|
199
|
-
# number = entity1.find_faces
|
200
|
-
# if (number)
|
201
|
-
# UI.messagebox "I created " + number.to_s + " faces."
|
202
|
-
# else
|
203
|
-
# UI.messagebox "Failure"
|
204
|
-
# end
|
205
|
-
#
|
206
|
-
# @return [Integer] the number of faces found
|
207
|
-
#
|
208
|
-
# @version SketchUp 6.0
|
209
|
-
def find_faces
|
210
|
-
end
|
211
|
-
|
212
|
-
# The {#length} method is used to retrieve the length of an edge in current
|
213
|
-
# units.
|
214
|
-
#
|
215
|
-
# You can pass in an optional {Geom::Transformation} (or an array that can
|
216
|
-
# represent a transformation), to correct for a parent group's transformation.
|
217
|
-
# For example, if an edge is inside of a group that is scaled to 200%, the
|
218
|
-
# length method will return the unscaled length of the edge. So by passing a
|
219
|
-
# 200% transformation object to this method, you can account for that to get
|
220
|
-
# the "visual" length of the edge.
|
221
|
-
#
|
222
|
-
# @example
|
223
|
-
# edge = Sketchup.active_model.entities.add_line([0, 0, 0], [100, 100, 0])
|
224
|
-
# puts "#{edge.length} (#{edge.length.inspect})"
|
225
|
-
#
|
226
|
-
# @overload length
|
227
|
-
#
|
228
|
-
# @return [Length] the length of the edge
|
229
|
-
#
|
230
|
-
# @overload length(transform)
|
231
|
-
#
|
232
|
-
# @param transform [Geom::Transformation] A Transformation object or array
|
233
|
-
# that can be interpreted as a Transformation object.
|
234
|
-
# @return [Length] the length of the edge
|
235
|
-
#
|
236
|
-
# @version SketchUp 6.0
|
237
|
-
def length(*args)
|
238
|
-
end
|
239
|
-
|
240
|
-
# The line method is used to retrieve the line defined by the edge. Lines in
|
241
|
-
# SketchUp aren't visible entities but geometric constructs represented by
|
242
|
-
# an Array with a Point3d and a Vector3d. See the Geom module and the Array
|
243
|
-
# class for more information on lines.
|
244
|
-
#
|
245
|
-
# @example
|
246
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
247
|
-
# # Returns a 3D ray
|
248
|
-
# line = edge.line
|
249
|
-
# if (line)
|
250
|
-
# UI.messagebox line
|
251
|
-
# else
|
252
|
-
# UI.messagebox "Failure"
|
253
|
-
# end
|
254
|
-
#
|
255
|
-
# @return [Array(Geom::Point3d, Geom::Vector3d)] an array with a Point3d object
|
256
|
-
# and a Vector3d object.
|
257
|
-
#
|
258
|
-
# @version SketchUp 6.0
|
259
|
-
def line
|
260
|
-
end
|
261
|
-
|
262
|
-
# The other_vertex method is used to find the opposite vertex given one vertex
|
263
|
-
# of the edge.
|
264
|
-
#
|
265
|
-
# @example
|
266
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
267
|
-
# # Get the end vertex of an edge
|
268
|
-
# vertex = edge.end
|
269
|
-
# # Should find the starting vertex
|
270
|
-
# othervertex = edge.other_vertex vertex
|
271
|
-
# if (othervertex)
|
272
|
-
# UI.messagebox othervertex
|
273
|
-
# else
|
274
|
-
# UI.messagebox "Failure"
|
275
|
-
# end
|
276
|
-
# # The Point3d for the vertex
|
277
|
-
# point = othervertex.position
|
278
|
-
# if (point)
|
279
|
-
# UI.messagebox point
|
280
|
-
# else
|
281
|
-
# UI.messagebox "Failure"
|
282
|
-
# end
|
283
|
-
#
|
284
|
-
# @param [Sketchup::Vertex] vertex1
|
285
|
-
# One of the Vertex objects associated with the edge.
|
286
|
-
#
|
287
|
-
# @return [Sketchup::Vertex] the other Vertex object associated with the edge
|
288
|
-
#
|
289
|
-
# @version SketchUp 6.0
|
290
|
-
def other_vertex(vertex1)
|
291
|
-
end
|
292
|
-
|
293
|
-
# The {#reversed_in?} method is used to determine if the edge is reversed in
|
294
|
-
# a face's bounding loop.
|
295
|
-
#
|
296
|
-
# @example
|
297
|
-
# model = Sketchup.active_model
|
298
|
-
# entities = model.active_entities
|
299
|
-
# points = []
|
300
|
-
# points[0] = [0, 0, 0]
|
301
|
-
# points[1] = [9, 0, 0]
|
302
|
-
# points[2] = [9, 9, 0]
|
303
|
-
# points[3] = [0, 9, 0]
|
304
|
-
# # Add the face to the entities in the model
|
305
|
-
# face = entities.add_face(points)
|
306
|
-
# edge = face.edges[0]
|
307
|
-
# if edge.reversed_in?(face)
|
308
|
-
# face.reverse!
|
309
|
-
# end
|
310
|
-
#
|
311
|
-
# @param [Sketchup::Face] face
|
312
|
-
# The face that is bounded by the edge.
|
313
|
-
#
|
314
|
-
# @return [Boolean] +true+ if the edge is reversed, +false+ if it is not
|
315
|
-
# reversed. +nil+ if the edge and face is not connected.
|
316
|
-
#
|
317
|
-
# @see Sketchup::EdgeUse
|
318
|
-
#
|
319
|
-
# @see Sketchup::Loop
|
320
|
-
#
|
321
|
-
# @version SketchUp 6.0
|
322
|
-
def reversed_in?(face)
|
323
|
-
end
|
324
|
-
|
325
|
-
# The {#smooth=} method is used to set the edge to be smooth.
|
326
|
-
#
|
327
|
-
# A smooth edge will cause the shading between connected faces to blend to a
|
328
|
-
# smooth transition. The edge will still be visible.
|
329
|
-
#
|
330
|
-
# @example
|
331
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
332
|
-
# # Soft and Smooth are normally set in pairs.
|
333
|
-
# edge.soft = true
|
334
|
-
# edge.smooth = true
|
335
|
-
#
|
336
|
-
# @note The soft and smooth properties are normally set in pairs. You can
|
337
|
-
# observer this when the Soften/Smooth Edges feature or holding down Ctrl
|
338
|
-
# when using the Eraser Tool.
|
339
|
-
#
|
340
|
-
# @param [Boolean] value
|
341
|
-
#
|
342
|
-
# @return [Boolean]
|
343
|
-
#
|
344
|
-
# @see https://help.sketchup.com/en/article/3000097
|
345
|
-
#
|
346
|
-
# @version SketchUp 6.0
|
347
|
-
def smooth=(value)
|
348
|
-
end
|
349
|
-
|
350
|
-
# The {#smooth?} method is used to retrieve the current smooth setting for an
|
351
|
-
# edge.
|
352
|
-
#
|
353
|
-
# A smooth edge will cause the shading between connected faces to blend to a
|
354
|
-
# smooth transition. The edge will still be visible.
|
355
|
-
#
|
356
|
-
# @example
|
357
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
358
|
-
# # Soft and Smooth are normally set in pairs.
|
359
|
-
# edge.smooth = !edge.smooth?
|
360
|
-
# edge.soft = edge.smooth?
|
361
|
-
#
|
362
|
-
# @return [Boolean]
|
363
|
-
#
|
364
|
-
# @see https://help.sketchup.com/en/article/3000097
|
365
|
-
#
|
366
|
-
# @version SketchUp 6.0
|
367
|
-
def smooth?
|
368
|
-
end
|
369
|
-
|
370
|
-
# The {#soft=} method is used to set the edge to be soft.
|
371
|
-
#
|
372
|
-
# A soft edge will cause the connected faces to be treated as a surface. This
|
373
|
-
# means that if you have Hidden Geometry off and select one face it will also
|
374
|
-
# select all faces connected with soft edges. A soft edge will also appear
|
375
|
-
# hidden.
|
376
|
-
#
|
377
|
-
# @example
|
378
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
379
|
-
# # Soft and Smooth are normally set in pairs.
|
380
|
-
# edge.soft = true
|
381
|
-
# edge.smooth = true
|
382
|
-
#
|
383
|
-
# @note The soft and smooth properties are normally set in pairs. You can
|
384
|
-
# observer this when the Soften/Smooth Edges feature or holding down Ctrl
|
385
|
-
# when using the Eraser Tool.
|
386
|
-
#
|
387
|
-
# @param [Boolean] value
|
388
|
-
#
|
389
|
-
# @return [Boolean]
|
390
|
-
#
|
391
|
-
# @see https://help.sketchup.com/en/article/3000097
|
392
|
-
#
|
393
|
-
# @version SketchUp 6.0
|
394
|
-
def soft=(value)
|
395
|
-
end
|
396
|
-
|
397
|
-
# The {#soft?} method is used to retrieve the current smooth setting for an
|
398
|
-
# edge.
|
399
|
-
#
|
400
|
-
# A soft edge will cause the connected faces to be treated as a surface. This
|
401
|
-
# means that if you have Hidden Geometry off and select one face it will also
|
402
|
-
# select all faces connected with soft edges. A soft edge will also appear
|
403
|
-
# hidden.
|
404
|
-
#
|
405
|
-
# @example
|
406
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
407
|
-
# # Soft and Smooth are normally set in pairs.
|
408
|
-
# edge.soft = !edge.soft?
|
409
|
-
# edge.smooth = edge.soft?
|
410
|
-
#
|
411
|
-
# @return [Boolean]
|
412
|
-
#
|
413
|
-
# @see https://help.sketchup.com/en/article/3000097
|
414
|
-
#
|
415
|
-
# @version SketchUp 6.0
|
416
|
-
def soft?
|
417
|
-
end
|
418
|
-
|
419
|
-
# The split method is used to to split an edge into to or more distinct
|
420
|
-
# edges. If a Point3d is given, it must be a point that is on the Edge.
|
421
|
-
#
|
422
|
-
# If a Float is given, it is a number between 0 and 1 that gives the
|
423
|
-
# relative position along the edge at which to split it. For example,
|
424
|
-
# edge.split(0.5) will split the Edge at its midpoint. This split position
|
425
|
-
# is measured from the Edge.start.
|
426
|
-
#
|
427
|
-
# Returns the new Edge that was created as a result of splitting this one.
|
428
|
-
#
|
429
|
-
# @example
|
430
|
-
# # Split a line in half.
|
431
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
432
|
-
# new_edge = edge.split 0.5
|
433
|
-
#
|
434
|
-
# @param [Geom::Point3d] position
|
435
|
-
# A Point3d object whose location is along the edge, or
|
436
|
-
# a Float between 0.0 and 1.0 defining how far along the
|
437
|
-
# edge to split.
|
438
|
-
#
|
439
|
-
# @return [Sketchup::Edge] the new Edge object that was split off
|
440
|
-
# the old one if successful
|
441
|
-
#
|
442
|
-
# @version SketchUp 6.0
|
443
|
-
def split(position)
|
444
|
-
end
|
445
|
-
|
446
|
-
# The end method is used to retrieve the Vertex object at the start of the
|
447
|
-
# edge.
|
448
|
-
#
|
449
|
-
# @example
|
450
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
451
|
-
# vertex = edge.start
|
452
|
-
# if (vertex)
|
453
|
-
# # display a pointer to the Vertex
|
454
|
-
# UI.messagebox vertex
|
455
|
-
# else
|
456
|
-
# UI.messagebox "Failure"
|
457
|
-
# end
|
458
|
-
# point = vertex.position
|
459
|
-
# # Let's get the Point3d of the vertex
|
460
|
-
# if (point)
|
461
|
-
# UI.messagebox point
|
462
|
-
# else
|
463
|
-
# UI.messagebox "Failure"
|
464
|
-
# end
|
465
|
-
#
|
466
|
-
# @return [Sketchup::Vertex] a Vertex object if successful
|
467
|
-
#
|
468
|
-
# @version SketchUp 6.0
|
469
|
-
def start
|
470
|
-
end
|
471
|
-
|
472
|
-
# The used_by? method is used to see if an edge is used by a given Face or
|
473
|
-
# Vertex.
|
474
|
-
#
|
475
|
-
# @example
|
476
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
477
|
-
# # Returns a vertex
|
478
|
-
# vertex = edge.start
|
479
|
-
# # Check to see if the edge is used by the Vertex.
|
480
|
-
# status = edge.used_by? vertex
|
481
|
-
# if (status)
|
482
|
-
# UI.messagebox status
|
483
|
-
# else
|
484
|
-
# UI.messagebox "Failure"
|
485
|
-
# end
|
486
|
-
#
|
487
|
-
# @param [Sketchup::Vertex, Sketchup::Face] element
|
488
|
-
# A Vertex or Face object.
|
489
|
-
#
|
490
|
-
# @return [Boolean]
|
491
|
-
#
|
492
|
-
# @version SketchUp 6.0
|
493
|
-
def used_by?(element)
|
494
|
-
end
|
495
|
-
|
496
|
-
# The vertices method is used to retrieve the vertices on the edge.
|
497
|
-
#
|
498
|
-
# @example
|
499
|
-
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
500
|
-
# vertices = edge.vertices
|
501
|
-
#
|
502
|
-
# @return [Array<Sketchup::Vertex>] an array of Vertex objects
|
503
|
-
#
|
504
|
-
# @version SketchUp 6.0
|
505
|
-
def vertices
|
506
|
-
end
|
507
|
-
|
508
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Edge class contains methods modifying and extracting information for
|
5
|
+
# edges.
|
6
|
+
#
|
7
|
+
# @version SketchUp 6.0
|
8
|
+
class Sketchup::Edge < Sketchup::Drawingelement
|
9
|
+
|
10
|
+
# Instance Methods
|
11
|
+
|
12
|
+
# The all_connected method retrieves all of the entities connected to an edge,
|
13
|
+
# including the edge itself.
|
14
|
+
#
|
15
|
+
# @example
|
16
|
+
# depth = 100
|
17
|
+
# width = 100
|
18
|
+
# model = Sketchup.active_model
|
19
|
+
# entities = model.active_entities
|
20
|
+
# pts = []
|
21
|
+
# pts[0] = [0, 0, 0]
|
22
|
+
# pts[1] = [width, 0, 0]
|
23
|
+
# pts[2] = [width, depth, 0]
|
24
|
+
# pts[3] = [0, depth, 0]
|
25
|
+
# # Add the face to the entities in the model
|
26
|
+
# face = entities.add_face pts
|
27
|
+
# # I just happen to know that the second and third entities in the
|
28
|
+
# # entities objects are edges.
|
29
|
+
# entity1 = entities[1]
|
30
|
+
# entity2 = entities[2]
|
31
|
+
# edges = entity1.all_connected
|
32
|
+
# if (edges)
|
33
|
+
# UI.messagebox edges.to_s
|
34
|
+
# else
|
35
|
+
# UI.messagebox "Failure"
|
36
|
+
# end
|
37
|
+
#
|
38
|
+
# @return [Array<Sketchup::Entity>] the edge and entities connected to that edge
|
39
|
+
#
|
40
|
+
# @version SketchUp 6.0
|
41
|
+
def all_connected
|
42
|
+
end
|
43
|
+
|
44
|
+
# The common_face method is used to identify a face that is common to two
|
45
|
+
# edges.
|
46
|
+
#
|
47
|
+
# @example
|
48
|
+
# depth = 100
|
49
|
+
# width = 100
|
50
|
+
# model = Sketchup.active_model
|
51
|
+
# entities = model.active_entities
|
52
|
+
# pts = []
|
53
|
+
# pts[0] = [0,0,0]
|
54
|
+
# pts[1] = [width,0,0]
|
55
|
+
# pts[2] = [width,depth,0]
|
56
|
+
# pts[3] = [0,depth,0]
|
57
|
+
# # Add the face to the entities in the model
|
58
|
+
# face = entities.add_face pts
|
59
|
+
# # I know that the second and third entity objects are edges
|
60
|
+
# entity1 = entities[1]
|
61
|
+
# entity2 = entities[2]
|
62
|
+
# UI.messagebox entity1
|
63
|
+
# UI.messagebox entity2
|
64
|
+
# face = entity1.common_face entity2
|
65
|
+
# if (face)
|
66
|
+
# UI.messagebox face
|
67
|
+
# else
|
68
|
+
# UI.messagebox "Failure: No Common Face"
|
69
|
+
# end
|
70
|
+
#
|
71
|
+
# @param [Sketchup::Edge] edge2
|
72
|
+
# The face whose edge you are checking for commonality.
|
73
|
+
#
|
74
|
+
# @return [Sketchup::Face, nil] the Face object that is common to the two edges
|
75
|
+
# if successful
|
76
|
+
#
|
77
|
+
# @version SketchUp 6.0
|
78
|
+
def common_face(edge2)
|
79
|
+
end
|
80
|
+
|
81
|
+
# The curve method is used to get the Curve object that this edge belongs
|
82
|
+
# to, if any. Note that if the edge is part of an arc instead of a random
|
83
|
+
# curve, then this method will return an ArcCurve object.
|
84
|
+
#
|
85
|
+
# @example
|
86
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
87
|
+
# curve = edge.curve
|
88
|
+
# if (curve)
|
89
|
+
# # If it is a curve, display a pointer to the curve
|
90
|
+
# UI.messagebox curve
|
91
|
+
# else
|
92
|
+
# UI.messagebox "Failure: Not a Curve"
|
93
|
+
# end
|
94
|
+
#
|
95
|
+
# @return [Sketchup::Curve, nil] returns a Curve object if it is a
|
96
|
+
# curve, nil if it is not a curve
|
97
|
+
#
|
98
|
+
# @version SketchUp 6.0
|
99
|
+
def curve
|
100
|
+
end
|
101
|
+
|
102
|
+
# The end method is used to retrieve the Vertex object at the end of the edge.
|
103
|
+
#
|
104
|
+
# @example
|
105
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
106
|
+
# vertex = edge.end
|
107
|
+
# if (vertex)
|
108
|
+
# # display a pointer to the Vertex
|
109
|
+
# UI.messagebox vertex
|
110
|
+
# else
|
111
|
+
# UI.messagebox "Failure"
|
112
|
+
# end
|
113
|
+
# point = vertex.position
|
114
|
+
# # Let's get the Point3d of the vertex
|
115
|
+
# if (point)
|
116
|
+
# UI.messagebox point
|
117
|
+
# else
|
118
|
+
# UI.messagebox "Failure"
|
119
|
+
# end
|
120
|
+
#
|
121
|
+
# @return [Sketchup::Vertex] a Vertex object if successful
|
122
|
+
#
|
123
|
+
# @version SketchUp 6.0
|
124
|
+
def end
|
125
|
+
end
|
126
|
+
|
127
|
+
# The explode_curve method is used to explode an edge as though it were an
|
128
|
+
# ArcCurve.
|
129
|
+
#
|
130
|
+
# @example
|
131
|
+
# depth = 100
|
132
|
+
# width = 100
|
133
|
+
# model = Sketchup.active_model
|
134
|
+
# entities = model.active_entities
|
135
|
+
# pts = []
|
136
|
+
# pts[0] = [0, 0, 0]
|
137
|
+
# pts[1] = [width, 0, 0]
|
138
|
+
# pts[2] = [width, depth, 0]
|
139
|
+
# pts[3] = [0, depth, 0]
|
140
|
+
# # Add the face to the entities in the model
|
141
|
+
# face = entities.add_face pts
|
142
|
+
# # I just happen to know that the second entity in the
|
143
|
+
# # entities objects is an edge.
|
144
|
+
# entity1 = entities[1]
|
145
|
+
# curve = entity1.explode_curve
|
146
|
+
# if (curve)
|
147
|
+
# UI.messagebox curve
|
148
|
+
# else
|
149
|
+
# UI.messagebox "Failure"
|
150
|
+
# end
|
151
|
+
#
|
152
|
+
# @return [Sketchup::Edge] an exploded edge object if successful
|
153
|
+
#
|
154
|
+
# @version SketchUp 6.0
|
155
|
+
def explode_curve
|
156
|
+
end
|
157
|
+
|
158
|
+
# The faces method is used to retrieve all of the faces common to the edge.
|
159
|
+
#
|
160
|
+
# @example
|
161
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
162
|
+
# faces = edge.faces
|
163
|
+
# if (faces)
|
164
|
+
# # Display the pointer to the first face returned in the array
|
165
|
+
# UI.messagebox faces[0]
|
166
|
+
# else
|
167
|
+
# UI.messagebox "Failure: No Faces Found"
|
168
|
+
# end
|
169
|
+
#
|
170
|
+
# @return [Array<Sketchup::Face>] an array of Face objects if successful, false
|
171
|
+
# if unsuccessful
|
172
|
+
#
|
173
|
+
# @version SketchUp 6.0
|
174
|
+
def faces
|
175
|
+
end
|
176
|
+
|
177
|
+
# The find_faces method is used to create all of the Faces that can be created
|
178
|
+
# with this edge. For example, if you use the API to draw three edges that form
|
179
|
+
# a triangle, the face between them will not show up because you've only drawn
|
180
|
+
# the edges, but if you call find_faces on one of the edges, the triangle will
|
181
|
+
# be filled in.
|
182
|
+
#
|
183
|
+
# @example
|
184
|
+
# depth = 100
|
185
|
+
# width = 100
|
186
|
+
# model = Sketchup.active_model
|
187
|
+
# entities = model.active_entities
|
188
|
+
# pts = []
|
189
|
+
# pts[0] = [0, 0, 0]
|
190
|
+
# pts[1] = [width, 0, 0]
|
191
|
+
# pts[2] = [width, depth, 0]
|
192
|
+
# pts[3] = [0, depth, 0]
|
193
|
+
# # Add the face to the entities in the model
|
194
|
+
# face = entities.add_face pts
|
195
|
+
# # I just happen to know that the second entity in the
|
196
|
+
# # entities objects is an edge.
|
197
|
+
# entity1 = entities[1]
|
198
|
+
# # Getting zero.
|
199
|
+
# number = entity1.find_faces
|
200
|
+
# if (number)
|
201
|
+
# UI.messagebox "I created " + number.to_s + " faces."
|
202
|
+
# else
|
203
|
+
# UI.messagebox "Failure"
|
204
|
+
# end
|
205
|
+
#
|
206
|
+
# @return [Integer] the number of faces found
|
207
|
+
#
|
208
|
+
# @version SketchUp 6.0
|
209
|
+
def find_faces
|
210
|
+
end
|
211
|
+
|
212
|
+
# The {#length} method is used to retrieve the length of an edge in current
|
213
|
+
# units.
|
214
|
+
#
|
215
|
+
# You can pass in an optional {Geom::Transformation} (or an array that can
|
216
|
+
# represent a transformation), to correct for a parent group's transformation.
|
217
|
+
# For example, if an edge is inside of a group that is scaled to 200%, the
|
218
|
+
# length method will return the unscaled length of the edge. So by passing a
|
219
|
+
# 200% transformation object to this method, you can account for that to get
|
220
|
+
# the "visual" length of the edge.
|
221
|
+
#
|
222
|
+
# @example
|
223
|
+
# edge = Sketchup.active_model.entities.add_line([0, 0, 0], [100, 100, 0])
|
224
|
+
# puts "#{edge.length} (#{edge.length.inspect})"
|
225
|
+
#
|
226
|
+
# @overload length
|
227
|
+
#
|
228
|
+
# @return [Length] the length of the edge
|
229
|
+
#
|
230
|
+
# @overload length(transform)
|
231
|
+
#
|
232
|
+
# @param transform [Geom::Transformation] A Transformation object or array
|
233
|
+
# that can be interpreted as a Transformation object.
|
234
|
+
# @return [Length] the length of the edge
|
235
|
+
#
|
236
|
+
# @version SketchUp 6.0
|
237
|
+
def length(*args)
|
238
|
+
end
|
239
|
+
|
240
|
+
# The line method is used to retrieve the line defined by the edge. Lines in
|
241
|
+
# SketchUp aren't visible entities but geometric constructs represented by
|
242
|
+
# an Array with a Point3d and a Vector3d. See the Geom module and the Array
|
243
|
+
# class for more information on lines.
|
244
|
+
#
|
245
|
+
# @example
|
246
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
247
|
+
# # Returns a 3D ray
|
248
|
+
# line = edge.line
|
249
|
+
# if (line)
|
250
|
+
# UI.messagebox line
|
251
|
+
# else
|
252
|
+
# UI.messagebox "Failure"
|
253
|
+
# end
|
254
|
+
#
|
255
|
+
# @return [Array(Geom::Point3d, Geom::Vector3d)] an array with a Point3d object
|
256
|
+
# and a Vector3d object.
|
257
|
+
#
|
258
|
+
# @version SketchUp 6.0
|
259
|
+
def line
|
260
|
+
end
|
261
|
+
|
262
|
+
# The other_vertex method is used to find the opposite vertex given one vertex
|
263
|
+
# of the edge.
|
264
|
+
#
|
265
|
+
# @example
|
266
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
267
|
+
# # Get the end vertex of an edge
|
268
|
+
# vertex = edge.end
|
269
|
+
# # Should find the starting vertex
|
270
|
+
# othervertex = edge.other_vertex vertex
|
271
|
+
# if (othervertex)
|
272
|
+
# UI.messagebox othervertex
|
273
|
+
# else
|
274
|
+
# UI.messagebox "Failure"
|
275
|
+
# end
|
276
|
+
# # The Point3d for the vertex
|
277
|
+
# point = othervertex.position
|
278
|
+
# if (point)
|
279
|
+
# UI.messagebox point
|
280
|
+
# else
|
281
|
+
# UI.messagebox "Failure"
|
282
|
+
# end
|
283
|
+
#
|
284
|
+
# @param [Sketchup::Vertex] vertex1
|
285
|
+
# One of the Vertex objects associated with the edge.
|
286
|
+
#
|
287
|
+
# @return [Sketchup::Vertex] the other Vertex object associated with the edge
|
288
|
+
#
|
289
|
+
# @version SketchUp 6.0
|
290
|
+
def other_vertex(vertex1)
|
291
|
+
end
|
292
|
+
|
293
|
+
# The {#reversed_in?} method is used to determine if the edge is reversed in
|
294
|
+
# a face's bounding loop.
|
295
|
+
#
|
296
|
+
# @example
|
297
|
+
# model = Sketchup.active_model
|
298
|
+
# entities = model.active_entities
|
299
|
+
# points = []
|
300
|
+
# points[0] = [0, 0, 0]
|
301
|
+
# points[1] = [9, 0, 0]
|
302
|
+
# points[2] = [9, 9, 0]
|
303
|
+
# points[3] = [0, 9, 0]
|
304
|
+
# # Add the face to the entities in the model
|
305
|
+
# face = entities.add_face(points)
|
306
|
+
# edge = face.edges[0]
|
307
|
+
# if edge.reversed_in?(face)
|
308
|
+
# face.reverse!
|
309
|
+
# end
|
310
|
+
#
|
311
|
+
# @param [Sketchup::Face] face
|
312
|
+
# The face that is bounded by the edge.
|
313
|
+
#
|
314
|
+
# @return [Boolean] +true+ if the edge is reversed, +false+ if it is not
|
315
|
+
# reversed. +nil+ if the edge and face is not connected.
|
316
|
+
#
|
317
|
+
# @see Sketchup::EdgeUse
|
318
|
+
#
|
319
|
+
# @see Sketchup::Loop
|
320
|
+
#
|
321
|
+
# @version SketchUp 6.0
|
322
|
+
def reversed_in?(face)
|
323
|
+
end
|
324
|
+
|
325
|
+
# The {#smooth=} method is used to set the edge to be smooth.
|
326
|
+
#
|
327
|
+
# A smooth edge will cause the shading between connected faces to blend to a
|
328
|
+
# smooth transition. The edge will still be visible.
|
329
|
+
#
|
330
|
+
# @example
|
331
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
332
|
+
# # Soft and Smooth are normally set in pairs.
|
333
|
+
# edge.soft = true
|
334
|
+
# edge.smooth = true
|
335
|
+
#
|
336
|
+
# @note The soft and smooth properties are normally set in pairs. You can
|
337
|
+
# observer this when the Soften/Smooth Edges feature or holding down Ctrl
|
338
|
+
# when using the Eraser Tool.
|
339
|
+
#
|
340
|
+
# @param [Boolean] value
|
341
|
+
#
|
342
|
+
# @return [Boolean]
|
343
|
+
#
|
344
|
+
# @see https://help.sketchup.com/en/article/3000097
|
345
|
+
#
|
346
|
+
# @version SketchUp 6.0
|
347
|
+
def smooth=(value)
|
348
|
+
end
|
349
|
+
|
350
|
+
# The {#smooth?} method is used to retrieve the current smooth setting for an
|
351
|
+
# edge.
|
352
|
+
#
|
353
|
+
# A smooth edge will cause the shading between connected faces to blend to a
|
354
|
+
# smooth transition. The edge will still be visible.
|
355
|
+
#
|
356
|
+
# @example
|
357
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
358
|
+
# # Soft and Smooth are normally set in pairs.
|
359
|
+
# edge.smooth = !edge.smooth?
|
360
|
+
# edge.soft = edge.smooth?
|
361
|
+
#
|
362
|
+
# @return [Boolean]
|
363
|
+
#
|
364
|
+
# @see https://help.sketchup.com/en/article/3000097
|
365
|
+
#
|
366
|
+
# @version SketchUp 6.0
|
367
|
+
def smooth?
|
368
|
+
end
|
369
|
+
|
370
|
+
# The {#soft=} method is used to set the edge to be soft.
|
371
|
+
#
|
372
|
+
# A soft edge will cause the connected faces to be treated as a surface. This
|
373
|
+
# means that if you have Hidden Geometry off and select one face it will also
|
374
|
+
# select all faces connected with soft edges. A soft edge will also appear
|
375
|
+
# hidden.
|
376
|
+
#
|
377
|
+
# @example
|
378
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
379
|
+
# # Soft and Smooth are normally set in pairs.
|
380
|
+
# edge.soft = true
|
381
|
+
# edge.smooth = true
|
382
|
+
#
|
383
|
+
# @note The soft and smooth properties are normally set in pairs. You can
|
384
|
+
# observer this when the Soften/Smooth Edges feature or holding down Ctrl
|
385
|
+
# when using the Eraser Tool.
|
386
|
+
#
|
387
|
+
# @param [Boolean] value
|
388
|
+
#
|
389
|
+
# @return [Boolean]
|
390
|
+
#
|
391
|
+
# @see https://help.sketchup.com/en/article/3000097
|
392
|
+
#
|
393
|
+
# @version SketchUp 6.0
|
394
|
+
def soft=(value)
|
395
|
+
end
|
396
|
+
|
397
|
+
# The {#soft?} method is used to retrieve the current smooth setting for an
|
398
|
+
# edge.
|
399
|
+
#
|
400
|
+
# A soft edge will cause the connected faces to be treated as a surface. This
|
401
|
+
# means that if you have Hidden Geometry off and select one face it will also
|
402
|
+
# select all faces connected with soft edges. A soft edge will also appear
|
403
|
+
# hidden.
|
404
|
+
#
|
405
|
+
# @example
|
406
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0], [100,100,0])
|
407
|
+
# # Soft and Smooth are normally set in pairs.
|
408
|
+
# edge.soft = !edge.soft?
|
409
|
+
# edge.smooth = edge.soft?
|
410
|
+
#
|
411
|
+
# @return [Boolean]
|
412
|
+
#
|
413
|
+
# @see https://help.sketchup.com/en/article/3000097
|
414
|
+
#
|
415
|
+
# @version SketchUp 6.0
|
416
|
+
def soft?
|
417
|
+
end
|
418
|
+
|
419
|
+
# The split method is used to to split an edge into to or more distinct
|
420
|
+
# edges. If a Point3d is given, it must be a point that is on the Edge.
|
421
|
+
#
|
422
|
+
# If a Float is given, it is a number between 0 and 1 that gives the
|
423
|
+
# relative position along the edge at which to split it. For example,
|
424
|
+
# edge.split(0.5) will split the Edge at its midpoint. This split position
|
425
|
+
# is measured from the Edge.start.
|
426
|
+
#
|
427
|
+
# Returns the new Edge that was created as a result of splitting this one.
|
428
|
+
#
|
429
|
+
# @example
|
430
|
+
# # Split a line in half.
|
431
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
432
|
+
# new_edge = edge.split 0.5
|
433
|
+
#
|
434
|
+
# @param [Geom::Point3d] position
|
435
|
+
# A Point3d object whose location is along the edge, or
|
436
|
+
# a Float between 0.0 and 1.0 defining how far along the
|
437
|
+
# edge to split.
|
438
|
+
#
|
439
|
+
# @return [Sketchup::Edge] the new Edge object that was split off
|
440
|
+
# the old one if successful
|
441
|
+
#
|
442
|
+
# @version SketchUp 6.0
|
443
|
+
def split(position)
|
444
|
+
end
|
445
|
+
|
446
|
+
# The end method is used to retrieve the Vertex object at the start of the
|
447
|
+
# edge.
|
448
|
+
#
|
449
|
+
# @example
|
450
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
451
|
+
# vertex = edge.start
|
452
|
+
# if (vertex)
|
453
|
+
# # display a pointer to the Vertex
|
454
|
+
# UI.messagebox vertex
|
455
|
+
# else
|
456
|
+
# UI.messagebox "Failure"
|
457
|
+
# end
|
458
|
+
# point = vertex.position
|
459
|
+
# # Let's get the Point3d of the vertex
|
460
|
+
# if (point)
|
461
|
+
# UI.messagebox point
|
462
|
+
# else
|
463
|
+
# UI.messagebox "Failure"
|
464
|
+
# end
|
465
|
+
#
|
466
|
+
# @return [Sketchup::Vertex] a Vertex object if successful
|
467
|
+
#
|
468
|
+
# @version SketchUp 6.0
|
469
|
+
def start
|
470
|
+
end
|
471
|
+
|
472
|
+
# The used_by? method is used to see if an edge is used by a given Face or
|
473
|
+
# Vertex.
|
474
|
+
#
|
475
|
+
# @example
|
476
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
477
|
+
# # Returns a vertex
|
478
|
+
# vertex = edge.start
|
479
|
+
# # Check to see if the edge is used by the Vertex.
|
480
|
+
# status = edge.used_by? vertex
|
481
|
+
# if (status)
|
482
|
+
# UI.messagebox status
|
483
|
+
# else
|
484
|
+
# UI.messagebox "Failure"
|
485
|
+
# end
|
486
|
+
#
|
487
|
+
# @param [Sketchup::Vertex, Sketchup::Face] element
|
488
|
+
# A Vertex or Face object.
|
489
|
+
#
|
490
|
+
# @return [Boolean]
|
491
|
+
#
|
492
|
+
# @version SketchUp 6.0
|
493
|
+
def used_by?(element)
|
494
|
+
end
|
495
|
+
|
496
|
+
# The vertices method is used to retrieve the vertices on the edge.
|
497
|
+
#
|
498
|
+
# @example
|
499
|
+
# edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
|
500
|
+
# vertices = edge.vertices
|
501
|
+
#
|
502
|
+
# @return [Array<Sketchup::Vertex>] an array of Vertex objects
|
503
|
+
#
|
504
|
+
# @version SketchUp 6.0
|
505
|
+
def vertices
|
506
|
+
end
|
507
|
+
|
508
|
+
end
|