Module: Sketchup

Overview

The Sketchup module contains a number of important utility methods for use in your Ruby scripts. Many of the classes in the API are implemented beneath this module. You can think of the Sketchup module as the “root” of the application tree. Most ruby calls start from the currently active model, and this is accessed via the Sketchup.active_model method.

Examples:

# Grab a handle to the currently active model (aka the one the user is
# looking at in SketchUp.)
model = Sketchup.active_model

# Grab other handles to commonly used collections inside the model.
entities = model.entities
layers = model.layers
materials = model.materials
component_definitions = model.definitions
selection = model.selection

# Now that we have our handles, we can start pulling objects and making
# method calls that are useful.
first_entity = entities[0]
UI.messagebox("First thing in your model is a " + first_entity.typename)

number_materials = materials.length
UI.messagebox("Your model has " + number_materials.to_s + " materials.")

new_edge = entities.add_line( [0,0,0], [500,500,0])

Version:

  • SketchUp 6.0

Defined Under Namespace

Modules: Http, Licensing, RegionalSettings Classes: Animation, AppObserver, ArcCurve, AttributeDictionaries, AttributeDictionary, Axes, Behavior, Camera, ClassificationSchema, Classifications, Color, ComponentDefinition, ComponentInstance, Console, ConstructionLine, ConstructionPoint, Curve, DefinitionList, DefinitionObserver, DefinitionsObserver, Dimension, DimensionLinear, DimensionObserver, DimensionRadial, Drawingelement, Edge, EdgeUse, Entities, EntitiesObserver, Entity, EntityObserver, ExtensionsManager, Face, Group, Image, Importer, InputPoint, InstanceObserver, InstancePath, Layer, Layers, LayersObserver, Loop, Material, Materials, MaterialsObserver, Menu, Model, ModelObserver, OptionsManager, OptionsProvider, OptionsProviderObserver, Page, Pages, PagesObserver, PickHelper, RenderingOptions, RenderingOptionsObserver, SectionPlane, Selection, SelectionObserver, Set, ShadowInfo, ShadowInfoObserver, Style, Styles, Text, Texture, TextureWriter, Tool, Tools, ToolsObserver, UVHelper, Vertex, View, ViewObserver

Class Method Summary collapse

Class Method Details

.active_modelObject

The active_model method returns the currently active SketchUp model. On the PC, this is the only model that one can have access to via the API, but Macintosh versions of SketchUp can have multiple models open at once, in which case the method will return the model that the user currently has focused.

Examples:

model = Sketchup.active_model
if (! model)
  UI.messagebox "Failure"
else
  # code acting on the model
end

Returns:

  • model - active model object if successful, false if unsuccessful

Version:

  • SketchUp 6.0

.add_observer(observer) ⇒ Object

The add_observer method is used to add an observer to the current object.

Examples:

status = Sketchup.add_observer observer

Returns status - true if successful, false if unsuccessful.

Parameters:

  • observer

    An observer.

Returns:

  • status - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.app_nameObject

The app_name method is used to retrieve the current application name.

Examples:

name = Sketchup.app_name

Returns:

  • name - the name of the application, either “SketchUp Pro” or “SketchUp”. Note: For versions earlier than SketchUp8 M4 (Mac 8.0.15157 and Windows 8.0.15158) this function will return “Google SketchUp Pro” or “Google SketchUp”.

Version:

  • SketchUp 6.0

.break_edges(enabled) ⇒ Object

The break_edges= method can be used to disable or enable the break edges feature. Break edges is the SketchUp 7 feature that automatically splits edges that the user draws which cross over one another.

This feature is always on by default and cannot be disabled by the user via the user interface, but you can call this method to disable it. Be cautious in doing so, however, as the resulting model could then be altered when the user later draws lines into it with the break edges feature reactivated.

Examples:

is_on = Sketchup.break_edges?

Returns setting - true if break edges was turned on.

Parameters:

  • enabled

    If true, break edges will be turned on. If false, it will be deactivated.

Returns:

  • setting - true if break edges was turned on.

Version:

  • SketchUp 7.0

.break_edges?Object

The break_edges? method indicates whether the break edges feature is currently turned on. Break edges is the SketchUp 7 feature that automatically splits edges that the user draws which cross over one another. This feature is always on by default and cannot be disabled by the user via the user interface.

Examples:

is_on = Sketchup.break_edges?

Returns:

  • break_edges - true if the feature is on.

  • (Boolean)

Version:

  • SketchUp 7.0

.create_texture_writerObject

