Automatically load a component.

TNTDAVID

@dan rathbun said:

The error is: "TypeError: no implicit conversion of nil into String",...

... which means your code is expecting a String object, but the object is a reference to nil instead.

Understand and resolve this error message is very important to me.

The only thing I find about "String Object" is on this page:

http://www.sketchup.com/intl/en/developer/docs/ourdoc/string

It does not allow me to solve my problem.

With the following code:

module TNTDAVID
  module ClickWindow3D_Trial_mm
    def self.auto_run_code()
      path = Sketchup.find_support_file("cube.skp", "Components")
      model = Sketchup.active_model
      definitions = model.definitions
      component_definition = definitions.load(path)
      point = Geom;;Point3d.new(10, 20, 30)
      transformation = Geom;;Transformation.new(point)
      instance = entities.add_instance(component_definition, transformation)
    end
    self.auto_run_code()
  end
end

I get the same error message in the "Consol Ruby".

When I launch SketchUp, I have this message:

@unknownuser said:

Error Loading File C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb
Error: #<TypeError: no implicit conversion of nil into String>
C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:7:in load' C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:7:in auto_run_code'
C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:12:in <module:TNTDAVID>' C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:2:in module:ClickWindow3D_Trial_mm'
C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:1:in <top (required)>' C:/Program Files/SketchUp/SketchUp 2015/Tools/extensions.rb:197:in require'
C:/Program Files/SketchUp/SketchUp 2015/Tools/extensions.rb:197:in load' C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm.rb:28:in register_extension'
C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm.rb:28:in <module:ClickWindow3D_Trial_mm>' C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm.rb:18:in <top (required)>'

Your help is essential to me to find a solution.

Thank you
David

kaas

If I run your code I get the same error.

The component_definition = definitions.load(path) is expecting a path to that cube.skp (a string), instead it gets NIL because there is no cube.skp in SketchUp defaults components folder.

So; if you put a cube.skp in that folder this will work.

Edit: maybe have a look at some ruby training videos? (Lynda.com for instance has some). It might help in understanding the principles of Ruby coding. Could be helpful if you intend to sell (and support) your plugins.

TIG

path = Sketchup.find_support_file("cube.skp", "Components")
either returns nil [no match]
or if it matches, something like
"C:\\Program Files\\SketchUp\\SketchUp 2015\\Components\\cube.skp"
To check if it works use:
puts "path = #{path}"
and
puts "path exist? #{File.exist?(path)}"
as it runs, or in the code itself, to abort early...
(UI.messagebox("Path does not exist\n#{File.exist?(path)}"); return nil) unless path && File.exist?(path)

I expect in the 'real' code you are setting the path to a skp in a components-subfodler within the extension's own subfolder - found using __FILE__ to get the rb's folder path etc...

TNTDAVID

I added "cube.skp" in "Components Sampler" folder, there is always the same error message.

module TNTDAVID
  module ClickWindow3D_Trial_mm
    def self.auto_run_code()
      path = Sketchup.find_support_file("cube.skp", "Components/Components Sampler")
      model = Sketchup.active_model
      definitions = model.definitions
      component_definition = definitions.load(path)
      point = Geom;;Point3d.new(10, 20, 30)
      transformation = Geom;;Transformation.new(point)
      instance = entities.add_instance(component_definition, transformation)
    end
    self.auto_run_code()
  end
end

@unknownuser said:

Error Loading File C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb
Error: #<NameError: undefined local variable or method entities' for TNTDAVID::ClickWindow3D_Trial_mm:Module> C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:10:in auto_run_code'
C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:12:in <module:ClickWindow3D_Trial_mm>' C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:2:in module:TNTDAVID'
C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm/logic.rb:1:in <top (required)>' C:/Program Files/SketchUp/SketchUp 2015/Tools/extensions.rb:197:in require'
C:/Program Files/SketchUp/SketchUp 2015/Tools/extensions.rb:197:in load' C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm.rb:28:in register_extension'
C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm.rb:28:in <module:ClickWindow3D_Trial_mm>' C:/Users/DAVID/AppData/Roaming/SketchUp/SketchUp 2015/SketchUp/Plugins/TNT_ClickWindow3D_Trial_mm.rb:18:in <top (required)>'

