class SketchupExtension

The SketchupExtension class contains methods allowing you to create and manipulate SketchUp extensions. Extensions are Ruby scripts that can be loaded and unloaded using the Extension manager (Extensions panel of the Preferences dialog box). Generally you should register your ruby scripts as an extension to give SketchUp users the ability to disable it through the user interface.

The idea here is to take the ruby script that actually creates your functionality and place it in a folder somewhere outside of the /Plugins folder, most commonly a subdirectory like /Plugins/MyExtension. Then you create a new ruby script inside the /Plugins directory that will set up the extension entry and load your original script if the user has your extension turned on.

Here is an example extension loading script. For this example, the following code would be saved in /Plugins/StairTools.rb, and the actual plugin itself would live in /Plugins/StairTools/core.rb.

You can find two example extensions that ship with SketchUp, su_dynamiccomponents.rb and su_sandboxtools.rb, under the /Plugins/ folder.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
require 'sketchup.rb'
require 'extensions.rb'

stair_extension = SketchupExtension.new('Stair Tools", "StairTools/core.rb')
stair_extension.version = '1.0'
stair_extension.description = 'Tools to draw stairs automatically.'
Sketchup.register_extension(stair_extension, true)

@version SketchUp 6.0

Public Class Methods

new(title, path) click to toggle source

The new method is used to create a new SketchupExtension object. Note that once the extension object is created, it will not appear in the Extension Manager dialog until your register it with the Sketchup.register_extension method.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core')

# Then be sure to register it. By passing a 2nd param of true, you're
# telling SketchUp to load the extension by default.
Sketchup.register_extension(extension, true)

@note It is recommended to omit the file extension provided in the path

argument. SketchUp will resolve the file extension to +.rbe+, +.rbs+
or +.rb+.

@param [String] title

The name of the extension

@param [String] path

The relative path to the script that loads your
plugin.

@return [Sketchup::Extension] the new Extension object

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 210
def initialize(title, path)
end

Public Instance Methods

check() click to toggle source

Loads the extension, meaning the underlying ruby script is immediately interpreted. This is the equivalent of checking the extension's checkbox in the Preferences > Extensions list.

@example

# This will register the extension, a necessary step for it to appear
# in SketchUp's Preferences > Extensions list
ext_c = SketchupExtension.new('Stair Tools C', 'StairTools/core.rb')
Sketchup.register_extension(ext_c, false)

# And this will load the extension.
ext_c.check

@return [Boolean] whether the load succeeded

@version SketchUp 8.0 M2

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 57
def check
end
creator() click to toggle source

The creator method returns the creator string which appears beneath an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
extension.creator = 'Trimble Navigation, Inc.'
creator = extension.creator

@return [String] the Extension creator

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 108
def creator
end
creator=(creator) click to toggle source

The creator= method sets the creator string which appears beneath an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
extension.creator = 'Trimble Navigation, Inc.'
creator = extension.creator

@param [String] creator

The creator to set

@return [String] the new creator

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 127
def creator=(creator)
end
description() click to toggle source

The description method returns the long description which appears beneath an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
extension.description = 'My description.'
description = extension.description

@return [String] the Extension description

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 143
def description
end
description=(description) click to toggle source

The description= method sets the long description which appears beneath an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
extension.description = 'My description.'
description = extension.description

@param [String] description

The description string to set.

@return [String] the Extension description

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 162
def description=(description)
end
extension_path() click to toggle source

The extension_path method returns the file system path to the extension's outer rb file.

@return [String] the file system path to the extension

@version SketchUp 2013

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 171
def extension_path
end
id() click to toggle source

The id method returns the Extension Warehouse ID string.

@return [String] the Extension Warehouse ID

@version SketchUp 2013

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 179
def id
end
load_on_start?() click to toggle source

Returns whether the extension is set to load when SketchUp starts up.

@example

ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
UI.messagebox("load_on_start? is false: #{ext.load_on_start?.to_s}")
Sketchup.register_extension(ext, true)
UI.messagebox("load_on_start? is now true: #{ext.load_on_start?.to_s}")

@return [Boolean]

@version SketchUp 8.0 M2

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 224
def load_on_start?
end
loaded?() click to toggle source

Returns whether the extension is currently loaded, meaning the actual ruby script that implements the extension has been evaluated.

@example

ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
UI.messagebox("loaded? is false: #{ext.loaded?.to_s}")
Sketchup.register_extension(ext, true)
UI.messagebox("loaded? is now true: #{ext.loaded?.to_s}")

@return [Boolean]

@version SketchUp 8.0 M2

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 239
def loaded?
end
name() click to toggle source

The name method returns the name which appears for an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
name = extension.name

@return [String] the Extension name

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 254
def name
end
name=(name) click to toggle source

The name= method sets the name which appears for an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
extension.name = 'Renamed Stair Tools'

@param [String] name

The new name

@return [String] the Extension name

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 272
def name=(name)
end
registered?() click to toggle source

Returns whether the extension has been registered via Sketchup.register_extension.

@example

ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
UI.messagebox("My registered? is false: #{ext.registered?.to_s}")
Sketchup.register_extension(ext, true)
UI.messagebox("Now registered? is now true: #{ext.registered?.to_s}")

@return [Boolean]

@version SketchUp 8.0 M2

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 287
def registered?
end
uncheck() click to toggle source

Unloads the extension. This is the equivalent of unchecking the extension's checkbox in the Preferences > Extensions list.

Note that technically the extension is not “unloaded” in the sense that it stops running during the current SketchUp session, but the next time the user restarts SketchUp, the extension will not be active.

@example

# This unloads all extensions. The next time SketchUp starts, none of
# the extensions will be active.
Sketchup.extensions.each { |extension|
  extension.uncheck
}

@return [Boolean] whether the unload succeeded

@version SketchUp 8.0 M2

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 307
def uncheck
end
version() click to toggle source

The version method returns the version which appears beneath an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
extension.version = '5.0'
version = extension.version

@return [String] the Extension version

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 323
def version
end
version=(version) click to toggle source

The version method sets the version which appears beneath an extension inside the Extensions Manager dialog.

@example

# Create an entry in the Extension list that loads a script called
# core.rb.
extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
extension.version = '5.0'
version = extension.version

@param [String] version

The version string to set.

@return [String] the Extension version

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 342
def version=(version)
end
version_id() click to toggle source

The version_id method returns the Extension Warehouse Version ID string.

@return [String] the Extension Warehouse Version ID string

@version SketchUp 2013

# File lib/sketchup-api-stubs/stubs/sketchupextension.rb, line 350
def version_id
end