The create_texture_writer method is used to create a TextureWriter object.

Examples:

texturewriter = Sketchup.create_texture_writer

Returns:

  • texturewriter - a texturewriter object if successful.

Version:

  • SketchUp 6.0

.debug_mode(enabled) ⇒ Object

The debug_mode= method lets you controls whether SketchUp will output warnings to the console when it detects incorrect usage of the API. The setting takes effect right away, no need to restart SketchUp.

Examples:

Sketchup.debug_mode = true

Returns setting - true if debug mode is enabled.

Parameters:

  • enabled

    If true, SketchUp will produce debug warnings.

Returns:

  • setting - true if debug mode is enabled.

Version:

  • SketchUp 2016

.debug_mode?Object

The debug_mode? controls whether SketchUp will output warnings to the console when it detects incorrect usage of the API.

Examples:

debug_mode = Sketchup.debug_mode?

Returns:

  • debug_mode - true if debug mode is enabled

  • (Boolean)

Version:

  • SketchUp 2016

.display_name_from_action(action_name) ⇒ Object

Note:

This method has been non-functional on Mac since SketchUp 8.

The display_name_from_action method is used to gets a user-friendly name from an action string. See Sketchup.send_action for a list of valid action strings.

Examples:

Sketchup.display_name_from_action("viewRight:")

Returns friendly_name = a friendly name.

Parameters:

  • action_name

    An action string.

Returns:

  • friendly_name = a friendly name.

Version:

  • SketchUp 6.0

.extensionsObject

Returns the ExtensionsManager where you can find all registered SketchupExtension objects.

Examples:

extensions = Sketchup.extensions
for extension in extensions
  UI.messagebox('The next extension is named: ' + extension.name +
      ' and its loaded? state is: ' + extension.loaded?)
end

Returns:

  • extensionsmanager - an ExtensionsManager object.

Version:

  • SketchUp 8.0 M2

.file_newObject

The file_new method is used to create a new file.

Examples:

new_sketchup = Sketchup.file_new

Returns:

  • Sketchup - a Sketchup object if successful.

Version:

  • SketchUp 6.0

.find_support_file(filename, directory = '') ⇒ Object

The find_support_files method is used to retrieve the relative path and name of a file within the SketchUp installation directory.

Forward slashes must be used to delimit between directory names.

Examples:

help_file = Sketchup.find_support_file "help.html", "Plugins/"
if (help_file)
  # Print out the help_file full path
  UI.messagebox help_file

  # Open the help_file in a web browser
  UI.openURL "file://" + help_file
else
  UI.messagebox "Failure"
end

Returns path - the entire path if successful. If unsuccessful, the method returns false.

Parameters:

  • filename

    Name of the filename you want to find.

  • directory (defaults to: '')

    directory relative to the SketchUp installation directory.

Returns:

  • path - the entire path if successful. If unsuccessful, the method returns false.

Version:

  • SketchUp 6.0

.find_support_files(filename, directory) ⇒ Object

The find_support_files method is used to retrieve the path and name of all matching files within the SketchUp installation directory.

Forward slashes must be used to delimit between directory names.

Examples:

files = Sketchup.find_support_files('rb', 'Plugins')

Array - an array of files. If unsuccessful, the method returns false.

Parameters:

  • filename

    Extension of the files to be found.

  • directory

    directory relative to the SketchUp installation directory. Without this the result will be empty.

Returns:

  • array - an array of files. If unsuccessful, the method returns false.

Version:

  • SketchUp 6.0

.fix_shadow_strings(enabled) ⇒ Object

The fix_shadow_strings= method lets you control whether shadow rendering attempts to fix an artifact commonly referred to as “strings”. The fix is actually very model dependent and not controllable from the UI, so this method can be used to control it.

Examples:

Sketchup.fix_shadow_strings=true

Returns setting - true if shadow strings fix was turned on.

Parameters:

  • enabled

    If true, shadow strings fix will be turned on. If false, it will be deactivated.

Returns:

  • setting - true if shadow strings fix was turned on.

Version:

  • SketchUp 8.0 M1

.fix_shadow_strings?Object

The fix_shadow_strings? method indicates whether the a fix for a shadow rendering artifact commonly referred to as “strings” is enabled. The fix is actually very model dependent and not controllable from the UI, so this method can be used to test it.

Examples:

is_on = Sketchup.fix_shadow_strings?

Returns:

  • fix_shadow_strings - true if the feature is on.

  • (Boolean)

Version:

  • SketchUp 8.0 M1

.format_angle(number) ⇒ Object