Why, there's always this error message?

@tig said:

I expect in the 'real' code you are setting the path to a skp in a components-subfodler within the extension's own subfolder - found using FILE to get the rb's folder path etc...

I can use the File method to import a component from an icon.

module ClickWindow3D_Trial_mm

  class << self

    path_to_components = File.join(File.dirname(__FILE__), 'Components')
    @@path_to_00 = File.join(path_to_components,'00-Control-Panel-Trial-mm.skp')

    def add_00
      Sketchup.active_model.import(@@path_to_00)
    end
    
if !file_loaded?(__FILE__)


        tb = UI;;Toolbar.new(%Q(Click-Window3D-Trial-mm))

        command1 = UI;;Command.new("add Resources"){ ClickWindow3D_Trial_mm.add_00 }

        command1.small_icon = File.join(@@path_to_resources,"add_00.png")

        command1.large_icon = File.join(@@path_to_resources,"add_00.png")

        tb.add_item(command1)

        tb.restore

        file_loaded(__FILE__)

       end

   end

How to change the code so that "cube.skp" is automatically imported on each SketchUp scene?

Thank you

Dan Rathbun

@tntdavid said:

The only thing I find about "String Object" is on this page:
http://www.sketchup.com/intl/en/developer/docs/ourdoc/string

David, The SketchUp Ruby API is an extension to standard Core Ruby, and
adds a few methods to the Ruby's core String class:
http://ruby-doc.org/core-2.0.0/String.html

You need to learn standard Ruby before you can really appreciate what SketchUp's API adds to Ruby.

