Class: Sketchup::LayerFolder

Inherits:

Entity

• Object
• Entity
• Sketchup::LayerFolder

Includes:

Comparable

Defined in:

lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb

Overview

Note:

As of SketchUp 2020 “Layers” were renamed to “Tags” in the UI. The API retains the use of “Layer” for compatibility and is synonymous with “Tag”.

Allows layers to be organized in folders. Folders may have duplicate names.

Version:

• SketchUp 2021.0

Instance Method Summary

• #<=>(other) ⇒ Integer^?

  The #<=> method is used to compare two layer folders based on their names.

• #==(other) ⇒ Boolean

  The #== method is used to determine if two layer folders are the same.

• #add_folder(arg) ⇒ Sketchup::LayerFolder

  The #add_folder method adds or moves a layer folder.

• #add_layer(layer) ⇒ nil

  The #add_layer method adds a layer to a folder.

• #count_folders ⇒ Integer

  The #count_folders method retrieves the number of child folders in the folder.

• #count_layers ⇒ Integer (also: #length, #size)

  The #count_layers method retrieves the number of layers in the folder.

• #each_folder {|folder| ... } ⇒ Object

  The #each_folder method is used to iterate through the folders that are direct children to the folder.

• #each_layer {|layer| ... } ⇒ Object (also: #each)

  The #each_layer method is used to iterate through the layers that are direct children to the folder.

• #folder ⇒ Sketchup::LayerFolder^?

  The #folder method is used to return the parent layer folder of a layer folder.

• #folder=(parent) ⇒ Object

  The #folder= method is used to set the parent layer folder of a layer folder.

• #folders ⇒ Array<Sketchup::LayerFolder>

  The #folders returns the direct child-folders of the folder.

• #layers ⇒ Array<Sketchup::Layer>

  The #layers method retrieves the child layers of a folder.

• #name ⇒ String (also: #display_name)

  The #name method gets the name of the folder.

• #name=(name) ⇒ Object

  The #name= method sets the name of the folder.

• #remove_folder(folder) ⇒ nil

  The #remove_folder method removes the folder from the model.

• #remove_layer(layer) ⇒ nil

  The #remove_layer method removes a layer from a folder.

• #visible=(visible) ⇒ Object

  The #visible= method is used to set if the layer folder is visible.

• #visible? ⇒ Boolean

  The #visible? method is used to determine if the layer folder is visible.

• #visible_on_new_pages=(visible) ⇒ Object

  The #visible_on_new_pages= method is used to set if the layer folder is by default visible on new pages.

• #visible_on_new_pages? ⇒ Boolean

  The #visible_on_new_pages? method is used to determine if the layer folder is by default visible on new pages.

Methods inherited from Entity

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

Instance Method Details

#<=>(other) ⇒ Integer^?

The #<=> method is used to compare two layer folders based on their names. You could use this for sorting if you’re building a list of folder names.

Examples:

model = Sketchup.active_model
layers = model.layers
folder1 = layers.add('Folder1')
folder2 = layers.add('Folder2')
comparison = folder1 <=> folder2 # Returns: -1
comparison = folder1 <=> folder1 # Returns: 0
comparison = folder2 <=> folder1 # Returns: 1

Parameters:

• other (Object)

Returns:

• (Integer, nil) —

  -1 if the receiver should appear before other. 1 if the receiver should appear after other. 0 if the receiver and other are equal. nil if other is not comparable with the receiver.

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 43

def <=>(other)
end

#==(other) ⇒ Boolean

The #== method is used to determine if two layer folders are the same.

Examples:

model = Sketchup.active_model
layers = model.layers
folder1 = layers.add('Folder1')
folder2 = layers.add('Folder2')
equal = folder1 == folder2

Parameters:

• other (Object)

Returns:

• (Boolean)

Version:

• SketchUp 2021.0

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

def ==(other)
end

