sketchucation logo sketchucation
    • Login
    ℹ️ Licensed Extensions | FredoBatch, ElevationProfile, FredoSketch, LayOps, MatSim and Pic2Shape will require license from Sept 1st More Info

    [Tutorial] SketchUp Ruby C Extension

    Scheduled Pinned Locked Moved Developers' Forum
    176 Posts 16 Posters 25.9k Views 16 Watching
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • J Offline
      Jim
      last edited by

      @thomthom said:

      Dunno. I'd think it'd be possible. But I really have no clue when it comes to compiling. It'd be nice to have tutorials for different compilers. So please feel free to jump on the bandwagon )

      I could not get MinGW working using Ruby 1.8.6. I could get the examples to compile using Ruby 1.9.3, but they just crashed SketchUp.

      But both example seem to compile and work just fine in SketchUp using VC++ Express and Ruby 1.8.6 per your instructions in the Readme file.


      0120.png

      Hi

      1 Reply Last reply Reply Quote 0
      • Dan RathbunD Offline
        Dan Rathbun
        last edited by

        @jim said:

        I could not get MinGW working using Ruby 1.8.6.

        Ruby v1.8.6-p287 was the last 'distro' to be compiled with MSVC. (.. which is likely why the GSUDT released SU8 with this patch level, even though their were newer v1.8.6 patch levels available.)

        All patch levels above p287 were distro'd (via Windows One-Click Installer,) compiled with MinGW.

        That is not to say, however that someone (including Google,) could build the newer patch levels with MSVC, or do a manual install by downloading precompiled binaries from:
        ftp;//ftp.ruby-lang.org/pub/ruby/binaries/mswin32/
        (.. However not all patch levels are available.)

        I'm not here much anymore.

        1 Reply Last reply Reply Quote 0
        • T Offline
          tomasz
          last edited by

          Shouldn't the C extension be protected by a sort of a "namespace"? I mean shouldn't Point3d {}; be SX_Ext_Point3D {};? If we have two diffetent DLL's, do their functions exist in a same 'space' πŸ˜„ ?

          Author of [Thea Render for SketchUp](http://www.thearender.com/sketchup)

          1 Reply Last reply Reply Quote 0
          • thomthomT Offline
            thomthom
            last edited by

            @unknownuser said:

            Shouldn't the C extension be protected by a sort of a "namespace"? I mean shouldn't Point3d {}; be SX_Ext_Point3D {};? If we have two diffetent DLL's, do their functions exist in a same 'space' πŸ˜„ ?

            No - only the Ruby modules, classes and methods you define - like in a normal Ruby Script. Everything else is isolated.

            As you see in the init function:

            <span class="syntaxdefault"><br />void&nbsp;Init_SX_Basics</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxdefault">void&nbsp;</span><span class="syntaxkeyword">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxcomment">//&nbsp;Modules<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxdefault">mSUExtTest&nbsp;</span><span class="syntaxkeyword">=&nbsp;</span><span class="syntaxdefault">rb_define_module</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxstring">"SUExtTest"&nbsp;</span><span class="syntaxkeyword">);<br />&nbsp;&nbsp;&nbsp;&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxcomment">//&nbsp;Constants<br />&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;>&nbsp;SUExtTest;;SX_BASIC_VERSION<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxdefault">rb_define_const</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxstring">"SX_BASIC_VERSION"</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">rb_str_new2</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxstring">"0.1.0"&nbsp;</span><span class="syntaxkeyword">)&nbsp;);<br />&nbsp;&nbsp;&nbsp;&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxcomment">//&nbsp;Methods<br />&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;>&nbsp;SUExtTest.foo<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxstring">"foo"</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">h_foobar</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">0&nbsp;</span><span class="syntaxkeyword">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxcomment">//&nbsp;>&nbsp;SUExtTest.multiply(&nbsp;number1,&nbsp;number2&nbsp;)<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxstring">"multiply"</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">h_multiply</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">2&nbsp;</span><span class="syntaxkeyword">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxcomment">//&nbsp;>&nbsp;SUExtTest.pi_array(&nbsp;array&nbsp;)<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxstring">"pi_array"</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">h_pi_array</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">1&nbsp;</span><span class="syntaxkeyword">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxcomment">//&nbsp;>&nbsp;SUExtTest.random_points(&nbsp;size&nbsp;)<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxstring">"random_points"</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">h_random_points</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">1&nbsp;</span><span class="syntaxkeyword">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxcomment">//&nbsp;>&nbsp;SUExtTest.closest_distance(&nbsp;point_set1,&nbsp;point_set2&nbsp;)<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">(&nbsp;</span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxstring">"closest_distance"</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">h_closest_distance</span><span class="syntaxkeyword">,&nbsp;</span><span class="syntaxdefault">2&nbsp;</span><span class="syntaxkeyword">);<br />}<br />&nbsp;</span><span class="syntaxdefault"></span>
            

            It's the rb_define_* that will make the extension share anything with the Ruby environment - everything else is isolated.

            Thomas Thomassen β€” SketchUp Monkey & Coding addict
            List of my plugins and link to the CookieWare fund

            1 Reply Last reply Reply Quote 0
            • C Offline
              chyn2000
              last edited by

              Hi Guys.

              First, I want to say that this project you have started is awesome. I had just decided I needed a ruby extension to get a speed boost for a plug-in project. I found a lot of tutorials on making extensions, but most were for either linux or for MS Visual Studio 6 on Windows. I'm not using either environment. I am on Windows 7 (64bit).

              Sooooo, I have followed TBD's example program the best I can.

              • I have downloaded the SUExt files.
              • I have downloaded the Ruby Installer and Source per the SUExt readme file and installed Ruby.
              • I have installed Pelles C.

              I tried to open suext.ppj file and Pelles C kept throwing an error about "suext.obj is wrongly located in -path_to_project-". So I tried suext6.ppj and it seemed to be fine. It even seemed to build once I pointed Pelles C to where my Ruby installation was at.

              From here I'm a little lost. Am I done? I brought up the irb and typed in: require 'path_to_project/suext.so'
              The results were as follows:

              LoadError: 127: The specified procedure could not be found. - Init_path_to_project\suext
              path_to_project\suext.so
              from path_to_project\suext.so
              from path_to_ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:31:in `require'
              from (irb):1
              from :0

              What am I missing?

              Thanks
              -Chyn

              1 Reply Last reply Reply Quote 0
              • thomthomT Offline
                thomthom
                last edited by

                When you require a C Extension, do not include the file extension.

                So instead of:
                require 'path_to_project/suext.so'

                do:
                require 'path_to_project/suext'

                Thomas Thomassen β€” SketchUp Monkey & Coding addict
                List of my plugins and link to the CookieWare fund

                1 Reply Last reply Reply Quote 0
                • C Offline
                  chyn2000
                  last edited by

                  Ok. That certainly changed things a little.

                  I type:
                  irb(main):002:0> require 'path_to_project\suext'

                  and get back:
                  LoadError: 127: The specified procedure could not be found. - Init_path_to_project\suext
                  path_to_project\suext.so
                  from path_to_project\suext.so
                  from path_to_ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:31:in `require'
                  from (irb):2
                  from :0

                  1 Reply Last reply Reply Quote 0
                  • TIGT Offline
                    TIG Moderator
                    last edited by


                    or
                    /
                    ?

                    TIG

                    1 Reply Last reply Reply Quote 0
                    • C Offline
                      chyn2000
                      last edited by

                      Both. The '/'s and ''s that are in the post were copied and pasted. I didn't change any of them. Let me know if you want the original output. I just shortened the paths for readability.

                      -Chyn

                      1 Reply Last reply Reply Quote 0
                      • J Offline
                        Jim
                        last edited by

                        TIG means try using this --> / <-- instead of that --> ** <-- in your require statement.

                        Hi

                        1 Reply Last reply Reply Quote 0
                        • C Offline
                          chyn2000
                          last edited by

                          Ah. Gotchya now.

                          Nirg. Same result...

                          Anything else? Maybe is one of you guys have successfully built the example you could post it for download. That would make sure I've got my environment set up correctly.

                          -Chyn

                          1 Reply Last reply Reply Quote 0
                          • thomthomT Offline
                            thomthom
                            last edited by

                            How did you build it? Seems something has gotten confused and the path has gotten mixed into the name of the initializing procedure for the C Extension.

                            @chyn2000 said:

                            LoadError: 127: The specified procedure could not be found. - Init_path_to_project\suext

                            It tries to call a function named Init_path_to_project\suext - where, given the name suext it should be trying to call Init_suext.

                            Thomas Thomassen β€” SketchUp Monkey & Coding addict
                            List of my plugins and link to the CookieWare fund

                            1 Reply Last reply Reply Quote 0
                            • C Offline
                              chyn2000
                              last edited by

                              I built in Pelles C.

                              So, the path isn't hard coded in the program. I can place a copy of the suext.so on my d:\ and it changes the error out put to match:

                              irb(main):002:0> require 'D:\suext'
                              LoadError: 127: The specified procedure could not be found. - Init_D:\suext
                              D:\suext.so
                              from D:\suext.so
                              from d:/Ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:31:in `require'
                              from (irb):2
                              from :0

                              Is there a specific directory I should have the file at?

                              1 Reply Last reply Reply Quote 0
                              • Dan RathbunD Offline
                                Dan Rathbun
                                last edited by

                                %(#BF8000)[path_to_ruby/lib/ruby/site_ruby/1.8/rubygems/**custom_require.rb**]

                                Why are you customizing the require() method ?

                                Try it WITHOUT loading this custom script...

                                I'm not here much anymore.

                                1 Reply Last reply Reply Quote 0
                                • J Offline
                                  Jim
                                  last edited by

                                  @dan rathbun said:

                                  Why are you customizing the require() method ?

                                  He isn't - this is something done by RubyGems.

                                  Hi

                                  1 Reply Last reply Reply Quote 0
                                  • Dan RathbunD Offline
                                    Dan Rathbun
                                    last edited by

                                    OK.. my bad.. N/M

                                    I'm not here much anymore.

                                    1 Reply Last reply Reply Quote 0
                                    • J Offline
                                      Jim
                                      last edited by

                                      @chyn2000 said:

                                      irb(main):002:0> require 'D:\suext'

                                      You did it again.

                                      Use:

                                      require "D:/suext"

                                      
                                      irb(main);001;0> require 'C;\SX_Basics'
                                      LoadError; 127; The specified procedure could not be found.   - Init_C;\SX_Basics
                                      C;\SX_Basics.so
                                              from C;\SX_Basics.so
                                              from (irb);1
                                      irb(main);002;0> require 'C;/SX_Basics'
                                      => true
                                      irb(main);003;0>
                                      

                                      Hi

                                      1 Reply Last reply Reply Quote 0
                                      • J Offline
                                        Jim
                                        last edited by

                                        Ok, I just built TBD's suext example using Visual Studio Express 2010.

                                        In order to get the extension to require properly, I had to use:

                                        require "SUExt" <-- note case

                                        require "suext" failed.

                                        Hi

                                        1 Reply Last reply Reply Quote 0
                                        • C Offline
                                          chyn2000
                                          last edited by

                                          @jim said:

                                          Ok, I just built TBD's suext example using Visual Studio Express 2010.

                                          In order to get the extension to require properly, I had to use:

                                          require "SUExt" <-- note case

                                          require "suext" failed.

                                          Yep Jim. That was exactly it!

                                          Thanks everyone. Let me know if there is anything I can do to help.

                                          Actually, it occurs to me that we may want to start making a small library of math and geometry ruby extensions very targeted towards SU. Thoughts?

                                          -Chyn

                                          1 Reply Last reply Reply Quote 0
                                          • thomthomT Offline
                                            thomthom
                                            last edited by

                                            @chyn2000 said:

                                            Actually, it occurs to me that we may want to start making a small library of math and geometry ruby extensions very targeted towards SU. Thoughts?

                                            Not a bad idea. I had plans of doing some bezier functions.

                                            Thomas Thomassen β€” SketchUp Monkey & Coding addict
                                            List of my plugins and link to the CookieWare fund

                                            1 Reply Last reply Reply Quote 0
                                            • 1
                                            • 2
                                            • 3
                                            • 4
                                            • 5
                                            • 8
                                            • 9
                                            • 3 / 9
                                            • First post
                                              Last post
                                            Buy SketchPlus
                                            Buy SUbD
                                            Buy WrapR
                                            Buy eBook
                                            Buy Modelur
                                            Buy Vertex Tools
                                            Buy SketchCuisine
                                            Buy FormFonts

                                            Advertisement