Here is a set of lists that will help (at the official SketchUp forum):
[url=http://forums.sketchup.com/t/ruby-learning-resources-wikilists/22861:2epja1nk]Ruby Learning Resources [WikiLists][/url:2epja1nk]
(There is similar, but perhaps older list, here ar SCF as well.)

Dan Rathbun

@tntdavid said:

I added "cube.skp" in "Components Sampler" folder, there is always the same error message.

Why, there's always this error message?

David, code files need to be encoded as UTF-8 without BOM (BOM = Bit Order Mark.)

The first line of all SketchUp code files should also always be the "magic comment":
# encoding: UTF-8

See: Ruby Core docs: Encoding - Script encoding

TNTDAVID

Hello, kaas

My "cube.skp" is in the "Components" folder in my plugin.

It should be placed in another folder?

You can download HERE the full fichier.rbz.

Thank you for your help.

cordially

David

Ps: Thank you for your links.

Edit: Small error in "TesteCube.rb" corrected.

TNTDAVID

@dan rathbun said:

David, code files need to be encoded as UTF-8 without BOM (BOM = Bit Order Mark.)

The first line of all SketchUp code files should also always be the "magic comment":

encoding: UTF-8

Another thing I just learned.

Have you sample code # encoding: UTF-8?

I supose that my error is because of that ?

Thanks

TIG

It's a good idea to include that as the first line of all of your RB files.
But, it's not essential - if you use Notepad++ exe you can set up its preferences so that all new files you create are set to be properly encoded UTF-8 [without BOM] - which is required by the newer versions of Ruby.
Unfortunately the Windows bare-bones Notepad exe uses an inappropriate text encoding system - ANSI I think ?
And if you have an existing RB file that is encoded 'wrongly' [e.g. ANSI] you can use Notepad++ to change its encoding to UTF-8, then save it - and it should then be permanently set to that proper encoding...

Get Notepad++ exe v7 from here - it's free and has helpful Ruby syntax tools built in...
https://notepad-plus-plus.org/download/v7.html
There are 32 and 64 bit versions - I use the 64...

TNTDAVID

Thank you for the download link TIG.

I encoded my "rb" in "UTF-8", without BOM!

It is not the cause of the error message.

You can download HERE, the new "RBZ".

Thank you in advance for your help.

kaas

The error points you into the right direction: Error: #<NameError: undefined local variable or methodentities' for TNTDAVID::ClickWindow3D_Trial_mm:Module>`

My guess is, the error refers to:
instance = **entities**.add_instance(component_definition, transformation)

If you change that line to:
instance = model.entities.add_instance(component_definition, transformation)

you might have more luck.

TIG

@Kaas is correct.
Try...
entities = model.active_entities instance = entities.add_instance(component_definition, transformation)

There have been so many iterations of your code fragments across two threads it becomes hard to keep track !

TNTDAVID

It works

Many Thanks, TIG, kaas and Dan Rathbun.

Anyone can download HERE, the "RBZ".

Here is the magic code:

module TesteCube
  module CubeImport
    def self.auto_run_code()
      path = Sketchup.find_support_file("cube.skp", 
      "Plugins/TesteCube/Components/")
      model = Sketchup.active_model
      definitions = model.definitions
      component_definition = definitions.load(path)
      point = Geom;;Point3d.new(10, 20, 30)
      transformation = Geom;;Transformation.new(point)
      instance = model.entities.add_instance(component_definition, transformation)
    end
    self.auto_run_code()
  end
end

We just reach the first goal!

There remain two to accomplish:

  **1.How to run the code on each new scenes?**

Currently only the launch SketchUp, triggers the code that import the "cube.skp".

  **2. How to lock or hide the cube, to avoid copying or unintended deletions?**

More the cube is protected, more "Dynamic Components" related also.

Thank you for your Help.

Cordially

David

TNTDAVID

To lock my "[b]cube.stp", you just add this line:[/b]

status = instance.locked = true #### Locks the cube.
layers = model.layers 
new_layer = layers.add "cube" #### Create a new layer "cube".
new_layer.visible = false #### Hides the "cube" layer.

I can not find how to add the new layer on my cube!

You have an idea ?

Thank you

TIG

That's the easy bit !
instance.layer = new_layer
You could also lock it, so that its harder to delete if someone activates that layer later
instance.locked = true
You can also hide it for good measure, so it's harder to find if !
instance.hidden = true

However, nothing is foolproof...
Layers > 'Cube' > ON shows it...
View > Hidden Geometry > ON shows it...
Select instance and right-click > Unlock > Unlocks it...
Select instance and right-click > Unhide > Shows fully it...
Hit delete > to remove it...
or Open Component Browser find 'Cube' and use context-menu to delete its definition, when prompted accept...
or Layers > Delete 'Cube' and accept to delete all entities using it...

TNTDAVID

Thank you TIG it works perfectly!

The most important is to prevent the accidental suppresion.

Same CleanUp does not remove my cube.

Protection against copying is not good.

Is there a solution to make my cube inaccecible from SketchUp?

For example, do not display the "cube" layer in the Layers window?

%(#FF0000)[**

It still remains a very important objective to accomplish:**]

How do I load my "Plugin" has every opening a SketchUp file?

I doubt that it will be harder to find!

Thank you in advance for your help.

David

TNTDAVID

Hello everyone.

As my last objective seems difficult, I return to my first idea.

Instead of automatically import the "cube.skp" on each new SketchUp scene.

The "cube" will be imported along with the first "Dynamic Component".

Here is the modified code and that works:

module TesteCube


  module CubeImport
  
      path_to_components = File.join(File.dirname(__FILE__), 'Components')
      @@path_to_00 = File.join(path_to_components, 'Dynamic Component.skp')
      @@path_to_resources = File.join(File.dirname(__FILE__), 'Resources')
	  
    def self.methode1

      path = Sketchup.find_support_file("cube.skp", 
      "Plugins/TesteCube/Components/")
      model = Sketchup.active_model
      definitions = model.definitions
      component_definition = definitions.load(path)
      point = Geom;;Point3d.new(0, 0, 0)
      transformation = Geom;;Transformation.new(point)
      instance = model.entities.add_instance(component_definition, transformation)
      status = instance.locked = true 
      layers = model.layers
      new_layer = layers.add "cube"
      new_layer.visible = false
      instance.layer = new_layer
      instance.locked = true
      instance.hidden = true
      Sketchup.active_model.import(@@path_to_00)

    end
	

    if !file_loaded?(__FILE__)
	
	
      su_menu = UI.menu("Plugins")

      cc_menu = su_menu.add_submenu(%Q(Teste_Cube))
		
      tb = UI;;Toolbar.new(%Q(Teste-Cube))
		
      command1 = UI;;Command.new("add Dynamic Component"){ CubeImport.methode1 }

      command1.small_icon = File.join(@@path_to_resources,"add_00.png")

      command1.large_icon = File.join(@@path_to_resources,"add_00.png")

      command1.tooltip = %Q(add Dynamic Component)

      command1.status_bar_text = %Q(add Dynamic Component)

      command1.menu_text = %Q(add Dynamic Component)

      cc_menu.add_item(command1)

      tb.add_item(command1)
		
      tb.restore
 
      file_loaded(__FILE__) 

      end
  
   end

end

Notice that "method1" to one more line to import "Dynamique. Component.skp"
at the same time that the "cube.skp".

The line of code with the more interest to me is:

command1 = UI::Command.new("add cube") { CubeImport.methode1 }

She created a new icon { that triggers methode1 }.

If I click once on the icon:

methode1 will import "1 cube" + "1 component Dynamic".

If I click ten times on the icon:

method1 will import "10 cubes" + "10 Dynamic Components".

That's exactly my problem

I do need a single "cube", with no restrictions on the number of "Dynamic Components".

How to limit the amount of cube imported at "1" ?

Through links provided by DanRathbun and especially "Ruby in twenty minutes",
I understand better now the ruby.

But this is not sufficient to finalize my code as a great.

Thank you in advance for your help.

Cordially

David

TNTDAVID

To limit the amount of cube to import, I found this method:

ComponentInstance.manifold?

This is the method that can meet my expectations?

I tried many things and it does not work:

instance.componentinstance.manifold instance = false

componentinstance.manifold instance = false

instance = componentinstance.manifold?
instance.componentinstance.manifold = false

status = istance.componentinstance.manifold?
status.componentinstance.manifold = false

componentinstance.manifold status = false

instance.componentinstance.manifold status = false

instance.componentinstance.manifold = false

Nothing works !

And all methods that are following this method are not executed.

I need your help more than ever.

Thank you

David

kaas

Manifold is used for testing if its a solid or not. Not the right tool for your problem.

So you just need 1 cube in the model: you have linked the 'cube' to 'path' and you refer to it as 'component_definition'. You insert the cube using:
instance = model.entities.add_instance(component_definition, transformation)

Why not create a small test and see if an instance is already in the model and if so - don't load it again. Replace the above line with these lines:

in_scene=false
definitions.each{|d|
	if d.name == 'cube'
		c = d.count_used_instances
		in_scene = true if c > 0
	end
}
if !in_scene
	instance = model.entities.add_instance(component_definition, transformation)
end

TIG

You seem to be misunderstanding how some things [many things!] work.
!!! .manifold? is NOT what you need it's for testing if a group or instance is a a 'solid' - e.g. for 3d printing.

When your extension starts to load the FIRST DC it initially adds 'definition'.
AND it then adds an 'instance' of that.
Subsequent DC loads should also check in case the definition or instance are not present...

if definition.valid?
  if instance.valid? ###[or perhaps || definition.instances[0] ???]
    ### You are already set to do the DC load...
  else
    ### You need to add an instance - perhaps it's been deleted by the user ???
    ### NOW you are set to do the DC load...
  end
else ### definition is NOT valid - it's been deleted - so the instance has too.
  ### You load the definition AND add the instance again - seems like the user has deleted both !
  ### NOW you are set to do the DC load...
end

A certain logic is needed in thinking through the coded steps...