#add_folder(name) ⇒ Sketchup::LayerFolder #add_folder(folder) ⇒ Sketchup::LayerFolder

The #add_folder method adds or moves a layer folder.

Examples:

manager = Sketchup.active_model.layers
folder1 = manager.add_folder('Doors')
folder2 = folder1.add_folder('Outer Doors')

Overloads:

• #add_folder(name) ⇒ Sketchup::LayerFolder

  Adds a new folder with the given name. Unlike layers, folders do not need to have a unique name.

  Parameters:

  • name (String)
• #add_folder(folder) ⇒ Sketchup::LayerFolder

  Moves an existing Sketchup::LayerFolder to the receiver. This will include any children in the given folder.

  Parameters:

  • folder (Sketchup::LayerFolder)

  See Also:

  • Information on how which notifications trigger when reparenting an existing folder.

Returns:

• (Sketchup::LayerFolder)

See Also:

• #count_layers

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 93

def add_folder(arg)
end

#add_layer(layer) ⇒ nil

The #add_layer method adds a layer to a folder.

Examples:

manager = Sketchup.active_model.layers
layer = manager.add_layer('Inner Doors')
folder = manager.add_folder('Doors')

folder.add_layer(layer)

Parameters:

• layer (Sketchup::Layer)

Returns:

• (nil)

See Also:

• Information on how which notifications trigger when reparenting a layer.

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 116

def add_layer(layer)
end

#count_folders ⇒ Integer

The #count_folders method retrieves the number of child folders in the folder.

Examples:

layers = Sketchup.active_model.layers
folder1 = layers.add_folder('Hello')
folder2 = folder1.add_folder('World')
number = folder1.folder_count # Returns: 1

Returns:

• (Integer)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 133

def count_folders
end

#count_layers ⇒ Integer Also known as: length, size

The #count_layers method retrieves the number of layers in the folder.

Examples:

layers = Sketchup.active_model.layers
layer = layers.add_layer('World')
folder = layers.add_folder('Hello')
folder.add_layer(layer)
number = folder.layer_count # Returns: 1

Returns:

• (Integer)

See Also:

• #size
• #length

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 154

def count_layers
end

#each_folder {|folder| ... } ⇒ Object

The #each_folder method is used to iterate through the folders that are direct children to the folder.

Examples:

model = Sketchup.active_model
layers = model.layers
folder1 = layers.add_folder('Hello')
folder1.add_folder('World')
folder1.each_folder { | folder | puts folder.name }

Yields:

• (folder)

Yield Parameters:

• folder (Sketchup::LayerFolder)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 176

def each_folder
end

#each_layer {|layer| ... } ⇒ Object Also known as: each

The #each_layer method is used to iterate through the layers that are direct children to the folder.

Examples:

model = Sketchup.active_model
layers = model.layers
layer = layers.add_layer('World')
folder = layers.add_folder('Hello')
folder.add_layer(layer)
folder.each_layer { | layer | puts layer.name }

Yields:

• (layer)

Yield Parameters:

• layer (Sketchup::Layer)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 197

def each_layer
end

#folder ⇒ Sketchup::LayerFolder^?

The #folder method is used to return the parent layer folder of a layer folder.

Examples:

model = Sketchup.active_model
layers = model.layers
folder1 = layers.add('Folder1')
parent_folder = folder1.folder # Returns: nil

folder2 = folder1.add('Folder2')
parent_folder = folder2.folder # Returns: folder1

Returns:

• (Sketchup::LayerFolder, nil) —

  nil if the folder is a direct child to the layer manager.

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 219

def folder
end

#folder=(parent) ⇒ Object

The #folder= method is used to set the parent layer folder of a layer folder.

This will trigger onLayerFolderRemoved followed by onLayerFolderAdded.

Examples:

model = Sketchup.active_model
layers = model.layers
folder1 = layers.add('Folder1')
folder2 = layers.add('Folder2')

folder2.folder = folder1

Parameters:

