class Object

Constants

ALT_MODIFIER_KEY

Constants

ALT_MODIFIER_MASK
ALeaderModel
ALeaderNone
ALeaderView
CMD_ARC
CMD_CAMERA_UNDO
CMD_CIRCLE
CMD_COPY
CMD_CUT
CMD_DELETE
CMD_DIMENSION
CMD_DISPLAY_FOV
CMD_DOLLY
CMD_DRAWCUTS
CMD_DRAWOUTLINES
CMD_ERASE
CMD_EXTRUDE
CMD_FREEHAND
CMD_HIDDENLINE
CMD_LINE
CMD_MAKE_COMPONENT
CMD_MEASURE
CMD_MOVE
CMD_NEW
CMD_OFFSET
CMD_OPEN
CMD_ORBIT
CMD_PAGE_DELETE
CMD_PAGE_NEW
CMD_PAGE_NEXT
CMD_PAGE_PREVIOUS
CMD_PAGE_UPDATE
CMD_PAINT
CMD_PAN
CMD_PASTE
CMD_POLYGON
CMD_POSITION_CAMERA
CMD_PRINT
CMD_PROTRACTOR
CMD_PUSHPULL
CMD_RECTANGLE
CMD_REDO
CMD_ROTATE
CMD_RUBY_CONSOLE
CMD_SAVE
CMD_SCALE
CMD_SECTION
CMD_SELECT
CMD_SELECTION_ZOOM_EXT
CMD_SHADED
CMD_SHOWGUIDES
CMD_SHOWHIDDEN
CMD_SHOWHIDDENGEOMETRY
CMD_SHOWHIDDENOBJECTS
CMD_SKETCHAXES
CMD_SKETCHCS
CMD_TEXT
CMD_TEXTURED
CMD_TRANSPARENT
CMD_UNDO
CMD_VIEW_BACK
CMD_VIEW_BOTTOM
CMD_VIEW_FRONT
CMD_VIEW_ISO
CMD_VIEW_LEFT
CMD_VIEW_PERSPECTIVE
CMD_VIEW_RIGHT
CMD_VIEW_TOP
CMD_WALK
CMD_WIREFRAME
CMD_ZOOM
CMD_ZOOM_EXTENTS
CMD_ZOOM_WINDOW
CONSTRAIN_MODIFIER_KEY
CONSTRAIN_MODIFIER_MASK
COPY_MODIFIER_KEY
COPY_MODIFIER_MASK
DimensionArrowClosed
DimensionArrowDot
DimensionArrowNone
DimensionArrowOpen
DimensionArrowSlash
FILE_WRITE_FAILED_INVALID_TYPE
FILE_WRITE_FAILED_UNKNOWN
FILE_WRITE_OK
GL_LINES
GL_LINE_LOOP
GL_LINE_STRIP
GL_POINTS
GL_POLYGON
GL_QUADS
GL_QUAD_STRIP
GL_TRIANGLES
GL_TRIANGLE_FAN
GL_TRIANGLE_STRIP
IDABORT
IDCANCEL
IDENTITY
IDENTITY_2D
IDIGNORE
IDNO
IDOK
IDRETRY
IDYES
LAYER_HIDDEN_BY_DEFAULT
LAYER_IS_HIDDEN_ON_NEW_PAGES
LAYER_IS_VISIBLE_ON_NEW_PAGES
LAYER_USES_DEFAULT_VISIBILITY_ON_NEW_PAGES
LAYER_VISIBLE_BY_DEFAULT
MB_ABORTRETRYIGNORE
MB_MULTILINE
MB_OK
MB_OKCANCEL
MB_RETRYCANCEL
MB_YESNO
MB_YESNOCANCEL
MF_CHECKED
MF_DISABLED
MF_ENABLED
MF_GRAYED
MF_UNCHECKED
ORIGIN
ORIGIN_2D
PAGE_NO_CAMERA
PAGE_USE_ALL
PAGE_USE_CAMERA
PAGE_USE_HIDDEN
PAGE_USE_HIDDEN_GEOMETRY
PAGE_USE_HIDDEN_OBJECTS
PAGE_USE_LAYER_VISIBILITY
PAGE_USE_RENDERING_OPTIONS
PAGE_USE_SECTION_PLANES
PAGE_USE_SHADOWINFO
PAGE_USE_SKETCHCS
SB_PROMPT
SB_VCB_LABEL
SB_VCB_VALUE
SKETCHUP_CONSOLE
SnapTo_Arbitrary
SnapTo_Horizontal
SnapTo_Sloped
SnapTo_Vertical
TB_HIDDEN
TB_NEVER_SHOWN
TB_VISIBLE
TextAlignCenter
TextAlignLeft
TextAlignRight
TextVerticalAlignBaseline
TextVerticalAlignBoundsTop
TextVerticalAlignCapHeight
TextVerticalAlignCenter
VK_ALT
VK_COMMAND
VK_CONTROL
VK_DELETE
VK_DOWN
VK_END
VK_HOME
VK_INSERT
VK_LEFT
VK_MENU
VK_NEXT
VK_PRIOR
VK_RIGHT
VK_SHIFT
VK_SPACE
VK_UP
X_AXIS
X_AXIS_2D
Y_AXIS
Y_AXIS_2D
Z_AXIS

