Class: Sketchup::Console

Inherits:
Object
  • Object
show all
Defined in:
lib/sketchup-api-stubs/stubs/Sketchup/Console.rb

Overview

The Console class is used by SketchUp to direct $stdout and $stderr to the Ruby Console. It is a singleton class that only has one instance available. This instance is accessible via the SKETCHUP_CONSOLE constant.

In SketchUp 2014 methods were added to allow developers to control the visibility of the Ruby Console.

Also note that in SketchUp 2014, writing to the console does not work from within Ruby threads other than the main thread. So the following code will not produce any output.

Examples:

# By default $stdout is directed to SKETCHUP_CONSOLE.
p $stdout

# $stdout can however be redirected so the safe way to access the
# SketchUp console is by using the SKETCHUP_CONSOLE constant.
p SKETCHUP_CONSOLE
t = Thread.new { puts 'This will not be written to the console.' }
t.join

Version:

  • SketchUp 2014

Instance Method Summary collapse

Instance Method Details

#clear ⇒ Object

Clears the contents of SketchUp’s Ruby Console.

Examples:

SKETCHUP_CONSOLE.clear

Returns:

  • true.

Version:

  • SketchUp 2014



40
41
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Console.rb', line 40

def clear
end

#hide ⇒ Object

Hides the SketchUp Ruby Console.

Examples:

SKETCHUP_CONSOLE.hide

Returns:

  • true.

Version:

  • SketchUp 2014



51
52
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Console.rb', line 51

def hide
end

#show ⇒ Object

Displays the SketchUp Ruby Console.

Examples:

SKETCHUP_CONSOLE.show

Returns:

  • true.

Version:

  • SketchUp 2014



62
63
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Console.rb', line 62

def show
end

#visible? ⇒ Boolean

Returns the visibility state of the SketchUp Ruby Console.

Examples:

puts SKETCHUP_CONSOLE.visible?

Returns:

  • (Boolean) —

    true if visible, false if not.

Version:

  • SketchUp 2014



73
74
 
# File 'lib/sketchup-api-stubs/stubs/Sketchup/Console.rb', line 73

def visible?
end