sketchup-api-stubs 0.7.4 → 0.7.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/sketchup-api-stubs/sketchup.rb +148 -145
- data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -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 +523 -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 +693 -691
- data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -348
- data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +698 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -174
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +516 -514
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -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 +370 -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 +225 -220
- 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 +209 -204
- 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 +692 -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/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
- data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -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 +286 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -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 +294 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +619 -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 +201 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +426 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1205 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +272 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +292 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +407 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -112
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -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 +797 -770
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +477 -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 +45 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -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 +260 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +837 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1317 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
- data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1360 -1310
- data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
- data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +496 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
- data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -667
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
- data/lib/sketchup-api-stubs.rb +1 -1
- metadata +15 -12
@@ -1,63 +1,63 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The ClassificationSchema class represent schemas loaded in the model.
|
5
|
-
#
|
6
|
-
# @version SketchUp 2015
|
7
|
-
class Sketchup::ClassificationSchema
|
8
|
-
|
9
|
-
# Includes
|
10
|
-
|
11
|
-
include Comparable
|
12
|
-
|
13
|
-
# Instance Methods
|
14
|
-
|
15
|
-
# The <=> method is used to compare two ClassificationSchema objects for
|
16
|
-
# sorting. The comparison is done based on the schema name.
|
17
|
-
#
|
18
|
-
# @example
|
19
|
-
# schema1 = Sketchup.active_model.classifications["IFC 2x3"]
|
20
|
-
# schema2 = Sketchup.active_model.classifications["gbXML"]
|
21
|
-
# # Returns -1
|
22
|
-
# result = schema1 <=> schema2
|
23
|
-
# # Returns an array of sorted schemas.
|
24
|
-
# schemas = Sketchup.active_model.classifications.to_a.sort
|
25
|
-
#
|
26
|
-
# @param schema2
|
27
|
-
# The second schema in the comparison.
|
28
|
-
#
|
29
|
-
# @return Integer - -1 if schema1 is less then schema2. 1 if
|
30
|
-
# schema1 is greater than schema2, 0 if the schemas
|
31
|
-
# are equal.
|
32
|
-
#
|
33
|
-
# @version SketchUp 2015
|
34
|
-
def <=>(schema2)
|
35
|
-
end
|
36
|
-
|
37
|
-
# The name method returns the name of the schema.
|
38
|
-
#
|
39
|
-
# @example
|
40
|
-
# Sketchup.active_model.classifications.each { |schema|
|
41
|
-
# puts schema.name
|
42
|
-
# }
|
43
|
-
#
|
44
|
-
# @return String - containing the schema name.
|
45
|
-
#
|
46
|
-
# @version SketchUp 2015
|
47
|
-
def name
|
48
|
-
end
|
49
|
-
|
50
|
-
# The namespace method returns the namespace of the schema.
|
51
|
-
#
|
52
|
-
# @example
|
53
|
-
# Sketchup.active_model.classifications.each { |schema|
|
54
|
-
# puts schema.namespace
|
55
|
-
# }
|
56
|
-
#
|
57
|
-
# @return String - containing the schema namespace.
|
58
|
-
#
|
59
|
-
# @version SketchUp 2015
|
60
|
-
def namespace
|
61
|
-
end
|
62
|
-
|
63
|
-
end
|
1
|
+
# Copyright:: Copyright 2022 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The ClassificationSchema class represent schemas loaded in the model.
|
5
|
+
#
|
6
|
+
# @version SketchUp 2015
|
7
|
+
class Sketchup::ClassificationSchema
|
8
|
+
|
9
|
+
# Includes
|
10
|
+
|
11
|
+
include Comparable
|
12
|
+
|
13
|
+
# Instance Methods
|
14
|
+
|
15
|
+
# The <=> method is used to compare two ClassificationSchema objects for
|
16
|
+
# sorting. The comparison is done based on the schema name.
|
17
|
+
#
|
18
|
+
# @example
|
19
|
+
# schema1 = Sketchup.active_model.classifications["IFC 2x3"]
|
20
|
+
# schema2 = Sketchup.active_model.classifications["gbXML"]
|
21
|
+
# # Returns -1
|
22
|
+
# result = schema1 <=> schema2
|
23
|
+
# # Returns an array of sorted schemas.
|
24
|
+
# schemas = Sketchup.active_model.classifications.to_a.sort
|
25
|
+
#
|
26
|
+
# @param schema2
|
27
|
+
# The second schema in the comparison.
|
28
|
+
#
|
29
|
+
# @return Integer - -1 if schema1 is less then schema2. 1 if
|
30
|
+
# schema1 is greater than schema2, 0 if the schemas
|
31
|
+
# are equal.
|
32
|
+
#
|
33
|
+
# @version SketchUp 2015
|
34
|
+
def <=>(schema2)
|
35
|
+
end
|
36
|
+
|
37
|
+
# The name method returns the name of the schema.
|
38
|
+
#
|
39
|
+
# @example
|
40
|
+
# Sketchup.active_model.classifications.each { |schema|
|
41
|
+
# puts schema.name
|
42
|
+
# }
|
43
|
+
#
|
44
|
+
# @return String - containing the schema name.
|
45
|
+
#
|
46
|
+
# @version SketchUp 2015
|
47
|
+
def name
|
48
|
+
end
|
49
|
+
|
50
|
+
# The namespace method returns the namespace of the schema.
|
51
|
+
#
|
52
|
+
# @example
|
53
|
+
# Sketchup.active_model.classifications.each { |schema|
|
54
|
+
# puts schema.namespace
|
55
|
+
# }
|
56
|
+
#
|
57
|
+
# @return String - containing the schema namespace.
|
58
|
+
#
|
59
|
+
# @version SketchUp 2015
|
60
|
+
def namespace
|
61
|
+
end
|
62
|
+
|
63
|
+
end
|
@@ -1,122 +1,122 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Classifications class is a container/manager for all classifications in
|
5
|
-
# a model.
|
6
|
-
#
|
7
|
-
# @version SketchUp 2015
|
8
|
-
class Sketchup::Classifications
|
9
|
-
|
10
|
-
# Includes
|
11
|
-
|
12
|
-
include Enumerable
|
13
|
-
|
14
|
-
# Instance Methods
|
15
|
-
|
16
|
-
# The [] method is used to get a classification schema by name or index.
|
17
|
-
#
|
18
|
-
# @example
|
19
|
-
# # Get schema by name:
|
20
|
-
# schema = Sketchup.active_model.classifications["IFC 2x3"]
|
21
|
-
#
|
22
|
-
# # Get schema by index:
|
23
|
-
# schema = Sketchup.active_model.classifications[1]
|
24
|
-
#
|
25
|
-
# @param index_or_name
|
26
|
-
# The index or name of the ClassificationSchema object.
|
27
|
-
#
|
28
|
-
# @return schema - a ClassificationSchema object if
|
29
|
-
# successful, otherwise nil.
|
30
|
-
#
|
31
|
-
# @version SketchUp 2015
|
32
|
-
def [](index_or_name)
|
33
|
-
end
|
34
|
-
|
35
|
-
# The each method is used to iterate through loaded classification schemas.
|
36
|
-
#
|
37
|
-
# @example
|
38
|
-
# Sketchup.active_model.classifications.each { |schema|
|
39
|
-
# puts schema.name
|
40
|
-
# }
|
41
|
-
#
|
42
|
-
# @return nil
|
43
|
-
#
|
44
|
-
# @version SketchUp 2015
|
45
|
-
#
|
46
|
-
# @yield [schema] A variable that will hold each ClassificationSchema
|
47
|
-
# object as they are found.
|
48
|
-
def each
|
49
|
-
end
|
50
|
-
|
51
|
-
# The keys method is used to get a list of keys in the Classifications class,
|
52
|
-
# which are the same as the names of the schemas.
|
53
|
-
#
|
54
|
-
# @example
|
55
|
-
# schema_names = Sketchup.active_model.classifications.keys
|
56
|
-
#
|
57
|
-
# @return keys - Array of string keys
|
58
|
-
#
|
59
|
-
# @version SketchUp 2015
|
60
|
-
def keys
|
61
|
-
end
|
62
|
-
|
63
|
-
# The {#length} method returns the number of loaded classification schemas.
|
64
|
-
#
|
65
|
-
# @example
|
66
|
-
# Sketchup.active_model.classifications.length
|
67
|
-
#
|
68
|
-
# @return [Integer]
|
69
|
-
#
|
70
|
-
# @see #size
|
71
|
-
#
|
72
|
-
# @version SketchUp 2015
|
73
|
-
def length
|
74
|
-
end
|
75
|
-
|
76
|
-
# The load_schema method is used to load a classification schema into a
|
77
|
-
# model.
|
78
|
-
#
|
79
|
-
# @example
|
80
|
-
# c = Sketchup.active_model.classifications
|
81
|
-
# file = Sketchup.find_support_file('IFC 4.skc', 'Classifications')
|
82
|
-
# status = c.load_schema(file) if !file.nil?
|
83
|
-
#
|
84
|
-
# @param file
|
85
|
-
# Full path to the schema file
|
86
|
-
#
|
87
|
-
# @return True if successful.
|
88
|
-
#
|
89
|
-
# @version SketchUp 2015
|
90
|
-
def load_schema(file)
|
91
|
-
end
|
92
|
-
|
93
|
-
# The {#size} method returns the number of loaded classification schemas.
|
94
|
-
#
|
95
|
-
# @example
|
96
|
-
# Sketchup.active_model.classifications.size
|
97
|
-
#
|
98
|
-
# @return [Integer]
|
99
|
-
#
|
100
|
-
# @see #length
|
101
|
-
#
|
102
|
-
# @version SketchUp 2015
|
103
|
-
def size
|
104
|
-
end
|
105
|
-
|
106
|
-
# The unload_schema method is used to unload a classification schema that was
|
107
|
-
# previously loaded into a model.
|
108
|
-
#
|
109
|
-
# @example
|
110
|
-
# c = Sketchup.active_model.classifications
|
111
|
-
# status = c.unload_schema('IFC 2x3')
|
112
|
-
#
|
113
|
-
# @param schema_name
|
114
|
-
# Name of the schema to unload
|
115
|
-
#
|
116
|
-
# @return True if successful.
|
117
|
-
#
|
118
|
-
# @version SketchUp 2015
|
119
|
-
def unload_schema(schema_name)
|
120
|
-
end
|
121
|
-
|
122
|
-
end
|
1
|
+
# Copyright:: Copyright 2022 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Classifications class is a container/manager for all classifications in
|
5
|
+
# a model.
|
6
|
+
#
|
7
|
+
# @version SketchUp 2015
|
8
|
+
class Sketchup::Classifications
|
9
|
+
|
10
|
+
# Includes
|
11
|
+
|
12
|
+
include Enumerable
|
13
|
+
|
14
|
+
# Instance Methods
|
15
|
+
|
16
|
+
# The [] method is used to get a classification schema by name or index.
|
17
|
+
#
|
18
|
+
# @example
|
19
|
+
# # Get schema by name:
|
20
|
+
# schema = Sketchup.active_model.classifications["IFC 2x3"]
|
21
|
+
#
|
22
|
+
# # Get schema by index:
|
23
|
+
# schema = Sketchup.active_model.classifications[1]
|
24
|
+
#
|
25
|
+
# @param index_or_name
|
26
|
+
# The index or name of the ClassificationSchema object.
|
27
|
+
#
|
28
|
+
# @return schema - a ClassificationSchema object if
|
29
|
+
# successful, otherwise nil.
|
30
|
+
#
|
31
|
+
# @version SketchUp 2015
|
32
|
+
def [](index_or_name)
|
33
|
+
end
|
34
|
+
|
35
|
+
# The each method is used to iterate through loaded classification schemas.
|
36
|
+
#
|
37
|
+
# @example
|
38
|
+
# Sketchup.active_model.classifications.each { |schema|
|
39
|
+
# puts schema.name
|
40
|
+
# }
|
41
|
+
#
|
42
|
+
# @return nil
|
43
|
+
#
|
44
|
+
# @version SketchUp 2015
|
45
|
+
#
|
46
|
+
# @yield [schema] A variable that will hold each ClassificationSchema
|
47
|
+
# object as they are found.
|
48
|
+
def each
|
49
|
+
end
|
50
|
+
|
51
|
+
# The keys method is used to get a list of keys in the Classifications class,
|
52
|
+
# which are the same as the names of the schemas.
|
53
|
+
#
|
54
|
+
# @example
|
55
|
+
# schema_names = Sketchup.active_model.classifications.keys
|
56
|
+
#
|
57
|
+
# @return keys - Array of string keys
|
58
|
+
#
|
59
|
+
# @version SketchUp 2015
|
60
|
+
def keys
|
61
|
+
end
|
62
|
+
|
63
|
+
# The {#length} method returns the number of loaded classification schemas.
|
64
|
+
#
|
65
|
+
# @example
|
66
|
+
# Sketchup.active_model.classifications.length
|
67
|
+
#
|
68
|
+
# @return [Integer]
|
69
|
+
#
|
70
|
+
# @see #size
|
71
|
+
#
|
72
|
+
# @version SketchUp 2015
|
73
|
+
def length
|
74
|
+
end
|
75
|
+
|
76
|
+
# The load_schema method is used to load a classification schema into a
|
77
|
+
# model.
|
78
|
+
#
|
79
|
+
# @example
|
80
|
+
# c = Sketchup.active_model.classifications
|
81
|
+
# file = Sketchup.find_support_file('IFC 4.skc', 'Classifications')
|
82
|
+
# status = c.load_schema(file) if !file.nil?
|
83
|
+
#
|
84
|
+
# @param file
|
85
|
+
# Full path to the schema file
|
86
|
+
#
|
87
|
+
# @return True if successful.
|
88
|
+
#
|
89
|
+
# @version SketchUp 2015
|
90
|
+
def load_schema(file)
|
91
|
+
end
|
92
|
+
|
93
|
+
# The {#size} method returns the number of loaded classification schemas.
|
94
|
+
#
|
95
|
+
# @example
|
96
|
+
# Sketchup.active_model.classifications.size
|
97
|
+
#
|
98
|
+
# @return [Integer]
|
99
|
+
#
|
100
|
+
# @see #length
|
101
|
+
#
|
102
|
+
# @version SketchUp 2015
|
103
|
+
def size
|
104
|
+
end
|
105
|
+
|
106
|
+
# The unload_schema method is used to unload a classification schema that was
|
107
|
+
# previously loaded into a model.
|
108
|
+
#
|
109
|
+
# @example
|
110
|
+
# c = Sketchup.active_model.classifications
|
111
|
+
# status = c.unload_schema('IFC 2x3')
|
112
|
+
#
|
113
|
+
# @param schema_name
|
114
|
+
# Name of the schema to unload
|
115
|
+
#
|
116
|
+
# @return True if successful.
|
117
|
+
#
|
118
|
+
# @version SketchUp 2015
|
119
|
+
def unload_schema(schema_name)
|
120
|
+
end
|
121
|
+
|
122
|
+
end
|