class Sketchup::ComponentDefinition
The {Sketchup::ComponentDefinition} class is used to define the contents for a SketchUp component. Components are a collection of entities that can be instanced and reused multiple times throughout a model. For example, you could draw a chair once, turn it into a component, and then use 6 instances of it to surround a table. Edits to the original “definition” will then propagate across all of its instances.
The ComponentDefinition
class contains the global entities and settings for each definition. See the {Sketchup::ComponentInstance} class for how each copy is defined.
Starting from SketchUp 2018+, the {Sketchup::ComponentDefinition} class contains a new default attribute dictionary named “SU_DefinitionSet” with default keys named named “Price”, “Size”, “Url”. See the {help.sketchup.com/en/article/3000124 Help article} for more information. The dictionary cannot be deleted via ruby and an ArgumentError will be raised. The key/value pairs in the dictionary can be deleted safely.
@version SketchUp 6.0
Public Instance Methods
The <=> method is used to compare two ComponentDefinition
objects for sorting. The comparison is done based on the component name.
@example
c1=Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" c2=Sketchup.find_support_file "Fence.skp", "Components/Components Sampler/" if c1 <=> c2 UI.messagebox("c1 sorts before c2") end
@param [Sketchup::ComponentDefinition] compdef2
The second component definition in the comparison.
@return [Integer] a -1 if component1 is less then component2. A 1
if component1 greater than component2
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 50 def <=>(compdef2) end
The == method is used to test if two ComponentDefinition
objects are the same (based on their address in memory).
@example
c1=Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" c2=Sketchup.find_support_file "Fence.skp", "Components/Components Sampler/" if c1 == c2 UI.messagebox("These definitions are the same.") end
@param [Sketchup::ComponentDefinition] compdef2
The second component definition in the comparison.
@return [Boolean] true if the ComponentDefinition
objects are
the same object. False if the objects are not the same.
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 72 def ==(compdef2) end
The add_classification
method is used to add a given classification to the component.
Note that you cannot classify image definitions.
@example
definition = Sketchup.active_model.definitions.first success = definition.add_classification("IFC 2x3", "IfcDoor")
@param [String] schema_name
a String - Schema name to add
@param [String] schema_type
a String - Schema type to add
@return [Boolean] true if the classification succeeds. Otherwise false.
@version SketchUp 2015
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 93 def add_classification(schema_name, schema_type) end
The add_observer
method is used to add an observer to the current object.
@example
componentdefinition = Sketchup.active_model.definitions[0] status = componentdefinition.add_observer observer
@param [Object] observer
An observer.
@return [Boolean] true if successful, false if unsuccessful.
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 108 def add_observer(observer) end
The behavior method is used to retrieve the Behavior object associated with a component definition.
@example
path = Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" model = Sketchup.active_model definitions = model.definitions componentdefinition = definitions.load path behavior = componentdefinition.behavior
@return [Sketchup::Behavior] a Behavior object if successful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 125 def behavior end
The count_instances
method is used to count the number of unique component instances in a model using this component definition. This does not represent the total number of instances placed in the model as it doesn't take into account instances inside unused definitions.
@example
path = Sketchup.find_support_file('Bed.skp', 'Components/Components Sampler/') definitions = Sketchup.active_model.definitions definition = definitions.load(path) number = definition.count_instances
@return [Integer] the number of component instances of this
component definition (if successful)
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 144 def count_instances end
The count_used_instances
method is used to count the total number of component instances in a model using this component definition. This method takes into account the full hierarchy of the model.
@example
path = Sketchup.find_support_file('Bed.skp', 'Components/Components Sampler/') definitions = Sketchup.active_model.definitions definition = definitions.load(path) number = definition.count_used_instances
@return [Integer] the number of component instances of this
component definition (if successful)
@version SketchUp 2016
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 162 def count_used_instances end
The description method is used to retrieve the description of the component definition.
Component definitions do not have a description, by default.
@example
# Get the description componentdefinition = Sketchup.active_model.definitions[0] description = componentdefinition.description
@return [String] the description of the component definition if successful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 178 def description end
The description= method is used to set the description for the component definition.
@example
componentdefinition = Sketchup.active_model.definitions[0] componentdefinition.description = "This is a traditional bed" description = componentdefinition.description
@param [String] description
@return [String] the description if successful, false if
unsuccessful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 195 def description=(description) end
The entities method retrieves a collection of all the entities in the component definition
@example
componentdefinition = Sketchup.active_model.definitions[0] entities = componentdefinition.entities
@return [Sketchup::Entities] an Entities object if successful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 208 def entities end
The get_classification_value
method is used to retrieve the value from a classification attribute given a key path.
@example
definition = Sketchup.active_model.definitions.first definition.add_classification("IFC 2x3", "IfcDoor") path = ["IFC 2x3", "IfcDoor", "ObjectType", "IfcLabel"] value = definition.get_classification_value(path)
@param [Array<String>] path
An array composed of the key path to the value.
@return [Object, nil] a Ruby object if successful, nil otherwise.
@version SketchUp 2015
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 227 def get_classification_value(path) end
The group? method is used to determine if this component definition is used to hold the elements of a group.
@example
path = Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" model = Sketchup.active_model definitions = model.definitions componentdefinition = definitions.load path status = componentdefinition.group?
@return [Boolean]
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 244 def group? end
The guid method is used to retrieve the unique identifier of this component definition. The guid changes after the component definition is modified and the component edit is exited.
@example
componentdefinition = Sketchup.active_model.definitions[0] guid = componentdefinition.guid
@return [String] a string guid if successful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 258 def guid end
The image? method is used to determine if this component definition is used to define an image.
@example
componentdefinition = Sketchup.active_model.definitions[0] status = componentdefinition.image? if (status) UI.messagebox "Component definition defines an image" else UI.messagebox status.to_s UI.messagebox "Component definition does not define an image" end
@return [Boolean]
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 290 def image? end
The insertion_point
method is used to retrieve the Point3d object where the component was inserted.
@deprecated SketchUp 2020.0 removed the insertion point feature.
The getter will always return the origin point and the setter becomes a no-op.
@example
point = Geom::Point3d.new 10,20,30 transform = Geom::Transformation.new point model = Sketchup.active_model entities = model.active_entities path = Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" definitions = model.definitions componentdefinition = definitions.load path instance = entities.add_instance componentdefinition, transform point = componentdefinition.insertion_point
@return [Geom::Point3d] the Point3d where the component was inserted if
successful. False if unsuccessful.
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 316 def insertion_point end
Sets the insertion point of your definition.
@deprecated SketchUp 2020.0 removed the insertion point feature.
The getter will always return the origin point and the setter becomes a no-op.
@example
point = Geom::Point3d.new(10, 20, 0) componentdefinition = Sketchup.active_model.definitions[0] componentdefinition.insertion_point = point
@param [Geom::Point3d] point
The Point3d object to use as the insertion point.
@return [Geom::Point3d] The Point3d object used as the insertion point.
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 337 def insertion_point=(point) end
The instances method is used to return any array of ComponentInstancesfor this ComponentDefinition
.
@example
componentdefinition = Sketchup.active_model.definitions[0] instances = componentdefinition.instances
@return [Array<Sketchup::ComponentInstance>] an array of ComponentInstances
(if successful)
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 351 def instances end
The internal? method is used to determine if the component definition is internal to the Component Browser
@example
point = Geom::Point3d.new 10,20,30 transform = Geom::Transformation.new point model = Sketchup.active_model entities = model.active_entities path = Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" definitions = model.definitions componentdefinition = definitions.load path status = componentdefinition.internal?
@return [Boolean]
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 371 def internal? end
Invalidates the bounding box of your definition. This command forces the update of the bounding box of definition while inside an operation. See Model.start_operation for how to start an operation.
This method is useful if you make changes to your geometry using the Ruby API and then need to know your bounding box size. This method forces SketchUp to recalculate the definition's bounding box when you choose.
@example
componentdefinition = Sketchup.active_model.definitions[0] componentdefinition.invalidate_bounds
@return [Boolean] true if successful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 389 def invalidate_bounds end
The {#live_component?} method is used to identify Live Components and sub-definitions of Live Components.
@example Skipping Live Components
model = Sketchup.active_model model.definitions.each { |definition| next if definition.live_component? puts definition.name }
@note These components are parametrically generated and API users should not
modify them.
@return [Boolean]
@version SketchUp 2021.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 408 def live_component? end
The name method retrieves the name of the component definition.
@example
path = Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" model = Sketchup.active_model definitions = model.definitions componentdefinition = definitions.load path name = componentdefinition.name
@return [String] the component definition's name if successful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 424 def name end
The name= method is used to set the name of the component definition.
@example
path = Sketchup.find_support_file "Bed.skp", "Components/Components Sampler/" model = Sketchup.active_model definitions = model.definitions componentdefinition = definitions.load path name = componentdefinition.name="Bed"
@param [String] name
@return [String] the name assigned to the component definition if
successful
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 443 def name=(name) end
The path method is used to retrieve the path where the component was loaded.
@example
path = Sketchup.find_support_file("Bed.skp", "Components/Components Sampler/") model = Sketchup.active_model definitions = model.definitions componentdefinition = definitions.load(path) path = componentdefinition.path
@return [String] Returns empty string if it is an internal component.
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 458 def path end
The refresh_thumbnail
method is used to force SketchUp to regenerate the thumbnail image that appears in the component browser. This is useful if you've used the API to change the geometry of your component and would like the thumbnail to match.
@example
componentdefinition = Sketchup.active_model.definitions[0] componentdefinition.refresh_thumbnail
@return [nil]
@version SketchUp 7.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 473 def refresh_thumbnail end
The remove_classification
method is used to remove a given classification from the component.
Note that you cannot classify image definitions.
@example
definition = Sketchup.active_model.definitions.first success = definition.remove_classification("IFC 2x3", "IfcDoor")
@param [String] schema_name
Schema name to remove
@param [String] schema_type
Schema type to remove. If not provided or an empty string, the currently applied schema type for the given schema name will be removed.
@return [Boolean] true if the removal succeeds. Otherwise false.
@version SketchUp 2015
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 496 def remove_classification(schema_name, schema_type) end
The remove_observer
method is used to remove an observer from the current object.
@example
componentdefinition = Sketchup.active_model.definitions[0] status = componentdefinition.remove_observer observer
@param [Object] observer
An observer.
@return [Boolean] true if successful, false if unsuccessful.
@version SketchUp 6.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 512 def remove_observer(observer) end
The save_as
method is used to save your definition as a SketchUp file at the specified file destination.
@example
my_definition = Sketchup.active_model.definitions[0] success = my_definition.save_as "c:\\myComponent.skp"
@param [String] file_path
Local file path to save the .skp file to.
@return [Boolean] true if successful
@version SketchUp 7.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 528 def save_as(file_path) end
Saves a component thumbnail image. The image format is specified by the file extension of filePath. Supported image formats are bmp, jpg, png, tif, pct, and gif.
@example
componentdefinition = Sketchup.active_model.definitions[0] componentdefinition.save_thumbnail "test_thumb.png"
@param [String] filename
@return [Boolean] true if successful, false otherwise.
@version SketchUp 7.0
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 544 def save_thumbnail(filename) end
The set_classification_value
method is used to set the value of a classification attribute given a key path.
@example
definition = Sketchup.active_model.definitions.first definition.add_classification("IFC 2x3", "IfcDoor") path = ["IFC 2x3", "IfcDoor", "ObjectType", "IfcLabel"] success = definition.set_classification_value(path, "Room 101")
@param [Array<String>] path
An array composed of the key path to the value.
@param [Object] value
A value valid for that specific attribute.
@raise [NotImplementedError] when trying to set the value of “choice”
attributes.
@raise [RuntimeError] if the attributes being set are corrupt.
@raise [TypeError] when trying to set a value that is not valid for the
attribute.
@return [Boolean] true if the path was valid, false otherwise.
@version SketchUp 2015
# File lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb, line 574 def set_classification_value(path, value) end