The format_angle method takes a number as an angle in radians and formats it into degrees. For example, format_angle(Math::PI) will return 180.0.

Examples:

degrees = Sketchup.format_angle Math::PI

Returns degrees - an angle in degrees if successful, false if unsuccessful

Parameters:

  • number

    A number to be formatted.

Returns:

  • degrees - an angle in degrees if successful, false if unsuccessful

Version:

  • SketchUp 6.0

.format_area(number) ⇒ Object

The format_area method formats a number as an area using the current units settings.

The default unit setting is inches. For example, 10 becomes 10 inches squared.

Examples:

area = Sketchup.format_area number

Returns area - an area if successful, false if unsuccessful.

Parameters:

  • number

    A number to be formatted.

Returns:

  • area - an area if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.format_degrees(number) ⇒ Object

The format_degrees method formats a number as an angle given in degrees. For example, 10 becomes 10.0. This is the equivalent to a to_f call.

Examples:

degrees = Sketchup.format_degrees number

Returns degrees - degrees if successful, false if unsuccessful.

Parameters:

  • number

    A number to be formatted.

Returns:

  • degrees - degrees if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.format_length(number) ⇒ Object

The format_length method formats a number as a length using the current units settings.

The default unit setting is inches. For example, 10 becomes 10“.

Examples:

length = Sketchup.format_length 10
if (length)
  UI.messagebox length
end

Returns length - length if successful, false if unsuccessful

Parameters:

  • number

    A number to be formatted.

Returns:

  • length - length if successful, false if unsuccessful

Version:

  • SketchUp 6.0

.get_datfile(key, default_value) ⇒ Object

The get_datfile_info method is used to retrieve the value for the given key from Sketchup.dat.

If the key is not found, default_value is returned.

Examples:

value = Sketchup.get_datfile_info(key, default_value)

Returns value - a string value if successful.

Parameters:

  • key

    The key whose value you want to retrieve.

  • default_value

    The default value you want returned if key is not available.

Returns:

  • value - a string value if successful.

Version:

  • SketchUp 6.0

.geT_i18ndatfile_info(key, default_value) ⇒ Object

The get_i18ndatfile_info method is used to retrieve the value for the given key from the internationalization file that SketchUp uses to work in multiple languages.

If the key is not found, default_value is returned.

Examples:

value = Sketchup.get_i18ndatfile_info(key, default_value)

Returns value - a string value if successful.

Parameters:

  • key

    The key whose value you want to retrieve.

  • default_value

    The default value you want returned if key is not available.

Returns:

  • value - a string value if successful.

Version:

  • SketchUp 6.0

.get_localeObject

The os_language method returns the language code for the language SketchUp is running in. This is an alias for the get_locale method.

Valid return values are: en-US, fr, it, de, es, ja, ko, zh-CN, zh-TW, pt-BR, nl, ru. If the OS language does not have corresponding folder and files in the SketchUp Resources folder, the returned language is, by default, en-US.

Examples:

language = Sketchup.os_language

Returns:

  • language - a code representing the language SketchUp is displaying.

Version:

  • SketchUp 6.0

.get_resource_path(filename) ⇒ Object

The get_resource_path is used to retrieve the directory where “resource” files are stored by SketchUp. Resource files include things like language localization files.

Examples:

directory = Sketchup.get_resource_path "Styles.strings"

Returns path - the directory path to the resources folder.

Parameters:

  • filename

    The filename of a resource file in the resource directory hierarchy.

Returns:

  • path - the directory path to the resources folder.

Version:

  • SketchUp 6.0

.get_shortcutsObject

The get_shortcuts method retrieves an array of all keyboard shortcuts currently registered with SketchUp. Each shortcut is returned as a string with the shortcut and the command separated by a tab, similar to “Ctrl+AtEdit/Select All”

Examples:

shortcuts = Sketchup.get_shortcuts

Returns:

  • shortcuts - an array of shortcut strings.

Version:

  • SketchUp 6.0

.install_from_archive(filename) ⇒ Boolean

Installs the contents of a ZIP archive file into SketchUp's Plugins folder. If the ZIP contains subfolders, these will be preserved. This allows for a Ruby API plugin or Extension developer to distribute their plugin as a single file regardless of how many asset files must be included.

The user will be shown a warning message that they must agree to before the install proceeds. If they do not agree, an Interrupt error will be raised. If the user does agree but there is a problem with the unzip process, an Exception will be raised. You can capture these states via a begin/rescue. See the example below.