Public Instance Methods

add_separator_to_menu(menu_name) click to toggle source

This function will add a separator to a given menu the first time it is called. It is useful for adding a separator before the first plugin that is added to a given menu.

@deprecated Avoid adding separators to top level menus. If you require

grouping use a sub-menu instead.

@param [String] menu_name

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/_top_level.rb, line 218
def add_separator_to_menu(menu_name)
end
file_loaded(filename) click to toggle source

Call this function at the end of a file that you are loading to let the system know that you have loaded it.

@example

module Example
  unless file_loaded?(__FILE__)
    menu = UI.menu('Plugins')
    menu.add_item('Example') { self.hello }
    file_loaded(__FILE__)
  end

  def self.hello
    puts 'Hello World'
  end

end

@param [String] filename

@see file_loaded?

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/_top_level.rb, line 243
def file_loaded(filename)
end
file_loaded?(filename) click to toggle source

Use in combination with {#file_loaded} to create load guards for code you don't want to reload. Especially useful to protect your UI setup from creating duplicate menus and toolbars.

@example

module Example
  unless file_loaded?(__FILE__)
    menu = UI.menu('Plugins')
    menu.add_item('Example') { self.hello }
    file_loaded(__FILE__)
  end

  def self.hello
    puts 'Hello World'
  end

end

@param [String] filename

@return [Boolean]

@see file_loaded

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/_top_level.rb, line 271
def file_loaded?(filename)
end
inputbox(*args) click to toggle source

This is a wrapper for {UI.inputbox}. You call it exactly the same as {UI.inputbox}. {UI.inputbox} will raise an exception if it can't convert the string entered for one of the values into the right type. This method will trap the exception and display an error dialog and then prompt for the values again.

@see UI.inputbox

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/_top_level.rb, line 283
def inputbox(*args)
end
require_all(dirname) click to toggle source

By default, SketchUp automatically loads (using require) all files with the .rb extension in the plugins directory. This function can be used to automatically load all .rb files from a different directory also. to use this add a call like the following to a file in the plugins directory require_all "MyRubyScripts"

@deprecated This adds the path given to +$LOAD_PATH+ which can affect

other extensions.

@param [String] dirname

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/_top_level.rb, line 298
def require_all(dirname)
end
show_ruby_panel() click to toggle source

This global method is called by the Ruby Console menu item. We call this instead of directly calling Sketchup.send_action("showRubyPanel:") so that other Ruby Console implementations can hijack this method.

@deprecated Use SKETCHUP_CONSOLE.show instead.

@version SketchUp 6.0

# File lib/sketchup-api-stubs/stubs/_top_level.rb, line 308
def show_ruby_panel
end