sketchup-api-stubs 0.7.4 → 0.7.5
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.rb +1 -1
- data/lib/sketchup-api-stubs/sketchup.rb +147 -145
- 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 +498 -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 +179 -174
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +515 -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 +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 +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 +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 +144 -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 +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 +577 -562
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +604 -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 +362 -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 +1126 -1119
- 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 +751 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +699 -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 +417 -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 +405 -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 +327 -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.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 -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 +478 -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 +257 -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 +835 -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 +71 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1307 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +317 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +387 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +255 -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 +351 -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 +1342 -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 +668 -667
- metadata +4 -2
@@ -1,63 +1,63 @@
|
|
1
|
-
# Copyright:: Copyright 2020 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
|
+
# Copyright:: Copyright 2020 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 2020 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
|
1
|
+
# Copyright:: Copyright 2020 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
|
@@ -1,281 +1,294 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The Color class is used to create and manipulate colors within SketchUp
|
5
|
-
# Models. The class can also be used the same way with LayOut documents.
|
6
|
-
#
|
7
|
-
# For methods that accept a Color object, such as the
|
8
|
-
# face.material method, you can pass in an actual Color object, or an object
|
9
|
-
# that can be converted to a Color. For example:
|
10
|
-
#
|
11
|
-
# SketchUp ships with several built in colors in the Materials Browser.
|
12
|
-
# These colors are listed in the following table.
|
13
|
-
# {include:file:assets/colors.html}
|
14
|
-
#
|
15
|
-
# @example
|
16
|
-
# face.material = Sketchup::Color.new(255, 0, 0)
|
17
|
-
# face.material = 255
|
18
|
-
# face.material = 0xff
|
19
|
-
# face.material = "red"
|
20
|
-
# face.material = "#ff0000"
|
21
|
-
# face.material = [1.0, 0.0, 0.0]
|
22
|
-
# face.material = [255, 0, 0]
|
23
|
-
#
|
24
|
-
# @version SketchUp 6.0
|
25
|
-
class Sketchup::Color
|
26
|
-
|
27
|
-
# Class Methods
|
28
|
-
|
29
|
-
# The {.names} method is used to retrieve an array of all color names
|
30
|
-
# recognized by SketchUp.
|
31
|
-
#
|
32
|
-
# In general, whenever a method wants a color, you can pass in a String with
|
33
|
-
# one of these names.
|
34
|
-
#
|
35
|
-
# @example
|
36
|
-
# array = Sketchup::Color.names
|
37
|
-
#
|
38
|
-
# @return [Array]
|
39
|
-
#
|
40
|
-
# @version SketchUp 6.0
|
41
|
-
def self.names
|
42
|
-
end
|
43
|
-
|
44
|
-
# Instance Methods
|
45
|
-
|
46
|
-
# The {#==} method checks to see if the two {Sketchup::Color}s are equal. This
|
47
|
-
# checks whether the RGBA values are the same. In versions prior to SketchUp
|
48
|
-
# 2018 two color objects with the same values would be considered different.
|
49
|
-
#
|
50
|
-
# @example
|
51
|
-
# SketchUp::Color.new(255, 255, 255) == Sketchup::Color.new(1.0, 1.0, 1.0)
|
52
|
-
#
|
53
|
-
# @param [Object] other
|
54
|
-
#
|
55
|
-
# @return [Boolean]
|
56
|
-
#
|
57
|
-
# @version SketchUp 2018
|
58
|
-
def ==(other)
|
59
|
-
end
|
60
|
-
|
61
|
-
# The {#alpha} method is used to retrieve the opacity of the color. A value of
|
62
|
-
# 0 is transparent, 255 is opaque.
|
63
|
-
#
|
64
|
-
# @example
|
65
|
-
# color = Sketchup::Color.new "OldLace"
|
66
|
-
# alpha = color.alpha
|
67
|
-
#
|
68
|
-
# @return [Integer]
|
69
|
-
#
|
70
|
-
# @version SketchUp 6.0
|
71
|
-
def alpha
|
72
|
-
end
|
73
|
-
|
74
|
-
# The {#alpha=} method is used to set the opacity of the color. A value of 0 is
|
75
|
-
# transparent, 255 is opaque.
|
76
|
-
#
|
77
|
-
# @example
|
78
|
-
# color = Sketchup::Color.new "AliceBlue"
|
79
|
-
# alpha = color.alpha = 255
|
80
|
-
#
|
81
|
-
# @param [Integer] alpha
|
82
|
-
# The new opacity value.
|
83
|
-
#
|
84
|
-
# @return [Integer]
|
85
|
-
#
|
86
|
-
# @version SketchUp 8.0 M1
|
87
|
-
def alpha=(alpha)
|
88
|
-
end
|
89
|
-
|
90
|
-
# The {#blend} method is used to blend two colors.
|
91
|
-
#
|
92
|
-
# The blended color will be the result of taking (1 - weight) * color1 +
|
93
|
-
# weight * color2. If weight = 0, you will get color2. If weight = 1 you will
|
94
|
-
# get color1.
|
95
|
-
#
|
96
|
-
# @example
|
97
|
-
# color1 = Sketchup::Color.new "OldLace"
|
98
|
-
# color2 = Sketchup::Color.new "AliceBlue"
|
99
|
-
# color3 = color1.blend color2, 0.5
|
100
|
-
#
|
101
|
-
# @param [Sketchup::Color] color2
|
102
|
-
# The second color to be blended
|
103
|
-
# (with this color).
|
104
|
-
#
|
105
|
-
# @param [Float] weight
|
106
|
-
# A Float between 0.0 and 1.0
|
107
|
-
#
|
108
|
-
# @return [Sketchup::Color]
|
109
|
-
#
|
110
|
-
# @version SketchUp 6.0
|
111
|
-
def blend(color2, weight)
|
112
|
-
end
|
113
|
-
|
114
|
-
# The {#blue} method is used to retrieve the blue value of a color.
|
115
|
-
#
|
116
|
-
# Value range is 0 to 255.
|
117
|
-
#
|
118
|
-
# @example
|
119
|
-
# color = Sketchup::Color.new "AliceBlue"
|
120
|
-
# blue = color.blue
|
121
|
-
#
|
122
|
-
# @return [Integer]
|
123
|
-
#
|
124
|
-
# @version SketchUp 6.0
|
125
|
-
def blue
|
126
|
-
end
|
127
|
-
|
128
|
-
# The {#blue=} method is used to set the blue value of a color.
|
129
|
-
#
|
130
|
-
# Value range is 0 to 255.
|
131
|
-
#
|
132
|
-
# @example
|
133
|
-
# color = Sketchup::Color.new "AliceBlue"
|
134
|
-
# blue = color.blue = 200
|
135
|
-
#
|
136
|
-
# @param [Integer] blue
|
137
|
-
# The blue value for the color.
|
138
|
-
#
|
139
|
-
# @return [Integer]
|
140
|
-
#
|
141
|
-
# @version SketchUp 6.0
|
142
|
-
def blue=(blue)
|
143
|
-
end
|
144
|
-
|
145
|
-
# The {#green} method is used to retrieve the green value of a color.
|
146
|
-
#
|
147
|
-
# Value range is 0 to 255.
|
148
|
-
#
|
149
|
-
# @example
|
150
|
-
# color = Sketchup::Color.new "AliceBlue"
|
151
|
-
# green = color.green
|
152
|
-
#
|
153
|
-
# @return [Integer]
|
154
|
-
#
|
155
|
-
# @version SketchUp 6.0
|
156
|
-
def green
|
157
|
-
end
|
158
|
-
|
159
|
-
# The {#green=} method is used to set the green component of a RGB Color.
|
160
|
-
#
|
161
|
-
# Value range is 0 to 255.
|
162
|
-
#
|
163
|
-
# @example
|
164
|
-
# color = Sketchup::Color.new "AliceBlue"
|
165
|
-
# green = color.green = 200
|
166
|
-
#
|
167
|
-
# @param [Integer] green
|
168
|
-
# The green value for the color.
|
169
|
-
#
|
170
|
-
# @return [Integer]
|
171
|
-
#
|
172
|
-
# @version SketchUp 6.0
|
173
|
-
def green=(green)
|
174
|
-
end
|
175
|
-
|
176
|
-
# The new method is used to create a new Color object.
|
177
|
-
#
|
178
|
-
# @example
|
179
|
-
# color_from_name = Sketchup::Color.new "OldLace"
|
180
|
-
# color_from_rgb = Sketchup::Color.new(0, 128, 255)
|
181
|
-
# color_from_rgba = Sketchup::Color.new(0, 128, 255, 128)
|
182
|
-
# color_from_hex = Sketchup::Color.new(0xFF0000)
|
183
|
-
#
|
184
|
-
# # You can then assign colors to the material of DrawingElements.
|
185
|
-
# # Note that this creates a new Material object, and the alpha value
|
186
|
-
# # of the color does NOT get applied to the new Material. You must
|
187
|
-
# # manually set the alpha to get transparent materials.
|
188
|
-
# face.material = color_from_rgba
|
189
|
-
# face.material.alpha = 0.5
|
190
|
-
#
|
191
|
-
# @
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
# @param [Integer]
|
196
|
-
# @param [Integer]
|
197
|
-
# @
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
203
|
-
# @param [
|
204
|
-
#
|
205
|
-
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
#
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
220
|
-
#
|
221
|
-
#
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
#
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
# @return [
|
251
|
-
#
|
252
|
-
# @version SketchUp 6.0
|
253
|
-
def
|
254
|
-
end
|
255
|
-
|
256
|
-
# The {#
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
#
|
270
|
-
#
|
271
|
-
# @example
|
272
|
-
# color = Sketchup::Color.new
|
273
|
-
#
|
274
|
-
#
|
275
|
-
# @return [
|
276
|
-
#
|
277
|
-
# @version SketchUp 6.0
|
278
|
-
def
|
279
|
-
end
|
280
|
-
|
281
|
-
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Color class is used to create and manipulate colors within SketchUp
|
5
|
+
# Models. The class can also be used the same way with LayOut documents.
|
6
|
+
#
|
7
|
+
# For methods that accept a Color object, such as the
|
8
|
+
# face.material method, you can pass in an actual Color object, or an object
|
9
|
+
# that can be converted to a Color. For example:
|
10
|
+
#
|
11
|
+
# SketchUp ships with several built in colors in the Materials Browser.
|
12
|
+
# These colors are listed in the following table.
|
13
|
+
# {include:file:assets/colors.html}
|
14
|
+
#
|
15
|
+
# @example
|
16
|
+
# face.material = Sketchup::Color.new(255, 0, 0)
|
17
|
+
# face.material = 255
|
18
|
+
# face.material = 0xff
|
19
|
+
# face.material = "red"
|
20
|
+
# face.material = "#ff0000"
|
21
|
+
# face.material = [1.0, 0.0, 0.0]
|
22
|
+
# face.material = [255, 0, 0]
|
23
|
+
#
|
24
|
+
# @version SketchUp 6.0
|
25
|
+
class Sketchup::Color
|
26
|
+
|
27
|
+
# Class Methods
|
28
|
+
|
29
|
+
# The {.names} method is used to retrieve an array of all color names
|
30
|
+
# recognized by SketchUp.
|
31
|
+
#
|
32
|
+
# In general, whenever a method wants a color, you can pass in a String with
|
33
|
+
# one of these names.
|
34
|
+
#
|
35
|
+
# @example
|
36
|
+
# array = Sketchup::Color.names
|
37
|
+
#
|
38
|
+
# @return [Array]
|
39
|
+
#
|
40
|
+
# @version SketchUp 6.0
|
41
|
+
def self.names
|
42
|
+
end
|
43
|
+
|
44
|
+
# Instance Methods
|
45
|
+
|
46
|
+
# The {#==} method checks to see if the two {Sketchup::Color}s are equal. This
|
47
|
+
# checks whether the RGBA values are the same. In versions prior to SketchUp
|
48
|
+
# 2018 two color objects with the same values would be considered different.
|
49
|
+
#
|
50
|
+
# @example
|
51
|
+
# SketchUp::Color.new(255, 255, 255) == Sketchup::Color.new(1.0, 1.0, 1.0)
|
52
|
+
#
|
53
|
+
# @param [Object] other
|
54
|
+
#
|
55
|
+
# @return [Boolean]
|
56
|
+
#
|
57
|
+
# @version SketchUp 2018
|
58
|
+
def ==(other)
|
59
|
+
end
|
60
|
+
|
61
|
+
# The {#alpha} method is used to retrieve the opacity of the color. A value of
|
62
|
+
# 0 is transparent, 255 is opaque.
|
63
|
+
#
|
64
|
+
# @example
|
65
|
+
# color = Sketchup::Color.new "OldLace"
|
66
|
+
# alpha = color.alpha
|
67
|
+
#
|
68
|
+
# @return [Integer]
|
69
|
+
#
|
70
|
+
# @version SketchUp 6.0
|
71
|
+
def alpha
|
72
|
+
end
|
73
|
+
|
74
|
+
# The {#alpha=} method is used to set the opacity of the color. A value of 0 is
|
75
|
+
# transparent, 255 is opaque.
|
76
|
+
#
|
77
|
+
# @example
|
78
|
+
# color = Sketchup::Color.new "AliceBlue"
|
79
|
+
# alpha = color.alpha = 255
|
80
|
+
#
|
81
|
+
# @param [Integer, Float] alpha
|
82
|
+
# The new opacity value.
|
83
|
+
#
|
84
|
+
# @return [Integer, Float]
|
85
|
+
#
|
86
|
+
# @version SketchUp 8.0 M1
|
87
|
+
def alpha=(alpha)
|
88
|
+
end
|
89
|
+
|
90
|
+
# The {#blend} method is used to blend two colors.
|
91
|
+
#
|
92
|
+
# The blended color will be the result of taking (1 - weight) * color1 +
|
93
|
+
# weight * color2. If weight = 0, you will get color2. If weight = 1 you will
|
94
|
+
# get color1.
|
95
|
+
#
|
96
|
+
# @example
|
97
|
+
# color1 = Sketchup::Color.new "OldLace"
|
98
|
+
# color2 = Sketchup::Color.new "AliceBlue"
|
99
|
+
# color3 = color1.blend color2, 0.5
|
100
|
+
#
|
101
|
+
# @param [Sketchup::Color] color2
|
102
|
+
# The second color to be blended
|
103
|
+
# (with this color).
|
104
|
+
#
|
105
|
+
# @param [Float] weight
|
106
|
+
# A Float between 0.0 and 1.0
|
107
|
+
#
|
108
|
+
# @return [Sketchup::Color]
|
109
|
+
#
|
110
|
+
# @version SketchUp 6.0
|
111
|
+
def blend(color2, weight)
|
112
|
+
end
|
113
|
+
|
114
|
+
# The {#blue} method is used to retrieve the blue value of a color.
|
115
|
+
#
|
116
|
+
# Value range is 0 to 255.
|
117
|
+
#
|
118
|
+
# @example
|
119
|
+
# color = Sketchup::Color.new "AliceBlue"
|
120
|
+
# blue = color.blue
|
121
|
+
#
|
122
|
+
# @return [Integer]
|
123
|
+
#
|
124
|
+
# @version SketchUp 6.0
|
125
|
+
def blue
|
126
|
+
end
|
127
|
+
|
128
|
+
# The {#blue=} method is used to set the blue value of a color.
|
129
|
+
#
|
130
|
+
# Value range is 0 to 255.
|
131
|
+
#
|
132
|
+
# @example
|
133
|
+
# color = Sketchup::Color.new "AliceBlue"
|
134
|
+
# blue = color.blue = 200
|
135
|
+
#
|
136
|
+
# @param [Integer, Float] blue
|
137
|
+
# The blue value for the color.
|
138
|
+
#
|
139
|
+
# @return [Integer, Float]
|
140
|
+
#
|
141
|
+
# @version SketchUp 6.0
|
142
|
+
def blue=(blue)
|
143
|
+
end
|
144
|
+
|
145
|
+
# The {#green} method is used to retrieve the green value of a color.
|
146
|
+
#
|
147
|
+
# Value range is 0 to 255.
|
148
|
+
#
|
149
|
+
# @example
|
150
|
+
# color = Sketchup::Color.new "AliceBlue"
|
151
|
+
# green = color.green
|
152
|
+
#
|
153
|
+
# @return [Integer]
|
154
|
+
#
|
155
|
+
# @version SketchUp 6.0
|
156
|
+
def green
|
157
|
+
end
|
158
|
+
|
159
|
+
# The {#green=} method is used to set the green component of a RGB Color.
|
160
|
+
#
|
161
|
+
# Value range is 0 to 255.
|
162
|
+
#
|
163
|
+
# @example
|
164
|
+
# color = Sketchup::Color.new "AliceBlue"
|
165
|
+
# green = color.green = 200
|
166
|
+
#
|
167
|
+
# @param [Integer, Float] green
|
168
|
+
# The green value for the color.
|
169
|
+
#
|
170
|
+
# @return [Integer, Float]
|
171
|
+
#
|
172
|
+
# @version SketchUp 6.0
|
173
|
+
def green=(green)
|
174
|
+
end
|
175
|
+
|
176
|
+
# The new method is used to create a new Color object.
|
177
|
+
#
|
178
|
+
# @example
|
179
|
+
# color_from_name = Sketchup::Color.new "OldLace"
|
180
|
+
# color_from_rgb = Sketchup::Color.new(0, 128, 255)
|
181
|
+
# color_from_rgba = Sketchup::Color.new(0, 128, 255, 128)
|
182
|
+
# color_from_hex = Sketchup::Color.new(0xFF0000)
|
183
|
+
#
|
184
|
+
# # You can then assign colors to the material of DrawingElements.
|
185
|
+
# # Note that this creates a new Material object, and the alpha value
|
186
|
+
# # of the color does NOT get applied to the new Material. You must
|
187
|
+
# # manually set the alpha to get transparent materials.
|
188
|
+
# face.material = color_from_rgba
|
189
|
+
# face.material.alpha = 0.5
|
190
|
+
#
|
191
|
+
# @overload initialize(red, green, blue, alpha = 255)
|
192
|
+
#
|
193
|
+
# @param [Integer] red A red value between 0 and 255.
|
194
|
+
# @param [Integer] green A green value between 0 and 255.
|
195
|
+
# @param [Integer] blue A blue value between 0 and 255.
|
196
|
+
# @param [Integer] alpha A alpha value between 0 and 255.
|
197
|
+
# @return [Sketchup::Color]
|
198
|
+
#
|
199
|
+
# @overload initialize(red, green, blue, alpha = 1.0)
|
200
|
+
#
|
201
|
+
# @param [Float] red A red value between 0.0 and 1.0.
|
202
|
+
# @param [Float] green A green value between 0.0 and 1.0.
|
203
|
+
# @param [Float] blue A blue value between 0.0 and 1.0.
|
204
|
+
# @param [Float] alpha A alpha value between 0.0 and 1.0.
|
205
|
+
# @return [Sketchup::Color]
|
206
|
+
#
|
207
|
+
# @overload initialize(name)
|
208
|
+
#
|
209
|
+
# @param [String] name A string name of a color that currently exists in
|
210
|
+
# SketchUp. See the table at the start of this class description for more
|
211
|
+
# info.
|
212
|
+
# @return [Sketchup::Color]
|
213
|
+
#
|
214
|
+
# @overload initialize(hex)
|
215
|
+
#
|
216
|
+
# @param [Integer] hex A hexadecimal color code.
|
217
|
+
# @return [Sketchup::Color]
|
218
|
+
# @note When assigning colors via a hexadecimal, R and B will be flipped.
|
219
|
+
# @note When assigning colors via a hexadecimal, Alpha is not supported.
|
220
|
+
#
|
221
|
+
# @version SketchUp 6.0
|
222
|
+
def initialize(*args)
|
223
|
+
end
|
224
|
+
|
225
|
+
# The {#red} method is used to retrieve the red component of a RGB Color.
|
226
|
+
#
|
227
|
+
# Value range is 0 to 255.
|
228
|
+
#
|
229
|
+
# @example
|
230
|
+
# color = Sketchup::Color.new "AliceBlue"
|
231
|
+
# red = color.red
|
232
|
+
#
|
233
|
+
# @return [Integer]
|
234
|
+
#
|
235
|
+
# @version SketchUp 6.0
|
236
|
+
def red
|
237
|
+
end
|
238
|
+
|
239
|
+
# The {#red=} method is used to set the red component of a RGB Color.
|
240
|
+
#
|
241
|
+
# Value range is 0 to 255.
|
242
|
+
#
|
243
|
+
# @example
|
244
|
+
# color = Sketchup::Color.new "AliceBlue"
|
245
|
+
# red = color.red=200
|
246
|
+
#
|
247
|
+
# @param [Integer, Float] red
|
248
|
+
# The red value for the color.
|
249
|
+
#
|
250
|
+
# @return [Integer, Float]
|
251
|
+
#
|
252
|
+
# @version SketchUp 6.0
|
253
|
+
def red=(red)
|
254
|
+
end
|
255
|
+
|
256
|
+
# The {#to_a} method is used to convert a Color object to an Array object. The
|
257
|
+
# returned array will contain 4 integer values (RGBA) between 0 and 255.
|
258
|
+
#
|
259
|
+
# @example
|
260
|
+
# color = Sketchup::Color.new "AliceBlue"
|
261
|
+
# color_array = color.to_a
|
262
|
+
#
|
263
|
+
# @return [Array]
|
264
|
+
#
|
265
|
+
# @version SketchUp 6.0
|
266
|
+
def to_a
|
267
|
+
end
|
268
|
+
|
269
|
+
# The {#to_i} method is used to convert a Color object to an 32 bit integer.
|
270
|
+
#
|
271
|
+
# @example
|
272
|
+
# color = Sketchup::Color.new "AliceBlue"
|
273
|
+
# integer = color.to_i
|
274
|
+
#
|
275
|
+
# @return [Integer]
|
276
|
+
#
|
277
|
+
# @version SketchUp 6.0
|
278
|
+
def to_i
|
279
|
+
end
|
280
|
+
|
281
|
+
# The {#to_s} method returns a string representation of the {Sketchup::Color}
|
282
|
+
# object, in the form of "Color(255, 255, 255, 255)".
|
283
|
+
#
|
284
|
+
# @example
|
285
|
+
# color = Sketchup::Color.new(255, 255, 255, 255)
|
286
|
+
# color_str = color.to_s
|
287
|
+
#
|
288
|
+
# @return [String]
|
289
|
+
#
|
290
|
+
# @version SketchUp 6.0
|
291
|
+
def to_s
|
292
|
+
end
|
293
|
+
|
294
|
+
end
|