• parent (Sketchup::LayerFolder, nil) —

  nil will make the the folder a direct child to the layer manager.

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 242

def folder=(parent)
end

#folders ⇒ Array<Sketchup::LayerFolder>

The #folders returns the direct child-folders of the folder.

Examples:

manager = Sketchup.active_model.layers
folder1 = manager.add_folder('Doors')
folder2 = folder1.add_folder('Windows')
folders = folder1.folders

Returns:

• (Array<Sketchup::LayerFolder>)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 258

def folders
end

#layers ⇒ Array<Sketchup::Layer>

The #layers method retrieves the child layers of a folder.

Examples:

manager = Sketchup.active_model.layers
folder = manager.add_folder('Hello')
folder.add_layer(manager.add_layer('World'))
folder.add_layer(manager.add_layer('Universe'))

layers = folder.layers

Returns:

• (Array<Sketchup::Layer>)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 276

def layers
end

#name ⇒ String Also known as: display_name

The #name method gets the name of the folder.

Examples:

manager = Sketchup.active_model.layers
folder = manager.add_folder('Doors')
name = folder.name

Returns:

• (String)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 291

def name
end

#name=(name) ⇒ Object

The #name= method sets the name of the folder.

Examples:

manager = Sketchup.active_model.layers
folder = manager.add_folder('Doors')
folder.name = 'Windows'

Parameters:

• name (String)

Raises:

• (ArgumentError) —

  if name is empty.

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 309

def name=(name)
end

#remove_folder(folder) ⇒ nil

The #remove_folder method removes the folder from the model. All children are preserved, but move up one level.

Examples:

manager = Sketchup.active_model.layers
folder1 = manager.add_folder('Doors')
folder2 = manager.add_folder('Outer Doors')
folder1.remove_folder(folder2)

Parameters:

• folder (Sketchup::LayerFolder)

Returns:

• (nil)

Raises:

• (ArgumentError) —

  if the folder is not a direct child of the receiver.

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 330

def remove_folder(folder)
end

#remove_layer(layer) ⇒ nil

The #remove_layer method removes a layer from a folder. The layer will be parent to the layer manager.

Examples:

manager = Sketchup.active_model.layers
layer = manager.add_layer('Inner Doors')
folder = manager.add_folder('Doors')
folder.add_layer(layer)

folder.remove_layer(layer)

Parameters:

• layer (Sketchup::Layer)

Returns:

• (nil)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 351

def remove_layer(layer)
end

#visible=(visible) ⇒ Object

The #visible= method is used to set if the layer folder is visible.

Examples:

model = Sketchup.active_model
layers = model.layers
folder = layers.add('Hello')
folder.visible = false

Parameters:

• visible (Boolean)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 367

def visible=(visible)
end

#visible? ⇒ Boolean

The #visible? method is used to determine if the layer folder is visible.

Examples:

model = Sketchup.active_model
layers = model.layers
folder = layers.add('Hello')
folder.visible? # Returns: true

Returns:

• (Boolean)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 383

def visible?
end

#visible_on_new_pages=(visible) ⇒ Object

The #visible_on_new_pages= method is used to set if the layer folder is by default visible on new pages.

Examples:

model = Sketchup.active_model
layers = model.layers
folder = layers.add_folder('Hello')
folder.visible_on_new_pages = false
page = model.pages.add('My Page')
model.pages.select_page = page # `folder` will now be hidden.

Parameters:

• visible (Boolean)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 402

def visible_on_new_pages=(visible)
end

#visible_on_new_pages? ⇒ Boolean

The #visible_on_new_pages? method is used to determine if the layer folder is by default visible on new pages.

Examples:

model = Sketchup.active_model
layers = model.layers
folder = layers.add_folder('Hello')
folder.visible_on_new_pages? # Returns: true

Returns:

• (Boolean)

Version:

• SketchUp 2021.0

# File 'lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb', line 419

def visible_on_new_pages?
end