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,32 +1,32 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# A construction point represents a point in the model that can be used to aid
|
5
|
-
# in other modeling operations. For example, you may put a construction point
|
6
|
-
# at the center of a circle to make it easier to locate that point for
|
7
|
-
# performing other operations.
|
8
|
-
#
|
9
|
-
# @version SketchUp 6.0
|
10
|
-
class Sketchup::ConstructionPoint < Sketchup::Drawingelement
|
11
|
-
|
12
|
-
# Instance Methods
|
13
|
-
|
14
|
-
# The position method is used to retrieve a Point3d used to create a
|
15
|
-
# construction point.
|
16
|
-
#
|
17
|
-
# @example
|
18
|
-
# model = Sketchup.active_model
|
19
|
-
# entities = model.active_entities
|
20
|
-
# point1 = Geom::Point3d.new(10,0,0)
|
21
|
-
# constpoint = entities.add_cpoint point1
|
22
|
-
# # Returns 10,0,0
|
23
|
-
# position = constpoint.position
|
24
|
-
#
|
25
|
-
# @return point - the Point3d object used to create the
|
26
|
-
# ConstructionPoint
|
27
|
-
#
|
28
|
-
# @version SketchUp 6.0
|
29
|
-
def position
|
30
|
-
end
|
31
|
-
|
32
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# A construction point represents a point in the model that can be used to aid
|
5
|
+
# in other modeling operations. For example, you may put a construction point
|
6
|
+
# at the center of a circle to make it easier to locate that point for
|
7
|
+
# performing other operations.
|
8
|
+
#
|
9
|
+
# @version SketchUp 6.0
|
10
|
+
class Sketchup::ConstructionPoint < Sketchup::Drawingelement
|
11
|
+
|
12
|
+
# Instance Methods
|
13
|
+
|
14
|
+
# The position method is used to retrieve a Point3d used to create a
|
15
|
+
# construction point.
|
16
|
+
#
|
17
|
+
# @example
|
18
|
+
# model = Sketchup.active_model
|
19
|
+
# entities = model.active_entities
|
20
|
+
# point1 = Geom::Point3d.new(10,0,0)
|
21
|
+
# constpoint = entities.add_cpoint point1
|
22
|
+
# # Returns 10,0,0
|
23
|
+
# position = constpoint.position
|
24
|
+
#
|
25
|
+
# @return point - the Point3d object used to create the
|
26
|
+
# ConstructionPoint
|
27
|
+
#
|
28
|
+
# @version SketchUp 6.0
|
29
|
+
def position
|
30
|
+
end
|
31
|
+
|
32
|
+
end
|
@@ -1,194 +1,194 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Curve class is used by SketchUp to unite a series of Edge objects into
|
5
|
-
# one conceptual entity. Since SketchUp is a surface modeler, all circles,
|
6
|
-
# arcs, and arbitrary curves are really just edges that are bound together in
|
7
|
-
# sequence.
|
8
|
-
#
|
9
|
-
# There is a subclass of Curve called ArcCurve, which is any curve that makes
|
10
|
-
# up part of a circle. You can think of ArcCurves as entities that were created
|
11
|
-
# with SketchUp's Arc or Circle drawing tools and Curves as entities that were
|
12
|
-
# created with the Freehand drawing tool.
|
13
|
-
#
|
14
|
-
# @version SketchUp 6.0
|
15
|
-
class Sketchup::Curve < Sketchup::Entity
|
16
|
-
|
17
|
-
# Instance Methods
|
18
|
-
|
19
|
-
# The count_edges method is used to retrieve the number of Edge objects that
|
20
|
-
# make up the Curve.
|
21
|
-
#
|
22
|
-
# @example
|
23
|
-
# centerpoint = Geom::Point3d.new
|
24
|
-
# # Create a circle perpendicular to the normal or Z axis
|
25
|
-
# vector = Geom::Vector3d.new 0,0,1
|
26
|
-
# vector2 = vector.normalize!
|
27
|
-
# model = Sketchup.active_model
|
28
|
-
# entities = model.entities
|
29
|
-
# edgearray = entities.add_circle centerpoint, vector2, 10
|
30
|
-
# edge = edgearray[0]
|
31
|
-
# curve = edge.curve
|
32
|
-
# number = curve.count_edges
|
33
|
-
#
|
34
|
-
# @return num_edges - the number of edges in the curve
|
35
|
-
#
|
36
|
-
# @version SketchUp 6.0
|
37
|
-
def count_edges
|
38
|
-
end
|
39
|
-
|
40
|
-
# The each_edge method is used to iterate through all of the Edge objects in
|
41
|
-
# the curve.
|
42
|
-
#
|
43
|
-
# @example
|
44
|
-
# centerpoint = Geom::Point3d.new
|
45
|
-
# # Create a circle perpendicular to the normal or Z axis
|
46
|
-
# vector = Geom::Vector3d.new 0,0,1
|
47
|
-
# vector2 = vector.normalize!
|
48
|
-
# model = Sketchup.active_model
|
49
|
-
# entities = model.entities
|
50
|
-
# edgearray = entities.add_circle centerpoint, vector2, 10
|
51
|
-
# edge = edgearray[0]
|
52
|
-
# curve = edge.curve
|
53
|
-
# curve.each_edge {|e| UI.messagebox e}
|
54
|
-
#
|
55
|
-
# @return edge - a variable that will hold each Edge object as
|
56
|
-
# they are found.
|
57
|
-
#
|
58
|
-
# @version SketchUp 6.0
|
59
|
-
def each_edge
|
60
|
-
end
|
61
|
-
|
62
|
-
# The edges method is used to retrieve an array of Edge objects that make up
|
63
|
-
# the Curve.
|
64
|
-
#
|
65
|
-
# @example
|
66
|
-
# centerpoint = Geom::Point3d.new
|
67
|
-
# # Create a circle perpendicular to the normal or Z axis
|
68
|
-
# vector = Geom::Vector3d.new 0,0,1
|
69
|
-
# vector2 = vector.normalize!
|
70
|
-
# model = Sketchup.active_model
|
71
|
-
# entities = model.entities
|
72
|
-
# edgearray = entities.add_circle centerpoint, vector2, 10
|
73
|
-
# edge = edgearray[0]
|
74
|
-
# curve = edge.curve
|
75
|
-
# edges = curve.edges
|
76
|
-
#
|
77
|
-
# @return edges - an array of Edge objects if successful
|
78
|
-
#
|
79
|
-
# @version SketchUp 6.0
|
80
|
-
def edges
|
81
|
-
end
|
82
|
-
|
83
|
-
# The first_edge method is used to retrieve the first edge of the curve.
|
84
|
-
#
|
85
|
-
# @example
|
86
|
-
# centerpoint = Geom::Point3d.new
|
87
|
-
# # Create a circle perpendicular to the normal or Z axis
|
88
|
-
# vector = Geom::Vector3d.new 0,0,1
|
89
|
-
# vector2 = vector.normalize!
|
90
|
-
# model = Sketchup.active_model
|
91
|
-
# entities = model.entities
|
92
|
-
# edgearray = entities.add_circle centerpoint, vector2, 10
|
93
|
-
# edge = edgearray[0]
|
94
|
-
# curve = edge.curve
|
95
|
-
# firstedge = curve.first_edge
|
96
|
-
#
|
97
|
-
# @return edge - the first Edge object in the curve if successful
|
98
|
-
#
|
99
|
-
# @version SketchUp 6.0
|
100
|
-
def first_edge
|
101
|
-
end
|
102
|
-
|
103
|
-
#
|
104
|
-
# @example
|
105
|
-
# # Create a polygon and check its edge
|
106
|
-
# ents = Sketchup.active_model.entities
|
107
|
-
# ents.add_ngon [0, 0, 0], [0, 0, 1], 10, 6
|
108
|
-
# curve = nil
|
109
|
-
# ents.each { |e| curve = e.curve if e.is_a? Sketchup::Edge }
|
110
|
-
# is_poly = curve.is_polygon?
|
111
|
-
#
|
112
|
-
# @return [Boolean] True if this edge was originally created by the polygon
|
113
|
-
# tool, otherwise false.
|
114
|
-
#
|
115
|
-
# @version SketchUp 7.1 M1
|
116
|
-
def is_polygon?
|
117
|
-
end
|
118
|
-
|
119
|
-
# The last_edge method is used to retrieve the last edge of the curve.
|
120
|
-
#
|
121
|
-
# @example
|
122
|
-
# centerpoint = Geom::Point3d.new
|
123
|
-
# # Create a circle perpendicular to the normal or Z axis
|
124
|
-
# vector = Geom::Vector3d.new 0,0,1
|
125
|
-
# vector2 = vector.normalize!
|
126
|
-
# model = Sketchup.active_model
|
127
|
-
# entities = model.entities
|
128
|
-
# edgearray = entities.add_circle centerpoint, vector2, 10
|
129
|
-
# edge = edgearray[7]
|
130
|
-
# curve = edge.curve
|
131
|
-
# lastedge = curve.last_edge
|
132
|
-
#
|
133
|
-
# @return edge - the last Edge object in the curve if successful
|
134
|
-
#
|
135
|
-
# @version SketchUp 6.0
|
136
|
-
def last_edge
|
137
|
-
end
|
138
|
-
|
139
|
-
# The length method retrieves the length of the curve.
|
140
|
-
#
|
141
|
-
# @example
|
142
|
-
# centerpoint = Geom::Point3d.new
|
143
|
-
# # Create a circle perpendicular to the normal or Z axis
|
144
|
-
# vector = Geom::Vector3d.new 0,0,1
|
145
|
-
# vector2 = vector.normalize!
|
146
|
-
# model = Sketchup.active_model
|
147
|
-
# entities = model.entities
|
148
|
-
# edgearray = entities.add_circle centerpoint, vector2, 10
|
149
|
-
# edge = edgearray[7]
|
150
|
-
# curve = edge.curve
|
151
|
-
# length = curve.length
|
152
|
-
#
|
153
|
-
# @return length - the length of the curve in current units if
|
154
|
-
# successful
|
155
|
-
#
|
156
|
-
# @version SketchUp 6.0
|
157
|
-
def length
|
158
|
-
end
|
159
|
-
|
160
|
-
# The vertices method retrieves a collection of all vertices in a curve.
|
161
|
-
#
|
162
|
-
# @example
|
163
|
-
# # Need example ruby code here.
|
164
|
-
#
|
165
|
-
# @param point_array
|
166
|
-
# Array of Point3d objects to move each vertex to match.
|
167
|
-
#
|
168
|
-
# @return success - true or false
|
169
|
-
#
|
170
|
-
# @version SketchUp 6.0
|
171
|
-
def move_vertices(point_array)
|
172
|
-
end
|
173
|
-
|
174
|
-
# The vertices method retrieves a collection of all vertices in a curve.
|
175
|
-
#
|
176
|
-
# @example
|
177
|
-
# centerpoint = Geom::Point3d.new
|
178
|
-
# # Create a circle perpendicular to the normal or Z axis
|
179
|
-
# vector = Geom::Vector3d.new 0,0,1
|
180
|
-
# vector2 = vector.normalize!
|
181
|
-
# model = Sketchup.active_model
|
182
|
-
# entities = model.entities
|
183
|
-
# edgearray = entities.add_circle centerpoint, vector2, 10
|
184
|
-
# edge = edgearray[7]
|
185
|
-
# curve = edge.curve
|
186
|
-
# vertices = curve.vertices
|
187
|
-
#
|
188
|
-
# @return vertices - a collection of the vertices
|
189
|
-
#
|
190
|
-
# @version SketchUp 6.0
|
191
|
-
def vertices
|
192
|
-
end
|
193
|
-
|
194
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Curve class is used by SketchUp to unite a series of Edge objects into
|
5
|
+
# one conceptual entity. Since SketchUp is a surface modeler, all circles,
|
6
|
+
# arcs, and arbitrary curves are really just edges that are bound together in
|
7
|
+
# sequence.
|
8
|
+
#
|
9
|
+
# There is a subclass of Curve called ArcCurve, which is any curve that makes
|
10
|
+
# up part of a circle. You can think of ArcCurves as entities that were created
|
11
|
+
# with SketchUp's Arc or Circle drawing tools and Curves as entities that were
|
12
|
+
# created with the Freehand drawing tool.
|
13
|
+
#
|
14
|
+
# @version SketchUp 6.0
|
15
|
+
class Sketchup::Curve < Sketchup::Entity
|
16
|
+
|
17
|
+
# Instance Methods
|
18
|
+
|
19
|
+
# The count_edges method is used to retrieve the number of Edge objects that
|
20
|
+
# make up the Curve.
|
21
|
+
#
|
22
|
+
# @example
|
23
|
+
# centerpoint = Geom::Point3d.new
|
24
|
+
# # Create a circle perpendicular to the normal or Z axis
|
25
|
+
# vector = Geom::Vector3d.new 0,0,1
|
26
|
+
# vector2 = vector.normalize!
|
27
|
+
# model = Sketchup.active_model
|
28
|
+
# entities = model.entities
|
29
|
+
# edgearray = entities.add_circle centerpoint, vector2, 10
|
30
|
+
# edge = edgearray[0]
|
31
|
+
# curve = edge.curve
|
32
|
+
# number = curve.count_edges
|
33
|
+
#
|
34
|
+
# @return num_edges - the number of edges in the curve
|
35
|
+
#
|
36
|
+
# @version SketchUp 6.0
|
37
|
+
def count_edges
|
38
|
+
end
|
39
|
+
|
40
|
+
# The each_edge method is used to iterate through all of the Edge objects in
|
41
|
+
# the curve.
|
42
|
+
#
|
43
|
+
# @example
|
44
|
+
# centerpoint = Geom::Point3d.new
|
45
|
+
# # Create a circle perpendicular to the normal or Z axis
|
46
|
+
# vector = Geom::Vector3d.new 0,0,1
|
47
|
+
# vector2 = vector.normalize!
|
48
|
+
# model = Sketchup.active_model
|
49
|
+
# entities = model.entities
|
50
|
+
# edgearray = entities.add_circle centerpoint, vector2, 10
|
51
|
+
# edge = edgearray[0]
|
52
|
+
# curve = edge.curve
|
53
|
+
# curve.each_edge {|e| UI.messagebox e}
|
54
|
+
#
|
55
|
+
# @return edge - a variable that will hold each Edge object as
|
56
|
+
# they are found.
|
57
|
+
#
|
58
|
+
# @version SketchUp 6.0
|
59
|
+
def each_edge
|
60
|
+
end
|
61
|
+
|
62
|
+
# The edges method is used to retrieve an array of Edge objects that make up
|
63
|
+
# the Curve.
|
64
|
+
#
|
65
|
+
# @example
|
66
|
+
# centerpoint = Geom::Point3d.new
|
67
|
+
# # Create a circle perpendicular to the normal or Z axis
|
68
|
+
# vector = Geom::Vector3d.new 0,0,1
|
69
|
+
# vector2 = vector.normalize!
|
70
|
+
# model = Sketchup.active_model
|
71
|
+
# entities = model.entities
|
72
|
+
# edgearray = entities.add_circle centerpoint, vector2, 10
|
73
|
+
# edge = edgearray[0]
|
74
|
+
# curve = edge.curve
|
75
|
+
# edges = curve.edges
|
76
|
+
#
|
77
|
+
# @return edges - an array of Edge objects if successful
|
78
|
+
#
|
79
|
+
# @version SketchUp 6.0
|
80
|
+
def edges
|
81
|
+
end
|
82
|
+
|
83
|
+
# The first_edge method is used to retrieve the first edge of the curve.
|
84
|
+
#
|
85
|
+
# @example
|
86
|
+
# centerpoint = Geom::Point3d.new
|
87
|
+
# # Create a circle perpendicular to the normal or Z axis
|
88
|
+
# vector = Geom::Vector3d.new 0,0,1
|
89
|
+
# vector2 = vector.normalize!
|
90
|
+
# model = Sketchup.active_model
|
91
|
+
# entities = model.entities
|
92
|
+
# edgearray = entities.add_circle centerpoint, vector2, 10
|
93
|
+
# edge = edgearray[0]
|
94
|
+
# curve = edge.curve
|
95
|
+
# firstedge = curve.first_edge
|
96
|
+
#
|
97
|
+
# @return edge - the first Edge object in the curve if successful
|
98
|
+
#
|
99
|
+
# @version SketchUp 6.0
|
100
|
+
def first_edge
|
101
|
+
end
|
102
|
+
|
103
|
+
#
|
104
|
+
# @example
|
105
|
+
# # Create a polygon and check its edge
|
106
|
+
# ents = Sketchup.active_model.entities
|
107
|
+
# ents.add_ngon [0, 0, 0], [0, 0, 1], 10, 6
|
108
|
+
# curve = nil
|
109
|
+
# ents.each { |e| curve = e.curve if e.is_a? Sketchup::Edge }
|
110
|
+
# is_poly = curve.is_polygon?
|
111
|
+
#
|
112
|
+
# @return [Boolean] True if this edge was originally created by the polygon
|
113
|
+
# tool, otherwise false.
|
114
|
+
#
|
115
|
+
# @version SketchUp 7.1 M1
|
116
|
+
def is_polygon?
|
117
|
+
end
|
118
|
+
|
119
|
+
# The last_edge method is used to retrieve the last edge of the curve.
|
120
|
+
#
|
121
|
+
# @example
|
122
|
+
# centerpoint = Geom::Point3d.new
|
123
|
+
# # Create a circle perpendicular to the normal or Z axis
|
124
|
+
# vector = Geom::Vector3d.new 0,0,1
|
125
|
+
# vector2 = vector.normalize!
|
126
|
+
# model = Sketchup.active_model
|
127
|
+
# entities = model.entities
|
128
|
+
# edgearray = entities.add_circle centerpoint, vector2, 10
|
129
|
+
# edge = edgearray[7]
|
130
|
+
# curve = edge.curve
|
131
|
+
# lastedge = curve.last_edge
|
132
|
+
#
|
133
|
+
# @return edge - the last Edge object in the curve if successful
|
134
|
+
#
|
135
|
+
# @version SketchUp 6.0
|
136
|
+
def last_edge
|
137
|
+
end
|
138
|
+
|
139
|
+
# The length method retrieves the length of the curve.
|
140
|
+
#
|
141
|
+
# @example
|
142
|
+
# centerpoint = Geom::Point3d.new
|
143
|
+
# # Create a circle perpendicular to the normal or Z axis
|
144
|
+
# vector = Geom::Vector3d.new 0,0,1
|
145
|
+
# vector2 = vector.normalize!
|
146
|
+
# model = Sketchup.active_model
|
147
|
+
# entities = model.entities
|
148
|
+
# edgearray = entities.add_circle centerpoint, vector2, 10
|
149
|
+
# edge = edgearray[7]
|
150
|
+
# curve = edge.curve
|
151
|
+
# length = curve.length
|
152
|
+
#
|
153
|
+
# @return length - the length of the curve in current units if
|
154
|
+
# successful
|
155
|
+
#
|
156
|
+
# @version SketchUp 6.0
|
157
|
+
def length
|
158
|
+
end
|
159
|
+
|
160
|
+
# The vertices method retrieves a collection of all vertices in a curve.
|
161
|
+
#
|
162
|
+
# @example
|
163
|
+
# # Need example ruby code here.
|
164
|
+
#
|
165
|
+
# @param point_array
|
166
|
+
# Array of Point3d objects to move each vertex to match.
|
167
|
+
#
|
168
|
+
# @return success - true or false
|
169
|
+
#
|
170
|
+
# @version SketchUp 6.0
|
171
|
+
def move_vertices(point_array)
|
172
|
+
end
|
173
|
+
|
174
|
+
# The vertices method retrieves a collection of all vertices in a curve.
|
175
|
+
#
|
176
|
+
# @example
|
177
|
+
# centerpoint = Geom::Point3d.new
|
178
|
+
# # Create a circle perpendicular to the normal or Z axis
|
179
|
+
# vector = Geom::Vector3d.new 0,0,1
|
180
|
+
# vector2 = vector.normalize!
|
181
|
+
# model = Sketchup.active_model
|
182
|
+
# entities = model.entities
|
183
|
+
# edgearray = entities.add_circle centerpoint, vector2, 10
|
184
|
+
# edge = edgearray[7]
|
185
|
+
# curve = edge.curve
|
186
|
+
# vertices = curve.vertices
|
187
|
+
#
|
188
|
+
# @return vertices - a collection of the vertices
|
189
|
+
#
|
190
|
+
# @version SketchUp 6.0
|
191
|
+
def vertices
|
192
|
+
end
|
193
|
+
|
194
|
+
end
|