If the install is successful, any Ruby files that have been added to the Plugins folder will immediately be executed, saving the user a restart.

To create an archive file, use your favorite tool (7zip, Winzip, etc.) to zip up any files and folders in your plugins directory. If the archive contains a SketchupExtension that you would like users to be able to install from the Preferences > Extensions panel, rename your file to have a .rbz file extension.

Examples:

path = 'c:/temp/SomePluginPackage.zip'
begin
  Sketchup.install_from_archive(path)
rescue Interrupt => error
  UI.messagebox "User said 'no': " + error
rescue Exception => error
  UI.messagebox "Error during unzip: " + error
end

Returns .

Parameters:

  • filename (String)

    The path to the RBZ or ZIP file to install.

Returns:

  • (Boolean)

    .

Raises:

  • (Interrupt)

    If the user cancel the installation.

  • (Exception)

    If the archive cannot be found.

  • (Exception)

    If the archive cannot be installed.

Version:

  • SketchUp 8.0 M2

.is_64bit?Object

This methods indicates whether the host SketchUp application is 64bit. Useful for extensions that ship with binaries and need to determine which versions to load.

Examples:

# For backward compatibility, check for the existence of the method
# and load 32bit binaries for SketchUp versions that do not have this
# method.
if Sketchup.respond_to?(:is_64bit?) && Sketchup.is_64bit?
  # Load 64bit binaries.
else
  # Load 32bit binaries.
end

Returns:

  • Boolean - True if SketchUp is 64bit.

  • (Boolean)

Version:

  • SketchUp 2015

.is_onlineObject

The is_online method is used to verify a connection to the Internet. This method can take some time to execute, so be careful not to call it more often than you need.

Examples:

status = Sketchup.is_online

Returns:

  • status - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.is_pro?Object

Returns a boolean flag indicating whether the application is SketchUp Pro. Note that after the free trial period, SketchUp Pro will revert to regular SketchUp and this method will return false until the user registers the product.

Examples:

if (Sketchup.is_pro?)
  UI.messagebox "You are running SU Pro."
end

Returns:

  • is_pro - true if the user is using SketchUp Pro

  • (Boolean)

Version:

  • SketchUp 7.0

.is_valid_filename?(filename) ⇒ Object

The is_valid_filename? method is used to determine whether a filename contains illegal characters.

Examples:

status = Sketchup.is_valid_filename? filename

Returns status - true if filename is valid, false if filename is invalid (contains illegal characters).

Parameters:

  • filename

    A filename string.

Returns:

  • status - true if filename is valid, false if filename is invalid (contains illegal characters).

Returns:

  • (Boolean)

Version:

  • SketchUp 6.0

.load(path) ⇒ Object

The load method is used to include encrypted and nonencrypted ruby files.

You do not need to include the file extension on the path. This method will look for .rb first (unencrypted) and then .rbe (encrypted) and finally .rbs (the deprecated scrambled format) files. See the “Distributing your Plugin” article for details.

Examples:

sfile = "application_loader" # file extension not required
status = Sketchup.load(sfile)

Returns status - True if the file is included. False if the file is not included.

Parameters:

  • path

    The path, including the filename, to the file you want to require.

Returns:

  • status - True if the file is included. False if the file is not included.

Version:

  • SketchUp 6.0

.open_file(filename) ⇒ Object

The open_file method is used to open a file.

Examples:

result = Sketchup.open_file "C:\\model.skp"

Returns result - true if opening the file succeeded, false otherwise.

Parameters:

  • filename

    The path and filename to open.

Returns:

  • result - true if opening the file succeeded, false otherwise.

Version:

  • SketchUp 6.0

.os_languageObject

The os_language method returns the language code for the language SketchUp is running in. This is an alias for the get_locale method.

Valid return values are: en-US, fr, it, de, es, ja, ko, zh-CN, zh-TW, pt-BR, nl, ru. If the OS language does not have corresponding folder and files in the SketchUp Resources folder, the returned language is, by default, en-US.

Examples:

language = Sketchup.os_language

Returns:

  • language - a code representing the language SketchUp is displaying.

Version:

  • SketchUp 6.0

.parse_length(string) ⇒ Object

The parse_length method parses a string as a length.

For example, “200” becomes 200.0.

Examples:

float = Sketchup.parse_length("2'") # Returns 24 (representing inches)
length = float.to_l # Convert to a Length type if needed.

Returns float - the numerical representation of the string if successful, or nil if unsuccessful.

Parameters:

  • string

    The string to be parsed as a number.

