Top Level Namespace

Defined Under Namespace

Modules: Geom, Layout, Sketchup, UI Classes: Array, LanguageHandler, Length, Numeric, SketchupExtension, String

Constant Summary collapse

ALT_MODIFIER_KEY = Constants

nil

ALT_MODIFIER_MASK = Stub value.

nil

ALeaderModel = Stub value.

nil

ALeaderNone = Stub value.

nil

ALeaderView = Stub value.

nil

COPY_MODIFIER_KEY = Stub value.

nil

COPY_MODIFIER_MASK = Stub value.

nil

CONSTRAIN_MODIFIER_KEY = Stub value.

nil

CONSTRAIN_MODIFIER_MASK = Stub value.

nil

CMD_ARC = Stub value.

nil

CMD_CAMERA_UNDO = Stub value.

nil

CMD_CIRCLE = Stub value.

nil

CMD_COPY = Stub value.

nil

CMD_CUT = Stub value.

nil

CMD_DELETE = Stub value.

nil

CMD_DIMENSION = Stub value.

nil

CMD_DISPLAY_FOV = Stub value.

nil

CMD_DOLLY = Stub value.

nil

CMD_DRAWCUTS = Stub value.

nil

CMD_DRAWOUTLINES = Stub value.

nil

CMD_ERASE = Stub value.

nil

CMD_EXTRUDE = Stub value.

nil

CMD_FREEHAND = Stub value.

nil

CMD_HIDDENLINE = Stub value.

nil

CMD_LINE = Stub value.

nil

CMD_MAKE_COMPONENT = Stub value.

nil

CMD_MEASURE = Stub value.

nil

CMD_MOVE = Stub value.

nil

CMD_NEW = Stub value.

nil

CMD_OFFSET = Stub value.

nil

CMD_OPEN = Stub value.

nil

CMD_ORBIT = Stub value.

nil

CMD_PAGE_DELETE = Stub value.

nil

CMD_PAGE_NEW = Stub value.

nil

CMD_PAGE_NEXT = Stub value.

nil

CMD_PAGE_PREVIOUS = Stub value.

nil

CMD_PAGE_UPDATE = Stub value.

nil

CMD_PAINT = Stub value.

nil

CMD_PAN = Stub value.

nil

CMD_PASTE = Stub value.

nil

CMD_POLYGON = Stub value.

nil

CMD_POSITION_CAMERA = Stub value.

nil

CMD_PRINT = Stub value.

nil

CMD_PROTRACTOR = Stub value.

nil

CMD_PUSHPULL = Stub value.

nil

CMD_RECTANGLE = Stub value.

nil

CMD_REDO = Stub value.

nil

CMD_ROTATE = Stub value.

nil

CMD_RUBY_CONSOLE = Stub value.

nil

CMD_SAVE = Stub value.

nil

CMD_SCALE = Stub value.

nil

CMD_SECTION = Stub value.

nil

CMD_SELECT = Stub value.

nil

CMD_SELECTION_ZOOM_EXT = Stub value.

nil

CMD_SHADED = Stub value.

nil

CMD_SHOWGUIDES = Stub value.

nil

CMD_SHOWHIDDEN = Stub value.

nil

CMD_SHOWHIDDENGEOMETRY = Stub value.

nil

CMD_SHOWHIDDENOBJECTS = Stub value.

nil

CMD_SKETCHAXES = Stub value.

nil

CMD_SKETCHCS = Stub value.

nil

CMD_TEXT = Stub value.

nil

CMD_TEXTURED = Stub value.

nil

CMD_TRANSPARENT = Stub value.

nil

CMD_UNDO = Stub value.

nil

CMD_VIEW_BACK = Stub value.

nil

CMD_VIEW_BOTTOM = Stub value.

nil

CMD_VIEW_FRONT = Stub value.

nil

CMD_VIEW_ISO = Stub value.

nil

CMD_VIEW_LEFT = Stub value.

nil

CMD_VIEW_PERSPECTIVE = Stub value.

nil

CMD_VIEW_RIGHT = Stub value.

