sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/ComponentInstance.rb

@@ -0,0 +1,597 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The ComponentInstance class is used to represent component instances of a
+# component definition or components that have been dragged from the Component
+# Browser and placed (thus, instanced) within the Model. Therefore, the
+# ComponentInstance class contains a reference to a corresponding
+# ComponentDefinition object and a Transformation object (which contains the
+# location of the component in the Drawing Window).
+#
+# @version SketchUp 6.0
+class Sketchup::ComponentInstance < Sketchup::Drawingelement
+
+  # Instance Methods
+
+  # The add_observer method is used to add an observer to the current object.
+  #
+  # @example
+  #   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
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def add_observer(observer)
+  end
+
+  # The definition method is used to retrieve the component definition for this
+  # component instance.
+  #
+  # @example
+  #   # 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 definition with this method.
+  #   definition = componentinstance.definition
+  #
+  # @return componentdefinition - a ComponentDefinition object if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def definition
+  end
+
+  # 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.
+  #
+  # @example
+  #   # 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
+  #
+  # @param definition
+  #   A ComponentDefinition object to set.
+  #
+  # @return componentdefinition - the ComponentDefinition object
+  #   that was set if successful, false if unsuccessful
+  #
+  # @version SketchUp 6.0
+  def definition=(definition)
+  end
+
+  # The equals? method is used to determine if a component instance is
+  # geometrically equivalent to another instance.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   status = instance1.equals?(instance2)
+  #
+  # @param instance
+  #   The instance to compare this instance with.
+  #
+  # @return status - true if the instances are geometrically
+  #   equivalent.
+  #   Otherwise false.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 8.0
+  def equals?(instance)
+  end
+
+  # The explode method is used to explode the component instance into separate
+  # entities.
+  #
+  # @example
+  #   # Assuming 'instance' is a ComponentInstance object
+  #   array = instance.explode
+  #   if array
+  #     UI.messagebox "Exploded the component instance"
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return An array of entity objects if successful, false if
+  #   unsuccessful
+  #
+  # @version SketchUp 6.0
+  def explode
+  end
+
+  # 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.
+  #
+  # @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
+  #   status = instance.glued_to
+  #
+  # @return entity - the Entity object that the instance is glued
+  #   to (if successful)
+  #
+  # @version SketchUp 6.0
+  def glued_to
+  end
+
+  # 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.
+  #
+  # @example
+  #   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
+  #
+  # @param [Sketchup::Face] face
+  #
+  # @return face - the Face object where the component is glued if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def glued_to=(face)
+  end
+
+  # The guid method is used to get the base 64 encoded unique id
+  # for this SketchUp object.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   definition = Sketchup.active_model.definitions[0]
+  #   transformation = Geom::Transformation.new([0,0,0])
+  #   componentinstance = entities.add_instance(definition, transformation)
+  #   guid = componentinstance.guid
+  #
+  # @return guid - a unique 22 character string
+  #
+  # @version SketchUp 2014
+  def guid
+  end
+
+  # The intersect method is used to compute the boolean intersection of two
+  # instances representing manifold solid volumes (this - arg).  If the specified
+  # objects (this and arg) do not represent manifold volumes, this method fails.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   result = instance1.intersect(instance2)
+  #
+  # @param instance
+  #   The instance to intersect this instance with.
+  #
+  # @return result - The resultant group if the two objects
+  #   (this and arg) represent manifold solids and the
+  #   operation succeeds otherwise nil is returned.
+  #
+  # @version SketchUp 8.0
+  def intersect(instance)
+  end
+
+  # The locked= method is used to lock a component instance.
+  #
+  # @example
+  #   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
+  #
+  # @param [Boolean] lock
+  #
+  # @return status - true if the component instance is locked.
+  #   False if the instance is not locked.
+  #
+  # @version SketchUp 6.0
+  def locked=(lock)
+  end
+
+  # The locked? method is used to determine if a component instance is locked.
+  #
+  # @example
+  #   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?
+  #
+  # @return status - true if the component instance is locked.
+  #   False if the instance is not locked.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def locked?
+  end
+
+  # The make_unique method is used to create a component definition for this
+  # instance that is not used by any other instances.
+  #
+  # @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
+  #   # Returns unique component instance
+  #   status = instance.make_unique
+  #
+  # @return status - true if successful, false if unsuccessful
+  #
+  # @version SketchUp 6.0
+  def make_unique
+  end
+
+  # The manifold? method is used to determine if an instance is manifold.
+  #
+  # @example
+  #   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.manifold?
+  #
+  # @return status - true if the instance is manifold.
+  #   false if the instance is not manifold.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 8.0
+  def manifold?
+  end
+
+  # 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.
+  #
+  # @example
+  #   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
+  #
+  # @param transform
+  #   The transform object to apply to the component instance.
+  #
+  # @return status - true if successful, false if unsuccessful
+  #
+  # @version SketchUp 6.0
+  def move!(transform)
+  end
+
+  # The name method is used to get the name of this instance.
+  #
+  # @example
+  #   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
+  #
+  # @return name - the string name of the ComponentInstance
+  #
+  # @version SketchUp 6.0
+  def name
+  end
+
+  # The name method is used to set the name of this instance.
+  #
+  # @example
+  #   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"
+  #
+  # @param name
+  #   name - the string name to set
+  #
+  # @return instance - the newly named ComponentInstance
+  #
+  # @version SketchUp 6.0
+  def name=(name)
+  end
+
+  # The outer_shell method is used to compute the outer shell of the two
+  # instances representing manifold solid volumes (this || arg). If the specified
+  # objects (this and arg) do not represent manifold volumes, this method fails.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   result = instance1.outer_shell(instance2)
+  #
+  # @param instance
+  #   The instance to outer shell this instance with.
+  #
+  # @return result - The resultant group if the two objects
+  #   (this and arg) represent manifold solids and the
+  #   operation succeeds otherwise nil is returned.
+  #
+  # @version SketchUp 8.0
+  def outer_shell(instance)
+  end
+
+  # The remove_observer method is used to remove an observer from the current
+  # object.
+  #
+  # @example
+  #   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
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def remove_observer(observer)
+  end
+
+  # The show_differences method is used to determine if a component instance is
+  # geometrically equivalent to another instance and in addition move the non-
+  # matching and matching geometry to new layers.
+  #
+  # This method will move both instances to Layer0.  Geometry that is the same
+  # in both components will be moved to a new layer named def_name + "_same".
+  # Geometry that is not the same will be moved to a layer named def_name +
+  # "_diff".
+  #
+  # If verbose is true, a list of all the geometry that is different
+  # from one component to the other is displayed texturally in the Ruby Console.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   status = instance1.show_differences(instance2, true)
+  #
+  # @param instance
+  #   The instance to be compared with.
+  #
+  # @param verbose
+  #   A boolean flag indicating whether to display a textural
+  #   report of the found differences to the Ruby console.
+  #
+  # @return status - true if the instances are geometrically
+  #   equivalent, otherwise false.
+  #
+  # @version SketchUp 8.0
+  def show_differences(instance, verbose)
+  end
+
+  # The split method is used to compute the boolean split (map overlay)of the two
+  # instances representing manifold solid volumes (this - arg).  If the specified
+  # objects (this and arg) do not represent manifold volumes, this method fails.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   result = instance1.split(instance2)
+  #
+  # @param instance
+  #   The instance to split this instance with.
+  #
+  # @return result - A vector (array) of the three resultant groups
+  #   if the two objects (this and arg) represent manifold
+  #   solids and the operation succeeds otherwise Qnil is
+  #   returned. The 3 groups are as follows: The intersection
+  #   of volume 1 & volume 2, the difference of
+  #   volume 1 minus volume 2, and the reverse difference of
+  #   volume 2 minus volume 1.
+  #
+  # @version SketchUp 8.0
+  def split(instance)
+  end
+
+  # The subtract method is used to compute the boolean difference of the two
+  # instances representing manifold solid volumes (this - arg).  If the specified
+  # objects (this and arg) do not represent manifold volumes, this method fails.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   result = instance1.subtract(instance2)
+  #
+  # @param instance
+  #   The instance to subtract this instance from.
+  #
+  # @return result - The resultant group if the two objects
+  #   (this and arg) represent manifold solids and the
+  #   operation succeeds otherwise nil is returned.
+  #
+  # @version SketchUp 8.0
+  def subtract(instance)
+  end
+
+  # Apply a {Geom::Transformation} to a component instance.
+  #
+  # @example
+  #   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
+  #
+  # @param [Geom::Transformation] transform
+  #   The transformation object to apply to the component instance.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def transform!(transform)
+  end
+
+  # The transformation method is used to retrieve the transformation of this
+  # instance.
+  #
+  # @example
+  #   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
+  #
+  # @return transformation - the Transformation object if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def transformation
+  end
+
+  # The transformation= method is used to set the transformation on this
+  # instance.
+  #
+  # @example
+  #   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
+  #
+  # @param transformation
+  #   A Transformation object to apply.
+  #
+  # @return instance - the transformed ComponentInstance
+  #
+  # @version SketchUp 6.0
+  def transformation=(transformation)
+  end
+
+  # The trim method is used to compute the (non-destructive) boolean difference
+  # of the two instances representing manifold solid volumes (this - arg).  If
+  # the specified objects (this and arg) do not represent manifold volumes, this
+  # method fails.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   result = instance1.trim(instance2)
+  #
+  # @param instance
+  #   The instance to trim this instance against.
+  #
+  # @return result - The resultant group if the two objects
+  #   (this and arg) represent manifold solids and the
+  #   operation succeeds otherwise nil is returned.
+  #
+  # @version SketchUp 8.0
+  def trim(instance)
+  end
+
+  # The union method is used to compute the boolean union of the two instances
+  # representing manifold solid volumes (this | arg).  If the specified
+  # objects (this and arg) do not represent manifold volumes, this method fails.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   instance1 = entities[0]
+  #   instance2 = entities[1]
+  #   result = instance1.union(instance2)
+  #
+  # @param instance
+  #   The instance to union this instance with.
+  #
+  # @return result - The resultant group if the two objects
+  #   (this and arg) represent manifold solids and the
+  #   operation succeeds otherwise nil is returned.
+  #
+  # @version SketchUp 8.0
+  def union(instance)
+  end
+
+  # The volume method is used to compute the volume of this instance if and only
+  # if this instance is manifold.
+  #
+  # @example
+  #   entities = Sketchup.active_model.entities
+  #   definition = Sketchup.active_model.definitions[0]
+  #   transformation = Geom::Transformation.new([0,0,0])
+  #   componentinstance = entities.add_instance(definition, transformation)
+  #   volume = componentinstance.volume
+  #
+  # @return volume - If the instance represents a manifold volume,
+  #   volume will be a positive value.  If volume is negative,
+  #   the instance is not manifold.
+  #
+  # @version SketchUp 8.0
+  def volume
+  end
+
+end