Returns:

  • float - the numerical representation of the string if successful, or nil if unsuccessful.

Version:

  • SketchUp 6.0

.platformObject

This methods returns a symbol indicating the current platform.

It should be used over RUBY_PLATFORM as this returns a different value for Windows since SketchUp 2014.

Older SketchUp versions still need to check RUBY_PLATFORM.include?('mswin') or RUBY_PLATFORM.include?('darwin').

Possible return values:

  • :platform_win

  • :platform_osx

Examples:

module MyExtension
  IS_WIN = Sketchup.platform == :platform_win
  IS_OSX = Sketchup.platform == :platform_osx
end

Returns:

  • symbol - Current OS platform.

Version:

  • SketchUp 2014

.plugins_disabled(enabled) ⇒ Object

The plugins_disabled= method lets you control whether SketchUp will load Ruby scripts from the plugins directory at startup time. This is primarily a trouble-shooting method. If you are having strange behavior in SketchUp that you suspect is from a bad script, you can type Sketchup.plugins_disabled=true into the Ruby console and restart SketchUp to see if the problem is fixed.

Examples:

# Type this in the Ruby console then restart SketchUp.
Sketchup.plugins_disabled=true

# To reactivate plugins, type this into the Ruby console and restart.
Sketchup.plugins_disabled=false

Returns setting - true if plugins were disabled.

Parameters:

  • enabled

    If true, the plugins directory will not load.

Returns:

  • setting - true if plugins were disabled.

Version:

  • SketchUp 8.0 M2

.plugins_disabled?Object

The plugins_disabled? method indicates whether Ruby scripts in the plugins directory will be loaded at startup time.

Examples:

is_disabled = Sketchup.plugins_disabled?

Returns:

  • plugins_disabled - true if the plugins are disabled.

  • (Boolean)

Version:

  • SketchUp 8.0 M2

.quitObject

The quit method is used to terminate the application. This will pop-up the usual model save prompts if there are unsaved models open. User can cancel the model save, in which case the application will not terminate.

Examples:

Sketchup.quit
# Do not expect code to execute reliably after this point.

Returns:

  • self

Version:

  • SketchUp 2014

.read_default(section, variable, default = nil) ⇒ Object

The read_default method is used to retrieve the string associated with a value within the specified sub-section section of a .INI file or registry (within the Software > SketchUp > SketchUp [Version] section).

Examples:

result = Sketchup.read_default "section",
"variable", "default"

Returns result - nil if unsuccessful, the value of the default if successful.

Parameters:

  • section

    A section in an .INI or registry.

  • variable

    A variable within the section.

  • default (defaults to: nil)

    A default value if the value is not found.

Returns:

  • result - nil if unsuccessful, the value of the default if successful.

Version:

  • SketchUp 6.0

.register_extension(extension, load_on_start = false) ⇒ Boolean

Note:

It is recommended to set load_on_start to true unless you have a very good reason not to.

The register_extension method is used to register an extension with SketchUp's extension manager (in SketchUp preferences).

Examples:

utilitiesExtension = SketchupExtension.new "Utilities Tools",
  "Utilities/utilitiesTools.rb"

utilitiesExtension.description = "Adds Tools->Utilities to the " +
  "SketchUp inteface. The Utilities submenu contains two tools: " +
  "Create Face and Query Tool."

Sketchup.register_extension utilitiesExtension, false

Returns true if extension registered properly

Parameters:

  • extension (SketchupExtension)

    A SketchupExtension object.

  • load_on_start (Boolean) (defaults to: false)

    Passing true into this will load the extension immediately and set it so that it will load automatically whenever SketchUp restarts.

Returns:

  • (Boolean)

    true if extension registered properly

Version:

  • SketchUp 6.0

.register_importer(importer) ⇒ Object

The register_importer method is used to register an importer with SketchUp.

Examples:

status = Sketchup.register_importer importer

Returns status - true if successful, false if unsuccessful.

Parameters:

  • importer

    An Importer object representing the importer.

Returns:

  • status - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.remove_observer(observer) ⇒ Object

The remove_observer method is used to remove an observer from the current object.

Examples:

status = Sketchup.remove_observer observer

Returns true if successful, false if unsuccessful.

Parameters:

  • observer

    An observer.

Returns:

  • true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.require(path) ⇒ Object

The require method is used to include encrypted and nonencrypted ruby files. This is an alias of the Sketchup.load method.