nil

CMD_VIEW_TOP = Stub value.

nil

CMD_WALK = Stub value.

nil

CMD_WIREFRAME = Stub value.

nil

CMD_ZOOM = Stub value.

nil

CMD_ZOOM_EXTENTS = Stub value.

nil

CMD_ZOOM_WINDOW = Stub value.

nil

DimensionArrowClosed = Stub value.

nil

DimensionArrowDot = Stub value.

nil

DimensionArrowNone = Stub value.

nil

DimensionArrowOpen = Stub value.

nil

DimensionArrowSlash = Stub value.

nil

FILE_WRITE_FAILED_INVALID_TYPE = Stub value.

nil

FILE_WRITE_FAILED_UNKNOWN = Stub value.

nil

FILE_WRITE_OK = Stub value.

nil

GL_LINES = Stub value.

nil

GL_LINE_LOOP = Stub value.

nil

GL_LINE_STRIP = Stub value.

nil

GL_POINTS = Stub value.

nil

GL_POLYGON = Stub value.

nil

GL_QUADS = Stub value.

nil

GL_QUAD_STRIP = Stub value.

nil

GL_TRIANGLES = Stub value.

nil

GL_TRIANGLE_FAN = Stub value.

nil

GL_TRIANGLE_STRIP = Stub value.

nil

IDENTITY = Stub value.

nil

IDENTITY_2D = Stub value.

nil

IDABORT = Stub value.

nil

IDCANCEL = Stub value.

nil

IDIGNORE = Stub value.

nil

IDNO = Stub value.

nil

IDOK = Stub value.

nil

IDRETRY = Stub value.

nil

IDYES = Stub value.

nil

LAYER_HIDDEN_BY_DEFAULT = Stub value.

nil

LAYER_IS_HIDDEN_ON_NEW_PAGES = Stub value.

nil

LAYER_IS_VISIBLE_ON_NEW_PAGES = Stub value.

nil

LAYER_USES_DEFAULT_VISIBILITY_ON_NEW_PAGES = Stub value.

nil

LAYER_VISIBLE_BY_DEFAULT = Stub value.

nil

MB_ABORTRETRYIGNORE = Stub value.

nil

MB_MULTILINE = Stub value.

nil

MB_OK = Stub value.

nil

MB_OKCANCEL = Stub value.

nil

MB_RETRYCANCEL = Stub value.

nil

MB_YESNO = Stub value.

nil

MB_YESNOCANCEL = Stub value.

nil

MF_CHECKED = Stub value.

nil

MF_DISABLED = Stub value.

nil

MF_ENABLED = Stub value.

nil

MF_GRAYED = Stub value.

nil

MF_UNCHECKED = Stub value.

nil

ORIGIN = Stub value.

nil

ORIGIN_2D = Stub value.

nil

PAGE_NO_CAMERA = Stub value.

nil

PAGE_USE_ALL = Stub value.

nil

PAGE_USE_CAMERA = Stub value.

nil

PAGE_USE_HIDDEN = Stub value.

nil

PAGE_USE_LAYER_VISIBILITY = Stub value.

nil

PAGE_USE_RENDERING_OPTIONS = Stub value.

nil

PAGE_USE_SECTION_PLANES = Stub value.

nil

PAGE_USE_SHADOWINFO = Stub value.

nil

PAGE_USE_SKETCHCS = Stub value.

nil

SB_PROMPT = Stub value.

nil

SB_VCB_LABEL = Stub value.

nil

SB_VCB_VALUE = Stub value.

nil

SKETCHUP_CONSOLE = Stub value.

nil

SnapTo_Arbitrary = Stub value.

nil

SnapTo_Horizontal = Stub value.

nil

SnapTo_Sloped = Stub value.

nil

SnapTo_Vertical = Stub value.

nil

TB_HIDDEN = Stub value.

nil

TB_NEVER_SHOWN = Stub value.

nil

TB_VISIBLE = Stub value.

nil

TextAlignCenter = Stub value.

nil

TextAlignLeft = Stub value.

nil

