Class: Sketchup::Styles

Inherits:
Entity
  • Object
show all
Includes:
Enumerable
Defined in:
SketchUp/Sketchup/Styles.rb

Overview

The Styles class contains methods for manipulating a collection of styles in a model. Typically, you will access this via the active_model:

Examples:

styles = Sketchup.active_model.styles
puts "There are #{styles.size} styles in your model."

Version:

  • SketchUp 6.0

Instance Method Summary collapse

Methods inherited from Entity

#add_observer, #attribute_dictionaries, #attribute_dictionary, #delete_attribute, #deleted?, #entityID, #get_attribute, #inspect, #model, #persistent_id, #remove_observer, #set_attribute, #to_s, #typename, #valid?

Instance Method Details

#[](name) ⇒ Sketchup::Style? #[](index) ⇒ Sketchup::Style?

The #[] method is used to retrieves a style by either name or index.

Examples:

styles = Sketchup.active_model.styles
style1 = styles[0]
style2 = styles["MyStyle"]

Overloads:

Version:

  • SketchUp 6.0



38
39
 
# File 'SketchUp/Sketchup/Styles.rb', line 38

def [](arg)
end

#active_style ⇒ Sketchup::Style

The ##active_style method is used to retrieve the active style.

Examples:

styles = Sketchup.active_model.styles
style = styles.active_style

Returns:

Version:

  • SketchUp 6.0



50
51
 
# File 'SketchUp/Sketchup/Styles.rb', line 50

def active_style
end

#active_style_changed ⇒ Boolean

The #active_style_changed method tells you if the active style has been edited by the user since it was last saved.

Examples:

styles = Sketchup.active_model.styles
style_changed = styles.active_style_changed

Returns:

  • (Boolean)

Version:

  • SketchUp 6.0



63
64
 
# File 'SketchUp/Sketchup/Styles.rb', line 63

def active_style_changed
end

#add_style(filename, select) ⇒ Boolean

The #add_style method is used to create and load a style from the given file.

Examples:

filename = File.expand_path('./MyStyle.style')
styles = Sketchup.active_model.styles
status = styles.add_style(filename, true)

Parameters:

  • filename (String)
  • select (Boolean) —

    true if you want to set the style to be the active style.

Returns:

  • (Boolean)

Version:

  • SketchUp 6.0



83
84
 
# File 'SketchUp/Sketchup/Styles.rb', line 83

def add_style(filename, select)
end

#count ⇒ Integer

Note:

Since SketchUp 2014 the count method is inherited from Ruby’s Enumable mix-in module. Prior to that the #count method is an alias for #length.

Examples:

styles = Sketchup.active_model.styles
number = styles.count

Returns:

  • (Integer)

Version:

  • SketchUp 6.0



98
99
 
# File 'SketchUp/Sketchup/Styles.rb', line 98

def count
end

#each {|style| ... } ⇒ nil

The #each method is used to iterate through styles.

Examples:

styles = Sketchup.active_model.styles
styles.each { |style|
  puts style.name
}

Yield Parameters:

Returns:

  • (nil)

Version:

  • SketchUp 6.0



114
115
 
# File 'SketchUp/Sketchup/Styles.rb', line 114

def each
end

#length ⇒ Integer

The #length method is an alias of #size.

Examples:

styles = Sketchup.active_model.styles
number = styles.length

Returns:

  • (Integer)

See Also:

Version:

  • SketchUp 2014



128
129
 
# File 'SketchUp/Sketchup/Styles.rb', line 128

def length
end

#parent ⇒ Sketchup::Model

The #parent method is used to return the model for the styles.

Examples:

styles = Sketchup.active_model.styles
model = styles.parent

Returns:

Version:

  • SketchUp 6.0



140
141
 
# File 'SketchUp/Sketchup/Styles.rb', line 140

def parent
end

#purge_unused ⇒ true

The #purge_unused method is used to remove unused styles from the model.

Examples:

styles = Sketchup.active_model.styles
styles.purge_unused

Returns:

  • (true)

Version:

  • SketchUp 6.0



152
153
 
# File 'SketchUp/Sketchup/Styles.rb', line 152

def purge_unused
end

#selected_style ⇒ Sketchup::Style

The #selected_style method is used to retrieve the currently selected style.

Examples:

styles = Sketchup.active_model.styles
style = styles.selected_style

Returns:

Version:

  • SketchUp 6.0



164
165
 
# File 'SketchUp/Sketchup/Styles.rb', line 164

def selected_style
end

#selected_style=(style) ⇒ false

The #selected_style= method is used to set the currently selected style.

Examples:

styles = Sketchup.active_model.styles
styles.selected_style = styles.last

Parameters:

Returns:

  • (false)

Version:

  • SketchUp 6.0



178
179
 
# File 'SketchUp/Sketchup/Styles.rb', line 178

def selected_style=(style)
end

#size ⇒ Integer

The #size method is used to retrieve the number of styles in the collection.

Examples:

styles = Sketchup.active_model.styles
number = styles.size

Returns:

  • (Integer)

See Also:

Version:

  • SketchUp 6.0



193
194
 
# File 'SketchUp/Sketchup/Styles.rb', line 193

def size
end

#update_selected_style ⇒ true

The #update_selected_style method commits the current style settings to the style selected in the Style Browser.

Examples:

styles = Sketchup.active_model.styles
styles.update_selected_style

Returns:

  • (true)

See Also:

Version:

  • SketchUp 6.0



208
209
 
# File 'SketchUp/Sketchup/Styles.rb', line 208

def update_selected_style
end