sketchup-api-stubs 0.7.8 → 0.7.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/sketchup-api-stubs/sketchup.rb +151 -148
- data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
- 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 +509 -523
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -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 -693
- data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
- data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -698
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -516
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
- 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 -370
- 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 -225
- 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 -209
- 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/ReferenceEntity.rb +82 -0
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -692
- 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 +278 -278
- data/lib/sketchup-api-stubs/stubs/Numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -144
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -619
- 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 -201
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -426
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1205
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -272
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -937
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
- 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 -468
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -407
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -326
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
- 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 +114 -112
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1651
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -477
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
- 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 +255 -260
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -837
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1317
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1377 -1360
- 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/Command.rb +389 -389
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -496
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -635
- data/lib/sketchup-api-stubs/stubs/UI.rb +683 -683
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
- data/lib/sketchup-api-stubs.rb +1 -1
- metadata +10 -7
@@ -1,40 +1,40 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The {Sketchup::Skp} module is used to read metadata from external SketchUp
|
5
|
-
# files without loading the whole file.
|
6
|
-
#
|
7
|
-
# @version SketchUp 2021.0
|
8
|
-
module Sketchup::Skp
|
9
|
-
|
10
|
-
# Class Methods
|
11
|
-
|
12
|
-
# The {.read_guid} method is used to read the GUID, globally unique identifier,
|
13
|
-
# for an external model.
|
14
|
-
#
|
15
|
-
# In SketchUp, GUIDs are used to test if {Sketchup::ComponentDefinition}s and
|
16
|
-
# {Sketchup::Model}s match (a component being an embedded model).
|
17
|
-
# When you insert a component to a model, its GUID is compared to existing
|
18
|
-
# component definitions in that model, and if there is a match the existing
|
19
|
-
# component definition is re-used rather than a duplicate being added.
|
20
|
-
# When a component definition is modified or a model is saved, their GUIDs are
|
21
|
-
# renewed.
|
22
|
-
#
|
23
|
-
# @example
|
24
|
-
# model = Sketchup.active_model
|
25
|
-
# definitions = model.definitions
|
26
|
-
# definition = definitions.find { |definition| !definition.internal? }
|
27
|
-
# # true if component matches its external file.
|
28
|
-
# definition.guid == Sketchup::Skp.read_guid(definition.path)
|
29
|
-
#
|
30
|
-
# @param [String] filepath
|
31
|
-
#
|
32
|
-
# @raise [ArgumentError] if the file is missing or is not a SketchUp model.
|
33
|
-
#
|
34
|
-
# @return [String]
|
35
|
-
#
|
36
|
-
# @version SketchUp 2021.0
|
37
|
-
def self.read_guid(filepath)
|
38
|
-
end
|
39
|
-
|
40
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The {Sketchup::Skp} module is used to read metadata from external SketchUp
|
5
|
+
# files without loading the whole file.
|
6
|
+
#
|
7
|
+
# @version SketchUp 2021.0
|
8
|
+
module Sketchup::Skp
|
9
|
+
|
10
|
+
# Class Methods
|
11
|
+
|
12
|
+
# The {.read_guid} method is used to read the GUID, globally unique identifier,
|
13
|
+
# for an external model.
|
14
|
+
#
|
15
|
+
# In SketchUp, GUIDs are used to test if {Sketchup::ComponentDefinition}s and
|
16
|
+
# {Sketchup::Model}s match (a component being an embedded model).
|
17
|
+
# When you insert a component to a model, its GUID is compared to existing
|
18
|
+
# component definitions in that model, and if there is a match the existing
|
19
|
+
# component definition is re-used rather than a duplicate being added.
|
20
|
+
# When a component definition is modified or a model is saved, their GUIDs are
|
21
|
+
# renewed.
|
22
|
+
#
|
23
|
+
# @example
|
24
|
+
# model = Sketchup.active_model
|
25
|
+
# definitions = model.definitions
|
26
|
+
# definition = definitions.find { |definition| !definition.internal? }
|
27
|
+
# # true if component matches its external file.
|
28
|
+
# definition.guid == Sketchup::Skp.read_guid(definition.path)
|
29
|
+
#
|
30
|
+
# @param [String] filepath
|
31
|
+
#
|
32
|
+
# @raise [ArgumentError] if the file is missing or is not a SketchUp model.
|
33
|
+
#
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @version SketchUp 2021.0
|
37
|
+
def self.read_guid(filepath)
|
38
|
+
end
|
39
|
+
|
40
|
+
end
|
@@ -1,69 +1,69 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Style class contains methods for modifying information about a specific
|
5
|
-
# style. Styles are a collection of display settings that tell SketchUp how to
|
6
|
-
# draw the model.
|
7
|
-
#
|
8
|
-
# @example
|
9
|
-
# styles = Sketchup.active_model.styles
|
10
|
-
# puts "Your first style is named #{styles.first.name}"
|
11
|
-
#
|
12
|
-
# @version SketchUp 6.0
|
13
|
-
class Sketchup::Style < Sketchup::Entity
|
14
|
-
|
15
|
-
# Instance Methods
|
16
|
-
|
17
|
-
# The {#description} method gets the description for a {Sketchup::Style}.
|
18
|
-
#
|
19
|
-
# @example
|
20
|
-
# styles = Sketchup.active_model.styles
|
21
|
-
# style = styles.first
|
22
|
-
# puts "Your first style description is: #{style.description}"
|
23
|
-
#
|
24
|
-
# @return [String] description
|
25
|
-
#
|
26
|
-
# @version SketchUp 6.0
|
27
|
-
def description
|
28
|
-
end
|
29
|
-
|
30
|
-
# The {#description=} method sets the description for a {Sketchup::Style}.
|
31
|
-
#
|
32
|
-
# @example
|
33
|
-
# styles = Sketchup.active_model.styles
|
34
|
-
# style = styles.first
|
35
|
-
# style.description = "My new style description."
|
36
|
-
#
|
37
|
-
# @param [String] description
|
38
|
-
#
|
39
|
-
# @version SketchUp 6.0
|
40
|
-
def description=(description)
|
41
|
-
end
|
42
|
-
|
43
|
-
# The {#name} method gets the name for a {Sketchup::Style}.
|
44
|
-
#
|
45
|
-
# @example
|
46
|
-
# styles = Sketchup.active_model.styles
|
47
|
-
# style = styles.first
|
48
|
-
# name = style.name
|
49
|
-
#
|
50
|
-
# @return [String]
|
51
|
-
#
|
52
|
-
# @version SketchUp 6.0
|
53
|
-
def name
|
54
|
-
end
|
55
|
-
|
56
|
-
# The {#name=} method sets the name for a {Sketchup::Style}.
|
57
|
-
#
|
58
|
-
# @example
|
59
|
-
# styles = Sketchup.active_model.styles
|
60
|
-
# style = styles.first
|
61
|
-
# style.name = 'My Very Own Style'
|
62
|
-
#
|
63
|
-
# @param [String] name
|
64
|
-
#
|
65
|
-
# @version SketchUp 6.0
|
66
|
-
def name=(name)
|
67
|
-
end
|
68
|
-
|
69
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Style class contains methods for modifying information about a specific
|
5
|
+
# style. Styles are a collection of display settings that tell SketchUp how to
|
6
|
+
# draw the model.
|
7
|
+
#
|
8
|
+
# @example
|
9
|
+
# styles = Sketchup.active_model.styles
|
10
|
+
# puts "Your first style is named #{styles.first.name}"
|
11
|
+
#
|
12
|
+
# @version SketchUp 6.0
|
13
|
+
class Sketchup::Style < Sketchup::Entity
|
14
|
+
|
15
|
+
# Instance Methods
|
16
|
+
|
17
|
+
# The {#description} method gets the description for a {Sketchup::Style}.
|
18
|
+
#
|
19
|
+
# @example
|
20
|
+
# styles = Sketchup.active_model.styles
|
21
|
+
# style = styles.first
|
22
|
+
# puts "Your first style description is: #{style.description}"
|
23
|
+
#
|
24
|
+
# @return [String] description
|
25
|
+
#
|
26
|
+
# @version SketchUp 6.0
|
27
|
+
def description
|
28
|
+
end
|
29
|
+
|
30
|
+
# The {#description=} method sets the description for a {Sketchup::Style}.
|
31
|
+
#
|
32
|
+
# @example
|
33
|
+
# styles = Sketchup.active_model.styles
|
34
|
+
# style = styles.first
|
35
|
+
# style.description = "My new style description."
|
36
|
+
#
|
37
|
+
# @param [String] description
|
38
|
+
#
|
39
|
+
# @version SketchUp 6.0
|
40
|
+
def description=(description)
|
41
|
+
end
|
42
|
+
|
43
|
+
# The {#name} method gets the name for a {Sketchup::Style}.
|
44
|
+
#
|
45
|
+
# @example
|
46
|
+
# styles = Sketchup.active_model.styles
|
47
|
+
# style = styles.first
|
48
|
+
# name = style.name
|
49
|
+
#
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
# @version SketchUp 6.0
|
53
|
+
def name
|
54
|
+
end
|
55
|
+
|
56
|
+
# The {#name=} method sets the name for a {Sketchup::Style}.
|
57
|
+
#
|
58
|
+
# @example
|
59
|
+
# styles = Sketchup.active_model.styles
|
60
|
+
# style = styles.first
|
61
|
+
# style.name = 'My Very Own Style'
|
62
|
+
#
|
63
|
+
# @param [String] name
|
64
|
+
#
|
65
|
+
# @version SketchUp 6.0
|
66
|
+
def name=(name)
|
67
|
+
end
|
68
|
+
|
69
|
+
end
|
@@ -1,217 +1,217 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Styles class contains methods for manipulating a collection of styles in
|
5
|
-
# a model. Typically, you will access this via the active_model:
|
6
|
-
#
|
7
|
-
# @example
|
8
|
-
# styles = Sketchup.active_model.styles
|
9
|
-
# puts "There are #{styles.size} styles in your model."
|
10
|
-
#
|
11
|
-
# @version SketchUp 6.0
|
12
|
-
class Sketchup::Styles < Sketchup::Entity
|
13
|
-
|
14
|
-
# Includes
|
15
|
-
|
16
|
-
include Enumerable
|
17
|
-
|
18
|
-
# Instance Methods
|
19
|
-
|
20
|
-
# The {#[]} method is used to retrieves a style by either name or index.
|
21
|
-
#
|
22
|
-
# @example
|
23
|
-
# styles = Sketchup.active_model.styles
|
24
|
-
# style1 = styles[0]
|
25
|
-
# style2 = styles["MyStyle"]
|
26
|
-
#
|
27
|
-
# @overload [](name)
|
28
|
-
#
|
29
|
-
# @param [String] name The name of the style to retrieve.
|
30
|
-
# @return [Sketchup::Style, nil]
|
31
|
-
#
|
32
|
-
# @overload [](index)
|
33
|
-
#
|
34
|
-
# @param [Integer] index The index of the style to retrieve.
|
35
|
-
# @return [Sketchup::Style, nil]
|
36
|
-
#
|
37
|
-
# @version SketchUp 6.0
|
38
|
-
def [](arg)
|
39
|
-
end
|
40
|
-
|
41
|
-
# The {#active_style} method is used to retrieve the active style.
|
42
|
-
#
|
43
|
-
# While {#selected_style} is the style being selected in the Style Browser,
|
44
|
-
# the #{active_style} is a different object also including any unsaved style
|
45
|
-
# changes. These changes are silently dropped once a new style is selected.
|
46
|
-
# To save these changes to the selected style, call #{update_selected_style}.
|
47
|
-
#
|
48
|
-
# @example
|
49
|
-
# styles = Sketchup.active_model.styles
|
50
|
-
# style = styles.active_style
|
51
|
-
#
|
52
|
-
# @return [Sketchup::Style]
|
53
|
-
#
|
54
|
-
# @version SketchUp 6.0
|
55
|
-
def active_style
|
56
|
-
end
|
57
|
-
|
58
|
-
# The {#active_style_changed} method tells you if the active style has been
|
59
|
-
# edited by the user since it was last saved.
|
60
|
-
#
|
61
|
-
# @example
|
62
|
-
# styles = Sketchup.active_model.styles
|
63
|
-
# style_changed = styles.active_style_changed
|
64
|
-
#
|
65
|
-
# @return [Boolean]
|
66
|
-
#
|
67
|
-
# @version SketchUp 6.0
|
68
|
-
def active_style_changed
|
69
|
-
end
|
70
|
-
|
71
|
-
# The {#add_style} method is used to create and load a style from the given
|
72
|
-
# file.
|
73
|
-
#
|
74
|
-
# @example
|
75
|
-
# filename = File.expand_path('./MyStyle.style')
|
76
|
-
# styles = Sketchup.active_model.styles
|
77
|
-
# status = styles.add_style(filename, true)
|
78
|
-
#
|
79
|
-
# @param [String] filename
|
80
|
-
#
|
81
|
-
# @param [Boolean] select
|
82
|
-
# +true+ if you want to set the style to be the
|
83
|
-
# active style.
|
84
|
-
#
|
85
|
-
# @return [Boolean]
|
86
|
-
#
|
87
|
-
# @version SketchUp 6.0
|
88
|
-
def add_style(filename, select)
|
89
|
-
end
|
90
|
-
|
91
|
-
#
|
92
|
-
# @example
|
93
|
-
# styles = Sketchup.active_model.styles
|
94
|
-
# number = styles.count
|
95
|
-
#
|
96
|
-
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
97
|
-
# +Enumerable+ mix-in module. Prior to that the {#count} method is an alias
|
98
|
-
# for {#length}.
|
99
|
-
#
|
100
|
-
# @return [Integer]
|
101
|
-
#
|
102
|
-
# @version SketchUp 6.0
|
103
|
-
def count
|
104
|
-
end
|
105
|
-
|
106
|
-
# The {#each} method is used to iterate through styles.
|
107
|
-
#
|
108
|
-
# @example
|
109
|
-
# styles = Sketchup.active_model.styles
|
110
|
-
# styles.each { |style|
|
111
|
-
# puts style.name
|
112
|
-
# }
|
113
|
-
#
|
114
|
-
# @return [nil]
|
115
|
-
#
|
116
|
-
# @version SketchUp 6.0
|
117
|
-
#
|
118
|
-
# @yieldparam [Sketchup::Style] style
|
119
|
-
def each
|
120
|
-
end
|
121
|
-
|
122
|
-
# The {#length} method is an alias of {#size}.
|
123
|
-
#
|
124
|
-
# @example
|
125
|
-
# styles = Sketchup.active_model.styles
|
126
|
-
# number = styles.length
|
127
|
-
#
|
128
|
-
# @return [Integer]
|
129
|
-
#
|
130
|
-
# @see #size
|
131
|
-
#
|
132
|
-
# @version SketchUp 2014
|
133
|
-
def length
|
134
|
-
end
|
135
|
-
|
136
|
-
# The {#parent} method is used to return the model for the styles.
|
137
|
-
#
|
138
|
-
# @example
|
139
|
-
# styles = Sketchup.active_model.styles
|
140
|
-
# model = styles.parent
|
141
|
-
#
|
142
|
-
# @return [Sketchup::Model]
|
143
|
-
#
|
144
|
-
# @version SketchUp 6.0
|
145
|
-
def parent
|
146
|
-
end
|
147
|
-
|
148
|
-
# The {#purge_unused} method is used to remove unused styles from the model.
|
149
|
-
#
|
150
|
-
# @example
|
151
|
-
# styles = Sketchup.active_model.styles
|
152
|
-
# styles.purge_unused
|
153
|
-
#
|
154
|
-
# @return [true]
|
155
|
-
#
|
156
|
-
# @version SketchUp 6.0
|
157
|
-
def purge_unused
|
158
|
-
end
|
159
|
-
|
160
|
-
# The {#selected_style} method is used to retrieve the style currently
|
161
|
-
# selected in the Styles Browser.
|
162
|
-
#
|
163
|
-
# @example
|
164
|
-
# styles = Sketchup.active_model.styles
|
165
|
-
# style = styles.selected_style
|
166
|
-
#
|
167
|
-
# @return [Sketchup::Style] style
|
168
|
-
#
|
169
|
-
# @version SketchUp 6.0
|
170
|
-
def selected_style
|
171
|
-
end
|
172
|
-
|
173
|
-
# The {#selected_style=} method is used to set the currently selected style.
|
174
|
-
#
|
175
|
-
# @example
|
176
|
-
# styles = Sketchup.active_model.styles
|
177
|
-
# styles.selected_style = styles.last
|
178
|
-
#
|
179
|
-
# @param [Sketchup::Style] style
|
180
|
-
#
|
181
|
-
# @return [false]
|
182
|
-
#
|
183
|
-
# @version SketchUp 6.0
|
184
|
-
def selected_style=(style)
|
185
|
-
end
|
186
|
-
|
187
|
-
# The {#size} method is used to retrieve the number of styles in the
|
188
|
-
# collection.
|
189
|
-
#
|
190
|
-
# @example
|
191
|
-
# styles = Sketchup.active_model.styles
|
192
|
-
# number = styles.size
|
193
|
-
#
|
194
|
-
# @return [Integer]
|
195
|
-
#
|
196
|
-
# @see #length
|
197
|
-
#
|
198
|
-
# @version SketchUp 6.0
|
199
|
-
def size
|
200
|
-
end
|
201
|
-
|
202
|
-
# The {#update_selected_style} method commits the current style settings to the
|
203
|
-
# style selected in the Style Browser.
|
204
|
-
#
|
205
|
-
# @example
|
206
|
-
# styles = Sketchup.active_model.styles
|
207
|
-
# styles.update_selected_style
|
208
|
-
#
|
209
|
-
# @return [true]
|
210
|
-
#
|
211
|
-
# @see #selected_style
|
212
|
-
#
|
213
|
-
# @version SketchUp 6.0
|
214
|
-
def update_selected_style
|
215
|
-
end
|
216
|
-
|
217
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Styles class contains methods for manipulating a collection of styles in
|
5
|
+
# a model. Typically, you will access this via the active_model:
|
6
|
+
#
|
7
|
+
# @example
|
8
|
+
# styles = Sketchup.active_model.styles
|
9
|
+
# puts "There are #{styles.size} styles in your model."
|
10
|
+
#
|
11
|
+
# @version SketchUp 6.0
|
12
|
+
class Sketchup::Styles < Sketchup::Entity
|
13
|
+
|
14
|
+
# Includes
|
15
|
+
|
16
|
+
include Enumerable
|
17
|
+
|
18
|
+
# Instance Methods
|
19
|
+
|
20
|
+
# The {#[]} method is used to retrieves a style by either name or index.
|
21
|
+
#
|
22
|
+
# @example
|
23
|
+
# styles = Sketchup.active_model.styles
|
24
|
+
# style1 = styles[0]
|
25
|
+
# style2 = styles["MyStyle"]
|
26
|
+
#
|
27
|
+
# @overload [](name)
|
28
|
+
#
|
29
|
+
# @param [String] name The name of the style to retrieve.
|
30
|
+
# @return [Sketchup::Style, nil]
|
31
|
+
#
|
32
|
+
# @overload [](index)
|
33
|
+
#
|
34
|
+
# @param [Integer] index The index of the style to retrieve.
|
35
|
+
# @return [Sketchup::Style, nil]
|
36
|
+
#
|
37
|
+
# @version SketchUp 6.0
|
38
|
+
def [](arg)
|
39
|
+
end
|
40
|
+
|
41
|
+
# The {#active_style} method is used to retrieve the active style.
|
42
|
+
#
|
43
|
+
# While {#selected_style} is the style being selected in the Style Browser,
|
44
|
+
# the #{active_style} is a different object also including any unsaved style
|
45
|
+
# changes. These changes are silently dropped once a new style is selected.
|
46
|
+
# To save these changes to the selected style, call #{update_selected_style}.
|
47
|
+
#
|
48
|
+
# @example
|
49
|
+
# styles = Sketchup.active_model.styles
|
50
|
+
# style = styles.active_style
|
51
|
+
#
|
52
|
+
# @return [Sketchup::Style]
|
53
|
+
#
|
54
|
+
# @version SketchUp 6.0
|
55
|
+
def active_style
|
56
|
+
end
|
57
|
+
|
58
|
+
# The {#active_style_changed} method tells you if the active style has been
|
59
|
+
# edited by the user since it was last saved.
|
60
|
+
#
|
61
|
+
# @example
|
62
|
+
# styles = Sketchup.active_model.styles
|
63
|
+
# style_changed = styles.active_style_changed
|
64
|
+
#
|
65
|
+
# @return [Boolean]
|
66
|
+
#
|
67
|
+
# @version SketchUp 6.0
|
68
|
+
def active_style_changed
|
69
|
+
end
|
70
|
+
|
71
|
+
# The {#add_style} method is used to create and load a style from the given
|
72
|
+
# file.
|
73
|
+
#
|
74
|
+
# @example
|
75
|
+
# filename = File.expand_path('./MyStyle.style')
|
76
|
+
# styles = Sketchup.active_model.styles
|
77
|
+
# status = styles.add_style(filename, true)
|
78
|
+
#
|
79
|
+
# @param [String] filename
|
80
|
+
#
|
81
|
+
# @param [Boolean] select
|
82
|
+
# +true+ if you want to set the style to be the
|
83
|
+
# active style.
|
84
|
+
#
|
85
|
+
# @return [Boolean]
|
86
|
+
#
|
87
|
+
# @version SketchUp 6.0
|
88
|
+
def add_style(filename, select)
|
89
|
+
end
|
90
|
+
|
91
|
+
#
|
92
|
+
# @example
|
93
|
+
# styles = Sketchup.active_model.styles
|
94
|
+
# number = styles.count
|
95
|
+
#
|
96
|
+
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
97
|
+
# +Enumerable+ mix-in module. Prior to that the {#count} method is an alias
|
98
|
+
# for {#length}.
|
99
|
+
#
|
100
|
+
# @return [Integer]
|
101
|
+
#
|
102
|
+
# @version SketchUp 6.0
|
103
|
+
def count
|
104
|
+
end
|
105
|
+
|
106
|
+
# The {#each} method is used to iterate through styles.
|
107
|
+
#
|
108
|
+
# @example
|
109
|
+
# styles = Sketchup.active_model.styles
|
110
|
+
# styles.each { |style|
|
111
|
+
# puts style.name
|
112
|
+
# }
|
113
|
+
#
|
114
|
+
# @return [nil]
|
115
|
+
#
|
116
|
+
# @version SketchUp 6.0
|
117
|
+
#
|
118
|
+
# @yieldparam [Sketchup::Style] style
|
119
|
+
def each
|
120
|
+
end
|
121
|
+
|
122
|
+
# The {#length} method is an alias of {#size}.
|
123
|
+
#
|
124
|
+
# @example
|
125
|
+
# styles = Sketchup.active_model.styles
|
126
|
+
# number = styles.length
|
127
|
+
#
|
128
|
+
# @return [Integer]
|
129
|
+
#
|
130
|
+
# @see #size
|
131
|
+
#
|
132
|
+
# @version SketchUp 2014
|
133
|
+
def length
|
134
|
+
end
|
135
|
+
|
136
|
+
# The {#parent} method is used to return the model for the styles.
|
137
|
+
#
|
138
|
+
# @example
|
139
|
+
# styles = Sketchup.active_model.styles
|
140
|
+
# model = styles.parent
|
141
|
+
#
|
142
|
+
# @return [Sketchup::Model]
|
143
|
+
#
|
144
|
+
# @version SketchUp 6.0
|
145
|
+
def parent
|
146
|
+
end
|
147
|
+
|
148
|
+
# The {#purge_unused} method is used to remove unused styles from the model.
|
149
|
+
#
|
150
|
+
# @example
|
151
|
+
# styles = Sketchup.active_model.styles
|
152
|
+
# styles.purge_unused
|
153
|
+
#
|
154
|
+
# @return [true]
|
155
|
+
#
|
156
|
+
# @version SketchUp 6.0
|
157
|
+
def purge_unused
|
158
|
+
end
|
159
|
+
|
160
|
+
# The {#selected_style} method is used to retrieve the style currently
|
161
|
+
# selected in the Styles Browser.
|
162
|
+
#
|
163
|
+
# @example
|
164
|
+
# styles = Sketchup.active_model.styles
|
165
|
+
# style = styles.selected_style
|
166
|
+
#
|
167
|
+
# @return [Sketchup::Style] style
|
168
|
+
#
|
169
|
+
# @version SketchUp 6.0
|
170
|
+
def selected_style
|
171
|
+
end
|
172
|
+
|
173
|
+
# The {#selected_style=} method is used to set the currently selected style.
|
174
|
+
#
|
175
|
+
# @example
|
176
|
+
# styles = Sketchup.active_model.styles
|
177
|
+
# styles.selected_style = styles.last
|
178
|
+
#
|
179
|
+
# @param [Sketchup::Style] style
|
180
|
+
#
|
181
|
+
# @return [false]
|
182
|
+
#
|
183
|
+
# @version SketchUp 6.0
|
184
|
+
def selected_style=(style)
|
185
|
+
end
|
186
|
+
|
187
|
+
# The {#size} method is used to retrieve the number of styles in the
|
188
|
+
# collection.
|
189
|
+
#
|
190
|
+
# @example
|
191
|
+
# styles = Sketchup.active_model.styles
|
192
|
+
# number = styles.size
|
193
|
+
#
|
194
|
+
# @return [Integer]
|
195
|
+
#
|
196
|
+
# @see #length
|
197
|
+
#
|
198
|
+
# @version SketchUp 6.0
|
199
|
+
def size
|
200
|
+
end
|
201
|
+
|
202
|
+
# The {#update_selected_style} method commits the current style settings to the
|
203
|
+
# style selected in the Style Browser.
|
204
|
+
#
|
205
|
+
# @example
|
206
|
+
# styles = Sketchup.active_model.styles
|
207
|
+
# styles.update_selected_style
|
208
|
+
#
|
209
|
+
# @return [true]
|
210
|
+
#
|
211
|
+
# @see #selected_style
|
212
|
+
#
|
213
|
+
# @version SketchUp 6.0
|
214
|
+
def update_selected_style
|
215
|
+
end
|
216
|
+
|
217
|
+
end
|