sketchup-api-stubs 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/SketchUp/Geom/BoundingBox.rb +335 -0
- data/SketchUp/Geom/LatLong.rb +123 -0
- data/SketchUp/Geom/Point3d.rb +643 -0
- data/SketchUp/Geom/PolygonMesh.rb +478 -0
- data/SketchUp/Geom/Transformation.rb +476 -0
- data/SketchUp/Geom/UTM.rb +135 -0
- data/SketchUp/Geom/Vector3d.rb +684 -0
- data/SketchUp/Sketchup/Animation.rb +137 -0
- data/SketchUp/Sketchup/AppObserver.rb +157 -0
- data/SketchUp/Sketchup/ArcCurve.rb +209 -0
- data/SketchUp/Sketchup/AttributeDictionaries.rb +146 -0
- data/SketchUp/Sketchup/AttributeDictionary.rb +280 -0
- data/SketchUp/Sketchup/Axes.rb +149 -0
- data/SketchUp/Sketchup/Behavior.rb +338 -0
- data/SketchUp/Sketchup/Camera.rb +594 -0
- data/SketchUp/Sketchup/ClassificationSchema.rb +63 -0
- data/SketchUp/Sketchup/Classifications.rb +118 -0
- data/SketchUp/Sketchup/Color.rb +291 -0
- data/SketchUp/Sketchup/ComponentDefinition.rb +562 -0
- data/SketchUp/Sketchup/ComponentInstance.rb +597 -0
- data/SketchUp/Sketchup/Console.rb +78 -0
- data/SketchUp/Sketchup/ConstructionLine.rb +257 -0
- data/SketchUp/Sketchup/ConstructionPoint.rb +32 -0
- data/SketchUp/Sketchup/Curve.rb +196 -0
- data/SketchUp/Sketchup/DefinitionList.rb +312 -0
- data/SketchUp/Sketchup/DefinitionObserver.rb +73 -0
- data/SketchUp/Sketchup/DefinitionsObserver.rb +102 -0
- data/SketchUp/Sketchup/Dimension.rb +167 -0
- data/SketchUp/Sketchup/DimensionLinear.rb +232 -0
- data/SketchUp/Sketchup/DimensionObserver.rb +38 -0
- data/SketchUp/Sketchup/DimensionRadial.rb +87 -0
- data/SketchUp/Sketchup/Drawingelement.rb +400 -0
- data/SketchUp/Sketchup/Edge.rb +517 -0
- data/SketchUp/Sketchup/EdgeUse.rb +213 -0
- data/SketchUp/Sketchup/Entities.rb +1011 -0
- data/SketchUp/Sketchup/EntitiesObserver.rb +125 -0
- data/SketchUp/Sketchup/Entity.rb +522 -0
- data/SketchUp/Sketchup/EntityObserver.rb +59 -0
- data/SketchUp/Sketchup/ExtensionsManager.rb +129 -0
- data/SketchUp/Sketchup/Face.rb +737 -0
- data/SketchUp/Sketchup/FrameChangeObserver.rb +104 -0
- data/SketchUp/Sketchup/Group.rb +705 -0
- data/SketchUp/Sketchup/Http.rb +27 -0
- data/SketchUp/Sketchup/Http/Request.rb +285 -0
- data/SketchUp/Sketchup/Http/Response.rb +62 -0
- data/SketchUp/Sketchup/Image.rb +393 -0
- data/SketchUp/Sketchup/Importer.rb +192 -0
- data/SketchUp/Sketchup/InputPoint.rb +393 -0
- data/SketchUp/Sketchup/InstanceObserver.rb +82 -0
- data/SketchUp/Sketchup/InstancePath.rb +297 -0
- data/SketchUp/Sketchup/Layer.rb +240 -0
- data/SketchUp/Sketchup/Layers.rb +235 -0
- data/SketchUp/Sketchup/LayersObserver.rb +136 -0
- data/SketchUp/Sketchup/Licensing.rb +47 -0
- data/SketchUp/Sketchup/Licensing/ExtensionLicense.rb +88 -0
- data/SketchUp/Sketchup/Loop.rb +141 -0
- data/SketchUp/Sketchup/Material.rb +384 -0
- data/SketchUp/Sketchup/Materials.rb +283 -0
- data/SketchUp/Sketchup/MaterialsObserver.rb +141 -0
- data/SketchUp/Sketchup/Menu.rb +97 -0
- data/SketchUp/Sketchup/Model.rb +1459 -0
- data/SketchUp/Sketchup/ModelObserver.rb +356 -0
- data/SketchUp/Sketchup/OptionsManager.rb +135 -0
- data/SketchUp/Sketchup/OptionsProvider.rb +277 -0
- data/SketchUp/Sketchup/OptionsProviderObserver.rb +58 -0
- data/SketchUp/Sketchup/Page.rb +636 -0
- data/SketchUp/Sketchup/Pages.rb +349 -0
- data/SketchUp/Sketchup/PagesObserver.rb +76 -0
- data/SketchUp/Sketchup/PickHelper.rb +457 -0
- data/SketchUp/Sketchup/RegionalSettings.rb +43 -0
- data/SketchUp/Sketchup/RenderingOptions.rb +337 -0
- data/SketchUp/Sketchup/RenderingOptionsObserver.rb +44 -0
- data/SketchUp/Sketchup/SectionPlane.rb +88 -0
- data/SketchUp/Sketchup/Selection.rb +470 -0
- data/SketchUp/Sketchup/SelectionObserver.rb +115 -0
- data/SketchUp/Sketchup/Set.rb +253 -0
- data/SketchUp/Sketchup/ShadowInfo.rb +257 -0
- data/SketchUp/Sketchup/ShadowInfoObserver.rb +57 -0
- data/SketchUp/Sketchup/Style.rb +77 -0
- data/SketchUp/Sketchup/Styles.rb +204 -0
- data/SketchUp/Sketchup/Text.rb +241 -0
- data/SketchUp/Sketchup/Texture.rb +211 -0
- data/SketchUp/Sketchup/TextureWriter.rb +237 -0
- data/SketchUp/Sketchup/Tool.rb +808 -0
- data/SketchUp/Sketchup/Tools.rb +120 -0
- data/SketchUp/Sketchup/ToolsObserver.rb +154 -0
- data/SketchUp/Sketchup/UVHelper.rb +61 -0
- data/SketchUp/Sketchup/Vertex.rb +143 -0
- data/SketchUp/Sketchup/View.rb +965 -0
- data/SketchUp/Sketchup/ViewObserver.rb +40 -0
- data/SketchUp/UI/Command.rb +307 -0
- data/SketchUp/UI/HtmlDialog.rb +346 -0
- data/SketchUp/UI/Notification.rb +229 -0
- data/SketchUp/UI/Toolbar.rb +243 -0
- data/SketchUp/UI/WebDialog.rb +623 -0
- data/SketchUp/_top_level.rb +193 -0
- data/SketchUp/array.rb +593 -0
- data/SketchUp/geom.rb +231 -0
- data/SketchUp/languagehandler.rb +92 -0
- data/SketchUp/length.rb +210 -0
- data/SketchUp/numeric.rb +249 -0
- data/SketchUp/sketchup.rb +1290 -0
- data/SketchUp/sketchupextension.rb +355 -0
- data/SketchUp/string.rb +24 -0
- data/SketchUp/ui.rb +637 -0
- metadata +176 -0
@@ -0,0 +1,235 @@
|
|
1
|
+
# Copyright:: Copyright 2017 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Layers collection allows you to see and manage all of the layers in a
|
5
|
+
# model. You get a pointer to the Layers object from within the Model.
|
6
|
+
#
|
7
|
+
# @example
|
8
|
+
# model = Sketchup.active_model
|
9
|
+
# layers = model.layers
|
10
|
+
#
|
11
|
+
# @version SketchUp 6.0
|
12
|
+
class Sketchup::Layers < Sketchup::Entity
|
13
|
+
|
14
|
+
# Includes
|
15
|
+
|
16
|
+
include Enumerable
|
17
|
+
|
18
|
+
# Instance Methods
|
19
|
+
|
20
|
+
# The [] method is used to retrieve a layer by index or name.
|
21
|
+
#
|
22
|
+
# The {#at} method is an alias for {#[]}.
|
23
|
+
#
|
24
|
+
# @example
|
25
|
+
# model = Sketchup.active_model
|
26
|
+
# layers = model.layers
|
27
|
+
# new_layer = layers.add "test layer"
|
28
|
+
# layer_by_number = layers[1]
|
29
|
+
# layer_by_name = layers["test layer"]
|
30
|
+
#
|
31
|
+
# @param index_or_name
|
32
|
+
# A number representing the layer's index in an array of
|
33
|
+
# Layer objects, or the name of the layer.
|
34
|
+
#
|
35
|
+
# @return layer - a Layer object
|
36
|
+
#
|
37
|
+
# @version SketchUp 6.0
|
38
|
+
def [](index_or_name)
|
39
|
+
end
|
40
|
+
|
41
|
+
# The add method is used to add a new layer.
|
42
|
+
#
|
43
|
+
# If you give the name of a Layer that is already defined, it will return the
|
44
|
+
# existing Layer rather than adding a new one.
|
45
|
+
#
|
46
|
+
# @example
|
47
|
+
# layers = Sketchup.active_model.layers
|
48
|
+
# layer = layers.add("Test Layer")
|
49
|
+
#
|
50
|
+
# @param layer_name
|
51
|
+
# The name of the added layer.
|
52
|
+
#
|
53
|
+
# @return layer - the new Layer object
|
54
|
+
#
|
55
|
+
# @version SketchUp 6.0
|
56
|
+
def add(layer_name)
|
57
|
+
end
|
58
|
+
|
59
|
+
# The add_observer method is used to add an observer to the layers collection.
|
60
|
+
#
|
61
|
+
# @example
|
62
|
+
# layers = Sketchup.active_model.layers
|
63
|
+
# status = layers.add_observer observer
|
64
|
+
#
|
65
|
+
# @param observer
|
66
|
+
# An observer.
|
67
|
+
#
|
68
|
+
# @return success - true if successful, false if unsuccessful.
|
69
|
+
#
|
70
|
+
# @version SketchUp 6.0
|
71
|
+
def add_observer(observer)
|
72
|
+
end
|
73
|
+
|
74
|
+
# The [] method is used to retrieve a layer by index or name.
|
75
|
+
#
|
76
|
+
# The {#at} method is an alias for {#[]}.
|
77
|
+
#
|
78
|
+
# @example
|
79
|
+
# model = Sketchup.active_model
|
80
|
+
# layers = model.layers
|
81
|
+
# new_layer = layers.add "test layer"
|
82
|
+
# layer_by_number = layers[1]
|
83
|
+
# layer_by_name = layers["test layer"]
|
84
|
+
#
|
85
|
+
# @param index_or_name
|
86
|
+
# A number representing the layer's index in an array of
|
87
|
+
# Layer objects, or the name of the layer.
|
88
|
+
#
|
89
|
+
# @return layer - a Layer object
|
90
|
+
#
|
91
|
+
# @version SketchUp 6.0
|
92
|
+
def at(index_or_name)
|
93
|
+
end
|
94
|
+
|
95
|
+
#
|
96
|
+
# @example
|
97
|
+
# layers = Sketchup.active_model.layers
|
98
|
+
# number = layers.count
|
99
|
+
#
|
100
|
+
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
101
|
+
# +Enumable+ mix-in module. Prior to that the {#count} method is an alias
|
102
|
+
# for {#length}.
|
103
|
+
#
|
104
|
+
# @return integer - the number of layers in the collection
|
105
|
+
#
|
106
|
+
# @see #length
|
107
|
+
#
|
108
|
+
# @version SketchUp 6.0
|
109
|
+
def count
|
110
|
+
end
|
111
|
+
|
112
|
+
# The each method is used to iterate through all of the layers.
|
113
|
+
#
|
114
|
+
# @example
|
115
|
+
# model = Sketchup.active_model
|
116
|
+
# layers = model.layers
|
117
|
+
# layers.add("test layer")
|
118
|
+
# layers.each { | layer | puts layer.name }
|
119
|
+
#
|
120
|
+
# @version SketchUp 6.0
|
121
|
+
#
|
122
|
+
# @yield [layer] - a variable that will hold each Layer object as they are found.
|
123
|
+
def each
|
124
|
+
end
|
125
|
+
|
126
|
+
# The {#length} method retrieves the number of layers.
|
127
|
+
#
|
128
|
+
# The {#size} method is an alias for {#length} added in SketchUp 2014.
|
129
|
+
#
|
130
|
+
# @example
|
131
|
+
# layers = Sketchup.active_model.layers
|
132
|
+
# number = layers.length
|
133
|
+
#
|
134
|
+
# @return integer - the number of layers in the collection
|
135
|
+
#
|
136
|
+
# @version SketchUp 6.0
|
137
|
+
def length
|
138
|
+
end
|
139
|
+
|
140
|
+
# The purged_unused method is used to remove unused layers.
|
141
|
+
#
|
142
|
+
# @example
|
143
|
+
# layers = Sketchup.active_model.layers
|
144
|
+
# status = layers.purge_unused
|
145
|
+
#
|
146
|
+
# @return success - true if successful, false if unsuccessful.
|
147
|
+
#
|
148
|
+
# @version SketchUp 6.0
|
149
|
+
def purge_unused
|
150
|
+
end
|
151
|
+
|
152
|
+
# Remove the given layer from the model, optionally removing the geometry.
|
153
|
+
#
|
154
|
+
# @example
|
155
|
+
# # Remove layer by layer reference.
|
156
|
+
# layer = Sketchup.active_model.layers.add("MyLayer")
|
157
|
+
# Sketchup.active_model.layers.remove(layer)
|
158
|
+
#
|
159
|
+
# # Remove layer by name.
|
160
|
+
# Sketchup.active_model.layers.add("MyLayer")
|
161
|
+
# Sketchup.active_model.layers.remove("MyLayer")
|
162
|
+
#
|
163
|
+
# # Remove layer by index.
|
164
|
+
# Sketchup.active_model.layers.remove(1)
|
165
|
+
#
|
166
|
+
# # Remove layer and the entities on the layer.
|
167
|
+
# edge = Sketchup.active_model.entities.add_line([0, 0, 0], [9, 9, 9])
|
168
|
+
# edge.layer = Sketchup.active_model.layers.add("MyLayer")
|
169
|
+
# Sketchup.active_model.layers.remove("MyLayer", true)
|
170
|
+
#
|
171
|
+
# @param layer
|
172
|
+
# Integer index, String name or Layer
|
173
|
+
#
|
174
|
+
# @param remove_geometry
|
175
|
+
# Boolean - If true, geometry in the removed layer will
|
176
|
+
# be removed as well. If false (which is the default),
|
177
|
+
# this geometry will be placed on Layer 0.
|
178
|
+
#
|
179
|
+
# @return boolean - true if successful, false if unsuccessful.
|
180
|
+
#
|
181
|
+
# @version SketchUp 2015
|
182
|
+
def remove(layer, remove_geometry = false)
|
183
|
+
end
|
184
|
+
|
185
|
+
# The remove_observer method is used to remove an observer from the current
|
186
|
+
# object.
|
187
|
+
#
|
188
|
+
# @example
|
189
|
+
# layers = Sketchup.active_model.layers
|
190
|
+
# status = layers.remove_observer observer
|
191
|
+
#
|
192
|
+
# @param observer
|
193
|
+
# An observer.
|
194
|
+
#
|
195
|
+
# @return success - true if successful, false if unsuccessful.
|
196
|
+
#
|
197
|
+
# @version SketchUp 6.0
|
198
|
+
def remove_observer(observer)
|
199
|
+
end
|
200
|
+
|
201
|
+
# The {#length} method retrieves the number of layers.
|
202
|
+
#
|
203
|
+
# The {#size} method is an alias for {#length} added in SketchUp 2014.
|
204
|
+
#
|
205
|
+
# @example
|
206
|
+
# layers = Sketchup.active_model.layers
|
207
|
+
# number = layers.length
|
208
|
+
#
|
209
|
+
# @return integer - the number of layers in the collection
|
210
|
+
#
|
211
|
+
# @version SketchUp 6.0
|
212
|
+
def size
|
213
|
+
end
|
214
|
+
|
215
|
+
# The unique_name method can be used to get a string that will be a unique
|
216
|
+
# layer name inside this collection.
|
217
|
+
#
|
218
|
+
# @example
|
219
|
+
# model = Sketchup.active_model
|
220
|
+
# layers = model.layers
|
221
|
+
# # Will return "Joe" since there are probably no other layers named that.
|
222
|
+
# # Or might return something like "Joe #2" if there is already a layer
|
223
|
+
# # named Joe.
|
224
|
+
# good_name = layers.unique_name "Joe"
|
225
|
+
#
|
226
|
+
# @param [optional] base_name
|
227
|
+
# The base name to build the unique name from.
|
228
|
+
#
|
229
|
+
# @return name - the unique name
|
230
|
+
#
|
231
|
+
# @version SketchUp 6.0
|
232
|
+
def unique_name(base_name)
|
233
|
+
end
|
234
|
+
|
235
|
+
end
|
@@ -0,0 +1,136 @@
|
|
1
|
+
# Copyright:: Copyright 2017 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to layers events. To
|
5
|
+
# implement this observer, create a Ruby class of this type, override the
|
6
|
+
# desired methods, and add an instance of the observer to the objects of
|
7
|
+
# interests.
|
8
|
+
#
|
9
|
+
# @example
|
10
|
+
# class MyLayersObserver < Sketchup::LayersObserver
|
11
|
+
# def onLayerAdded(layers, layer)
|
12
|
+
# puts "onLayerAdded: #{layer.name}"
|
13
|
+
# end
|
14
|
+
# end
|
15
|
+
#
|
16
|
+
# Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
|
17
|
+
# Sketchup.active_model.layers.add("Hello World")
|
18
|
+
#
|
19
|
+
# @version SketchUp 6.0
|
20
|
+
class Sketchup::LayersObserver
|
21
|
+
|
22
|
+
# Instance Methods
|
23
|
+
|
24
|
+
# The {#onCurrentLayerChanged} method is called when the user selects a
|
25
|
+
# different active layer.
|
26
|
+
#
|
27
|
+
# @example
|
28
|
+
# class MyLayersObserver < Sketchup::LayersObserver
|
29
|
+
# def onCurrentLayerChanged(layers, layer)
|
30
|
+
# puts "onCurrentLayerChanged: #{layer.name}"
|
31
|
+
# end
|
32
|
+
# end
|
33
|
+
#
|
34
|
+
# Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
|
35
|
+
# layer = Sketchup.active_model.layers.add("Hello World")
|
36
|
+
# Sketchup.active_model.active_layer = layer
|
37
|
+
#
|
38
|
+
# @param [Sketchup::Layers] layers
|
39
|
+
#
|
40
|
+
# @param [Sketchup::Layer] layer
|
41
|
+
#
|
42
|
+
# @return [nil]
|
43
|
+
#
|
44
|
+
# @version SketchUp 6.0
|
45
|
+
def onCurrentLayerChanged(layers, layer)
|
46
|
+
end
|
47
|
+
|
48
|
+
# The {#onLayerAdded} method is called when a new layer is added to a model.
|
49
|
+
#
|
50
|
+
# @example
|
51
|
+
# class MyLayersObserver < Sketchup::LayersObserver
|
52
|
+
# def onLayerAdded(layers, layer)
|
53
|
+
# puts "onLayerAdded: #{layer.name}"
|
54
|
+
# end
|
55
|
+
# end
|
56
|
+
#
|
57
|
+
# Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
|
58
|
+
# Sketchup.active_model.layers.add("Hello World")
|
59
|
+
#
|
60
|
+
# @param [Sketchup::Layers] layers
|
61
|
+
#
|
62
|
+
# @param [Sketchup::Layer] layer
|
63
|
+
#
|
64
|
+
# @return [nil]
|
65
|
+
#
|
66
|
+
# @version SketchUp 6.0
|
67
|
+
def onLayerAdded(layers, layer)
|
68
|
+
end
|
69
|
+
|
70
|
+
# The {#onLayerChanged} method is called when a layer is changed.
|
71
|
+
#
|
72
|
+
# @example
|
73
|
+
# def onLayerChanged(layers, layer)
|
74
|
+
# puts "onLayerChanged: #{layer.name}"
|
75
|
+
# end
|
76
|
+
#
|
77
|
+
# Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
|
78
|
+
# layer = Sketchup.active_model.layers.add("Hello World")
|
79
|
+
# layer.name = "Hello Universe"
|
80
|
+
#
|
81
|
+
# @param [Sketchup::Layers] layers
|
82
|
+
#
|
83
|
+
# @param [Sketchup::Layer] layer
|
84
|
+
#
|
85
|
+
# @return [nil]
|
86
|
+
#
|
87
|
+
# @version SketchUp 2014
|
88
|
+
def onLayerChanged(layers, layer)
|
89
|
+
end
|
90
|
+
|
91
|
+
# The {#onLayerRemoved} method is called when a layer is removed from a model.
|
92
|
+
#
|
93
|
+
# @example
|
94
|
+
# class MyLayersObserver < Sketchup::LayersObserver
|
95
|
+
# def onLayerRemoved(layers, layer)
|
96
|
+
# puts "onLayerRemoved: #{layer.name}"
|
97
|
+
# end
|
98
|
+
# end
|
99
|
+
#
|
100
|
+
# Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
|
101
|
+
# layer = Sketchup.active_model.layers.add("Hello World")
|
102
|
+
# Sketchup.active_model.layers.remove(layer)
|
103
|
+
#
|
104
|
+
# @param [Sketchup::Layers] layers
|
105
|
+
#
|
106
|
+
# @param [Sketchup::Layer] layer
|
107
|
+
#
|
108
|
+
# @return [nil]
|
109
|
+
#
|
110
|
+
# @version SketchUp 6.0
|
111
|
+
def onLayerRemoved(layers, layer)
|
112
|
+
end
|
113
|
+
|
114
|
+
# The {#onRemoveAllLayers} method is called when all layer are removed from a
|
115
|
+
# model.
|
116
|
+
#
|
117
|
+
# @example
|
118
|
+
# class MyLayersObserver < Sketchup::LayersObserver
|
119
|
+
# def onRemoveAllLayers(layers)
|
120
|
+
# puts "onRemoveAllLayers: #{layers}"
|
121
|
+
# end
|
122
|
+
# end
|
123
|
+
#
|
124
|
+
# Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
|
125
|
+
# layer = Sketchup.active_model.layers.add("Hello World")
|
126
|
+
# Sketchup.active_model.layers.remove(layer)
|
127
|
+
#
|
128
|
+
# @param [Sketchup::Layers] layers
|
129
|
+
#
|
130
|
+
# @return [nil]
|
131
|
+
#
|
132
|
+
# @version SketchUp 6.0
|
133
|
+
def onRemoveAllLayers(layers)
|
134
|
+
end
|
135
|
+
|
136
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# Copyright:: Copyright 2017 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Sketchup::Licensing module contains methods for extensions purchased
|
5
|
+
# from Extension Warehouse to check their licensing status. It is advised
|
6
|
+
# to place these calls inside encrypted Ruby (.rbe) files. This API is also
|
7
|
+
# exposed via the SketchUp C API. Extensions that already use native code
|
8
|
+
# should prefer using the native API, which should be more secure than their
|
9
|
+
# Ruby API counterparts.
|
10
|
+
#
|
11
|
+
# See the {Licensing Tutorial}[../tutorial_licensing] for more details.
|
12
|
+
#
|
13
|
+
# @version SketchUp 2015
|
14
|
+
module Sketchup::Licensing
|
15
|
+
|
16
|
+
# Constants
|
17
|
+
|
18
|
+
EXPIRED = nil # Stub value.
|
19
|
+
LICENSED = nil # Stub value.
|
20
|
+
NOT_LICENSED = nil # Stub value.
|
21
|
+
TRIAL = nil # Stub value.
|
22
|
+
TRIAL_EXPIRED = nil # Stub value.
|
23
|
+
|
24
|
+
# Class Methods
|
25
|
+
|
26
|
+
# Acquires a license for a given extension.
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
|
30
|
+
# ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
|
31
|
+
# if ext_lic.licensed?
|
32
|
+
# puts "Extension is licensed."
|
33
|
+
# end
|
34
|
+
#
|
35
|
+
# @param extension_id
|
36
|
+
# String - The Extension Warehouse UUID for the extension.
|
37
|
+
#
|
38
|
+
# @return ExtensionLicense - an object representing licensing
|
39
|
+
# state for the extension. Do not store this object,
|
40
|
+
# retrieve it again when needed since licensing state may
|
41
|
+
# have changed.
|
42
|
+
#
|
43
|
+
# @version SketchUp 2015
|
44
|
+
def self.get_extension_license(extension_id)
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,88 @@
|
|
1
|
+
# Copyright:: Copyright 2017 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The Sketchup::Licensing::ExtensionLicense class is used to store extension
|
5
|
+
# license information. An instance of this class is returned by
|
6
|
+
# Sketchup::Licensing.get_extension_license. Note that this is a temporary
|
7
|
+
# object representing the extension licensing state for the moment it was
|
8
|
+
# returned. It will not reflect any licensing state changes that may occur.
|
9
|
+
#
|
10
|
+
# @version SketchUp 2015
|
11
|
+
class Sketchup::Licensing::ExtensionLicense
|
12
|
+
|
13
|
+
# Instance Methods
|
14
|
+
|
15
|
+
# The days_remaining method is used to get the number of days remaining until
|
16
|
+
# license expiration.
|
17
|
+
#
|
18
|
+
# @example
|
19
|
+
# ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
|
20
|
+
# ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
|
21
|
+
# if ext_lic.days_remaining != 0
|
22
|
+
# puts "The license will expire in #{ext_lic.days_remaining} days."
|
23
|
+
# end
|
24
|
+
#
|
25
|
+
# @return Integer - Number of days until license expiration. Zero
|
26
|
+
# if a permanent license or not licensed.
|
27
|
+
#
|
28
|
+
# @version SketchUp 2015
|
29
|
+
def days_remaining
|
30
|
+
end
|
31
|
+
|
32
|
+
# The error_description method is used to obtain error information in case of
|
33
|
+
# failure to acquire a license. This is meant to aid in debugging only.
|
34
|
+
# Extensions should not rely on any exact error description.
|
35
|
+
#
|
36
|
+
# @example
|
37
|
+
# ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
|
38
|
+
# ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
|
39
|
+
# if !ext_lic.licensed?
|
40
|
+
# puts ext_lic.error_description
|
41
|
+
# end
|
42
|
+
#
|
43
|
+
# @return String - error description.
|
44
|
+
#
|
45
|
+
# @version SketchUp 2015
|
46
|
+
def error_description
|
47
|
+
end
|
48
|
+
|
49
|
+
# The licensed? method is used to decide whether the extension is licensed to
|
50
|
+
# run or not.
|
51
|
+
#
|
52
|
+
# @example
|
53
|
+
# ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
|
54
|
+
# ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
|
55
|
+
# if ext_lic.licensed?
|
56
|
+
# puts "Extension is licensed."
|
57
|
+
# end
|
58
|
+
#
|
59
|
+
# @return Boolean - true if the extension is allowed to run, false
|
60
|
+
# if it is not licensed and should quit.
|
61
|
+
#
|
62
|
+
# @return [Boolean]
|
63
|
+
#
|
64
|
+
# @version SketchUp 2015
|
65
|
+
def licensed?
|
66
|
+
end
|
67
|
+
|
68
|
+
# The state method returns a constant indicating the specific licensing state.
|
69
|
+
# These should be used for informational purposes only and not to decide if
|
70
|
+
# the extension is licensed to run. For that, please use the licensed? method.
|
71
|
+
#
|
72
|
+
# @example
|
73
|
+
# ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
|
74
|
+
# ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
|
75
|
+
# if ext_lic.state == Sketchup::Licensing::TRIAL_EXPIRED
|
76
|
+
# puts "Trial period has expired."
|
77
|
+
# end
|
78
|
+
#
|
79
|
+
# @return Integer - One of Sketchup::Licensing::LICENSED,
|
80
|
+
# Sketchup::Licensing::EXPIRED, Sketchup::Licensing::TRIAL,
|
81
|
+
# Sketchup::Licensing::TRIAL_EXPIRED,
|
82
|
+
# Sketchup::Licensing::NOT_LICENSED
|
83
|
+
#
|
84
|
+
# @version SketchUp 2015
|
85
|
+
def state
|
86
|
+
end
|
87
|
+
|
88
|
+
end
|