You do not need to include the file extension on the path. This method will look for .rbe first (encrypted) and then .rbs (the deprecated scrambled format) and finally .rb (unencrypted) files. The loading order was changed in SketchUp 2016 when the new .rbe encryption was introduced. Prior to SketchUp 2016 the loading order was first .rb then .rbs.

Examples:

sfile = "application_loader" # file extension not required
status = Sketchup::require(sfile)

Returns status - True if the file is included. False if the file is not included.

Parameters:

  • path

    The path, including the filename, to the file you want to require.

Returns:

  • status - True if the file is included. False if the file is not included.

Version:

  • SketchUp 6.0

.save_thumbnail(skp_filename, img_filename) ⇒ Object

The save_thumbnail method is used to generate a thumbnail for any SKP file - not necessarily the loaded model.

Examples:

status = Sketchup.save_thumbnail "skp_filename", "image_filename"

Returns status - true if successful, false if unsuccessful.

Parameters:

  • skp_filename

    The name of the SketchUp file whose model you want represented in the thumbnail.

  • img_filename

    The name of the file where the thumbnail will be saved.

Returns:

  • status - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.send_action(action) ⇒ boolean

The send_action method sends a message to the message queue to perform some action asynchronously.

Valid actions are:

  • showRubyPanel:

  • viewBack:

  • viewBottom:

  • viewFront:

  • viewIso:

  • viewLeft:

  • viewRight:

  • viewTop:

  • viewPerspective:

  • viewShowAxes:

  • viewShowHidden:

  • viewZoomExtents:

  • viewZoomToSelection:

  • viewUndo:

  • selectOrbitTool:

  • selectPositionCameraTool:

  • selectDollyTool:

  • selectTurnTool:

  • selectWalkTool:

  • selectZoomTool:

  • selectFieldOfViewTool:

  • selectZoomWindowTool:

  • pageAdd:

  • pageDelete:

  • pageUpdate:

  • pageNext:

  • pagePrevious:

  • renderWireframe:

  • renderHiddenLine:

  • renderMonochrome:

  • renderShaded:

  • renderTextures:

  • selectArcTool:

  • selectArc3PointTool:

  • selectArc3PointPieTool:

  • selectAxisTool:

  • selectCircleTool:

  • selectEraseTool:

  • selectFreehandTool:

  • selectLineTool:

  • selectMeasureTool:

  • selectMoveTool:

  • selectOffsetTool:

  • selectPaintTool:

  • selectPolygonTool:

  • selectProtractorTool:

  • selectPushPullTool:

  • selectRectangleTool:

  • selectRectangle3PointTool:

  • selectRotateTool:

  • selectScaleTool:

  • selectSectionPlaneTool:

  • selectTextTool:

  • selectDimensionTool:

  • selectExtrudeTool:

  • selectSelectionTool:

  • editUndo:

  • editRedo:

  • editHide:

  • editUnhide:

  • fixNonPlanarFaces:

Added in SketchUp 8.0+:

  • addBuilding:

  • getPhotoTexture:

  • selectImageIglooTool:

  • selectNorthTool:

Added in SketchUp 2013+:

  • showExtensionStore:

Removed in SketchUp 2013+:

  • addBuilding:

