ComponentInstance

class

• Introduction
• Methods
• • add_observer
  • definition
  • definition=
  • explode
  • glued_to
  • glued_to=
  • locked=
  • locked?
  • make_unique
  • move!
  • name
  • name=
  • remove_observer
  • transform!
  • transformation
  • transformation=

Introduction

Methods

ComponentInstance.add_observerSketchUp 6.0+

The add_observer method is used to add an observer to the current object.

Arguments:

observer

An observer.

Returns:

true if successful, false if unsuccessful.

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 status = componentinstance.add_observer observer

ComponentInstance.definitionSketchUp 6.0+

The definition method is used to retrieve the component definition for this component instance.

Returns:

componentdefinition

a ComponentDefinition object if successful

 # First create an instance for us to look at.
 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)

 # You can get an instance's defintion with this method.
 definition = componentinstance.definition

ComponentInstance.definition=SketchUp 6.0+

The definition= method is used to set the component definition for this component.

This method causes the instance to use a different definition, but it will use the same transformation to position it in the Model.

Arguments:

definition

A ComponentDefinition object to set.

Returns:

componentdefinition

the ComponentDefinition object that was set if successful, false if unsuccessful

 # Assumes that the active model contains two different components.
 instance1 = Sketchup.active_model.entities[0]
 instance2 = Sketchup.active_model.entities[1]

 # Grab handles to our two definitions.
 definition1 = instance1.definition
 definition2 = instance2.definition

 # Replace 2nd instance with the 1st definition.
 instance2.definition = definition1

ComponentInstance.explodeSketchUp 6.0+

The explode method is used to explode the component instance into separate entities.

Returns:

entities

an Entities object if successful, false if unsuccessful

 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

ComponentInstance.glued_toSketchUp 6.0+

The glued_to method is used to retrieve the entity that this instance is glued to.

Returns nil if it is not glued to anything.

Returns:

entity

the Entity object that the instance is glued to (if successful)

 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
 status = instance.glued_to

ComponentInstance.glued_to=SketchUp 6.0+

The glued_to= method glues this instance to a face.

This method will raise an exception if the instance cannot be glued to the given face. Instances cannot be glued if the definition of the instance doesn't support gluing or if the alignment is wrong.

Returns:

face

the Face object where the component is glued if successful

 depth = 100
 width = 100
 path=Sketchup.find_support_file "Bed.skp",
   "Components/Components Sampler/"
 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [width, 0, 0]
 pts[2] = [width, depth, 0]
 pts[3] = [0, depth, 0]
 # Add the face to the entities in the model
 face = entities.add_face pts
 point = Geom::Point3d.new 10,10,0
 transform = Geom::Transformation.new point
 definitions = model.definitions
 componentdefinition = definitions.load path
 instance = entities.add_instance componentdefinition, transform
 begin
   status = instance.glued_to = face
 rescue
   UI.messagebox $!.message
 end
 if (status)
   UI.messagebox status.to_s
 else
   UI.messagebox "Failure"
 end

ComponentInstance.locked=SketchUp 6.0+

The locked= method is used to lock a component instance.

Returns:

status

true if the component instance is locked. False if the instance is not locked.

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 status = componentinstance.locked = true

ComponentInstance.locked?SketchUp 6.0+

The locked? method is used to determine if a component instance is locked.

Returns:

status

true if the component instance is locked. False if the instance is not locked.

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 status = componentinstance.locked?

ComponentInstance.make_uniqueSketchUp 6.0+

The make_unique method is used to create a component definition for this instance that is not used by any other instances.

Returns:

status

true if successful, false if unsuccessful

 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
 # Returns unique component instance
 status = instance.make_unique

ComponentInstance.move!SketchUp 6.0+

The move! method is the same as the transform! method, except that it does not record the move as an undo operation.

This method is useful for moving entities inside of an animation or page transition.

Arguments:

transform

The transform object to apply to the component instance.

Returns:

status

true if successful, false if unsuccessful

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 new_transformation = Geom::Transformation.new([100,0,0])
 componentinstance.move! new_transformation

ComponentInstance.nameSketchUp 6.0+

The name method is used to get the name of this instance.

Returns:

name

the string name of the ComponentInstance

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 name = componentinstance.name

ComponentInstance.name=SketchUp 6.0+

The name method is used to set the name of this instance.

Arguments:

name

name - the string name to set

Returns:

instance

the newly named ComponentInstance

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 componentinstance.name = "Sang"

ComponentInstance.remove_observerSketchUp 6.0+

The remove_observer method is used to remove an observer from the current object.

Arguments:

observer

An observer.

Returns:

true if successful, false if unsuccessful.

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 status = componentinstance.remove_observer observer

ComponentInstance.transform!SketchUp 6.0+

The transform! method is used to apply a transformation to a component instance.

Arguments:

transform

The transform object to apply to the component instance.

Returns:

status

true if successful, false if unsuccessful

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 new_transformation = Geom::Transformation.new([100,0,0])
 componentinstance.transform! new_transformation

ComponentInstance.transformationSketchUp 6.0+

The transformation method is used to retrieve the transformation of this instance.

Returns:

transformation

the Transformation object if successful

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 t = componentinstance.transformation

ComponentInstance.transformation=SketchUp 6.0+

The transformation= method is used to set the transformation on this instance.

Arguments:

tranform

A Transformation object to apply.

Returns:

instance

the transformed ComponentInstance

 entities = Sketchup.active_model.entities
 definition = Sketchup.active_model.definitions[0]
 transformation = Geom::Transformation.new([0,0,0])
 componentinstance = entities.add_instance(definition, transformation)
 new_transformation = Geom::Transformation.new([100,0,0])
 componentinstance.transformation = new_transformation