TextAlignRight = Stub value.

nil

TextVerticalAlignBaseline = Stub value.

nil

TextVerticalAlignBoundsTop = Stub value.

nil

TextVerticalAlignCapHeight = Stub value.

nil

TextVerticalAlignCenter = Stub value.

nil

VK_DELETE = Stub value.

nil

VK_DOWN = Stub value.

nil

VK_END = Stub value.

nil

VK_HOME = Stub value.

nil

VK_INSERT = Stub value.

nil

VK_LEFT = Stub value.

nil

VK_NEXT = Stub value.

nil

VK_PRIOR = Stub value.

nil

VK_RIGHT = Stub value.

nil

VK_SPACE = Stub value.

nil

VK_UP = Stub value.

nil

VK_ALT = Stub value.

nil

VK_COMMAND = Stub value.

nil

VK_CONTROL = Stub value.

nil

VK_MENU = Stub value.

nil

VK_SHIFT = Stub value.

nil

X_AXIS_2D = Stub value.

nil

Y_AXIS_2D = Stub value.

nil

X_AXIS = Stub value.

nil

Y_AXIS = Stub value.

nil

Z_AXIS = Stub value.

nil

Instance Method Summary collapse

#add_separator_to_menu(menu_name) ⇒ Object deprecated Deprecated.

Avoid adding separators to top level menus. If you require grouping use a sub-menu instead.
#file_loaded(filename) ⇒ Object

Call this function at the end of a file that you are loading to let the system know that you have loaded it.
#file_loaded?(filename) ⇒ Boolean

Use in combination with #file_loaded to create load guards for code you don’t want to reload.
#inputbox(*args) ⇒ Object

This is a wrapper for UI.inputbox.
#require_all(dirname) ⇒ Object deprecated Deprecated.

This adds the path given to $LOAD_PATH which can affect other extensions.
#show_ruby_panel ⇒ Object deprecated Deprecated.

Use SKETCHUP_CONSOLE.show instead.

Instance Method Details

#add_separator_to_menu(menu_name) ⇒ `Object`

Deprecated.

Avoid adding separators to top level menus. If you require grouping use a sub-menu instead.

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.

Parameters:

menu_name (String)

Version:

SketchUp 6.0



216
217

# File 'lib/sketchup-api-stubs/stubs/_top_level.rb', line 216

def add_separator_to_menu(menu_name)
end

#file_loaded(filename) ⇒ `Object`

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

Examples:

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

Parameters:

filename (String)

#file_loaded?(filename) ⇒ `Boolean`

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.

Examples:

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

Parameters:

filename (String)

Returns:

(Boolean)

#inputbox(*args) ⇒ `Object`

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.

#require_all(dirname) ⇒ `Object`

Deprecated.

This adds the path given to $LOAD_PATH which can affect other extensions.

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"

Parameters:

dirname (String)

Version:

SketchUp 6.0



296
297

# File 'lib/sketchup-api-stubs/stubs/_top_level.rb', line 296

def require_all(dirname)
end

#show_ruby_panel ⇒ `Object`

Deprecated.

Use SKETCHUP_CONSOLE.show instead.

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.

Version:

SketchUp 6.0



306
307

# File 'lib/sketchup-api-stubs/stubs/_top_level.rb', line 306

def show_ruby_panel
end

Top Level Namespace

Defined Under Namespace

Constant Summary collapse

Instance Method Summary collapse

Instance Method Details

#add_separator_to_menu(menu_name) ⇒ Object

#file_loaded(filename) ⇒ Object

Examples:

#file_loaded?(filename) ⇒ Boolean

Examples:

#inputbox(*args) ⇒ Object

#require_all(dirname) ⇒ Object

#show_ruby_panel ⇒ Object

#add_separator_to_menu(menu_name) ⇒ `Object`

#file_loaded(filename) ⇒ `Object`

#file_loaded?(filename) ⇒ `Boolean`

#inputbox(*args) ⇒ `Object`

#require_all(dirname) ⇒ `Object`

#show_ruby_panel ⇒ `Object`