On the PC only, you can also send these numeric values. (Note that these are officially “unsupported” and are not guaranteed to work in current or future versions of the API.)

  • 10501: set view to Top

  • 10502: set view to Front

  • 10503: set view to Rear

  • 10504: set view to Left

  • 10505: set view to Right

  • 10506: set view to Bottom

  • 10507: set view to Axonometric

  • 10510: set render mode to Wire

  • 10511: set render mode to Hidden lines removal

  • 10512: set render mode to Surfaces Shading

  • 10513: set render mode to Transparency

  • 10519: set camera to ortho (removes perspective)

  • 10520: walk tool

  • 10521: display the System Preferences dialog box (Files tab)

  • 10522: removes axes display

  • 10523: pan tool

  • 10525: set the interactive eye height feature

  • 10526: zoom window

  • 10527: zoom extents

  • 10529: zoom out 2

  • 10531: toggle the Standard toolbar

  • 10532: toggle the Camera toolbar

  • 10533: display the Shadows Settings dialog box

  • 10537: toggle the Views toolbar

  • 10538: display the System Preferences dialog box (Display tab)

  • 10545: toggle Color ByLayer

  • 10546: toggle Shadows toolbar

  • 10551: toogle Large icons

  • 10576: toggle Render Mode toolbar

  • 10596: set Render Mode to No Transparency (Preferences)

  • 10597: set Render Mode to Wire (Preferences)

  • 10598: set Render Mode to Transparency (Preferences)

  • 10599: set Render Mode to Surfaces Shading (Preferences)

  • 10600: set Render Mode to Texture (Preferences)

  • 10601: set Render Mode to No Texture (Preferences)

  • 10602: toggle Shadows

  • 10603: toggle Profiles

  • 10604: toggle Extension Lines

  • 10605: toggle Jitter edges

  • 21019: hide Status bar and VCB

  • 21020: show Status bar and VCB

  • 21022: hide Status bar and VCB

  • 21023: place 3d text box

  • 21024: select the Measure tool

  • 21031: select the Freehand Draw tool

  • 21041: select the PushPull tool

  • 21048: select the Move tool

  • 21052: hide selected objects

  • 21056: create face with selected edges closed loop

  • 21057: select the Protractor tool

  • 21060: display Components Window

  • 21061: toggle Draw toolbar

  • 21063: toggle Model Bounding Box display

  • 21065: select the Arc tool

  • 21067: creat a new Page

  • 21069: select the Arc 3 Point tool

  • 21070: select the Arc 3 Point Pie tool

  • 21074: show the Materials Browser Window

  • 21076: display the Preferences dialog box (Text activated)

  • 21077: display the Tip of the day Window

  • 21078: select the Paint Bucket tool

  • 21080: display the Page Manager Window

  • 21082: display the Macros Dialog Box

  • 21086: display the Components Browser Window

  • 21094: select the Rectangle tool

  • 21095: select the Polygon tool

  • 21096: select the Circle tool

  • 21098: open the Open Window

  • 21100: select the Offset tool

  • 21101: slect all objects

  • 21112: open the Import Window

  • 21124: launch the validity check tool

  • 21126: select the Axes tool

  • 21029: select the Rotate tool

  • 21032: toggle Layer toolbar

  • 21036: display the Save as Window

  • 21046: spin the model a full 360° and display report

  • 21047: fast Pick Time report

  • 21049: open the Export model Window

  • 21169: select the Position Camera tool

  • 21170: display the Preferences, Tour Guide activated

  • 21180: create a new Page just right of selected page

  • 21200: display the Insert Image Window

  • 21233: display Area of selected face

  • 21234: display Area of all faces with selected material

  • 21236: select the Scale tool

  • 21237: display the Export 2D Graphics Window

  • 21245: display a Polygon Offset Factors dialog box

  • 21276: reverse selected face(s)

  • 21287: select the Divide feature

  • 21337: select the Section Plane Placement tool

  • 21354: open the Layer Window

  • 21386: open the Export Animation Window

  • 21405: select the Text tool

  • 21406: display Fog dialog box

  • 21410: select the Dim tool

  • 21433: toggle Edit toolbar

  • 21442: select the FollowMe tool

  • 21448: select the Axes tool

  • 21453: select all objects

  • 21460: display Licence

  • 21462: display Authorization dialog box

  • 21463: display un-authorizing message

  • 21464: display Open Licence files (Network) Window

  • 21466: display Quick reference Card in Adobe Reader

  • 21467: display Licences in use dialog box

  • 21469: zoom extents to selected objects

  • 21476: perform a non-planar check on selected objects

  • 21477: list accelerators in window

  • 21485: erase selected objects

  • 21487: display Edit current material dialog box

  • 21485: erase all new created pages

  • 21488: display Entity Info Window

  • 21490: display Soften Edges Window

  • 21491: display Profiles

  • 21492: display Extended Edges

  • 21493: display Jitter Lines

  • 21494: select Field of view tool

  • 21513: display the outliner

  • 21520: override Tile Rendering Size dialog box

  • 21525: select the FollowMe tool

  • 21542: display the Insert Image Window

  • 21560 and up: causes a runtime Error

Examples:

result = Sketchup.send_action "selectArcTool:"

Returns true if successful, false if unsuccessful

Parameters:

  • action (String, Integer)

    The action to be performed.

Returns:

  • (boolean)

    true if successful, false if unsuccessful

Version:

  • SketchUp 6.0

.set_status_text(status_text = '', position = SB_PROMPT) ⇒ nil

The set_status_text method is used to set the text appearing on the status bar within the drawing window.

If no arguments are passed, the status bar content is cleared. Valid positions are:

  • SB_PROMPT - the text will appear at the left-side of the status bar

  • SB_VCB_LABEL - the text will appear in place of the VCB label

  • SB_VCB_VALUE - the text will appear in the VCB

Examples:

result = Sketchup.set_status_text "This is a Test", SB_VCB_VALUE
if (result)
  #code to do something if set_status_text is successful
end

Parameters:

  • status

    text the status text that will appear.

  • position (defaults to: SB_PROMPT)

    the position where the text will appear.

Returns:

  • (nil)

Version:

  • SketchUp 6.0

.status_text=(status_text) ⇒ Object

The status_text= method is used to set the text appearing on the status bar within the drawing window.

This is the same as calling set_status_text with a 2nd parameter of SB_PROMPT.

Examples:

result = Sketchup.status_text = "This is a Test"

Returns result - true if successful, false if unsuccessful.

Parameters:

  • status_text

    The status text that will appear.

Returns:

  • result - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.temp_dirObject

The temp_dir method is used to retrieve the OS temporary directory for the current user. You can use this directory to write temporary files that are not required to persist between SketchUp sessions.

Examples:

temp_dir = Sketchup.temp_dir

Returns:

  • String containing the full temporary directory path

Version:

  • SketchUp 2014

.templateObject

The template method is used to get the file name of the current template. Templates are the .skp files that are loaded when the user select File > New.

Examples:

name = Sketchup.template

Returns:

  • name - the current template

Version:

  • SketchUp 6.0

.template=(filename) ⇒ Object

The template= method is used to set the file name of the current template. Templates are the .skp files that are loaded when the user select File > New.

Examples:

status = Sketchup.template= "filename"

Returns status - true if successful, false if unsuccessful.

Parameters:

  • filename

    The name of the template to set.

Returns:

  • status - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.template_dirObject

The template_dir is used to retrieve the directory where templates are stored by the SketchUp install. Templates are the .skp files that are loaded when the user select File > New.

Examples:

directory = Sketchup.template_dir

Returns:

  • String containing the full template directory path

Version:

  • SketchUp 6.0

.undoObject

The undo method is used undo the last transaction on the undo stack.

Examples:

Sketchup.undo

Returns:

  • nil

Version:

  • SketchUp 6.0

.vcb_label(label_text) ⇒ Object

The vcb_label= method is used to set the label that appears on the vcb, or the “value control box”, which is another word for the “measurements” text entry box that appears at the bottom on the SketchUp window.

This is the same as calling set_status_text with a 2nd parameter of SB_VCB_LABEL.

Examples:

result = Sketchup.vcb_label = "This is a Test"

Returns result - true if successful, false if unsuccessful.

Parameters:

  • label_text

    The label text that will appear.

Returns:

  • result - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.vcb_value=(value) ⇒ Object

The vcb_value= method is used to set the value that appears on the vcb, or the “value control box”, which is another word for the “measurements” text entry box that appears at the bottom on the SketchUp window.

This is the same as calling set_status_text with a 2nd parameter of SB_VCB_VALUE.

Examples:

result = Sketchup.vcb_value = "This is a Test"

Returns result - true if successful, false if unsuccessful.

Parameters:

  • value

    The text that will appear as the vcb's value.

Returns:

  • result - true if successful, false if unsuccessful.

Version:

  • SketchUp 6.0

.versionObject

Gets the current version of sketchup in decimal form.

Examples:

version = Sketchup.version
if (version)
  UI.messagebox version
else
  return
end

Returns:

  • version - the decimal form of the version

Version:

  • SketchUp 6.0

.version_numberObject

Get the current version of sketchup as a whole number for comparisons. The number returned has the major, minor, and build values packed into an integer value as follows:

  • Major version = X

  • Minor version = Y

  • Build number = Z

SketchUp 6.0 - SketchUp 2015

  • XXYYYZZZ

SketchUp 2016+

  • XXYZZZZZZZ

Examples:

if (15003000...15004000) === Sketchup.version_number
  puts "SketchUp 15.3"
end
if Sketchup.version_number >= 1600000000
  puts "New format"
end

Returns version - the whole number form of the version

Returns:

  • version - the whole number form of the version

Version:

  • SketchUp 6.0

.write_default(section, key, value) ⇒ Boolean

The write_default method is used to set the string associated with a variable within the specified sub-section of a .plist file on the Mac or the registry on Windows (within the Software > SketchUp > SketchUp [Version] section).

Examples:

result = Sketchup.write_default("section", "key", "my_value")

Returns result - True if successful, false if unsuccessful.

Parameters:

  • section (String)

    A section in a .plist file (Mac) or the registry (Windows).

  • key (String)

    A key within the section.

  • value (Object)

    The value to store.

Returns:

  • (Boolean)

    result - True if successful, false if unsuccessful.

Version:

  • SketchUp 6.0