• Login
sketchucation logo sketchucation
  • Login
πŸ€‘ SketchPlus 1.3 | 44 Tools for $15 until June 20th Buy Now

New API doc - typos and questions

Scheduled Pinned Locked Moved Developers' Forum
370 Posts 35 Posters 256.4k Views 35 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.
  • D Offline
    Dan Rathbun
    last edited by 11 Jan 2010, 13:38

    Model.add_note

    The note is not displayed unless there are entities in the model. If you add a note first thing in a new model, it is invisible but .visible? on the note object still returns true.

    As soon as you draw something, the note appears.

    I'm not here much anymore.

    1 Reply Last reply Reply Quote 0
    • J Offline
      Jim
      last edited by 12 Jan 2010, 22:22

      Thanks Dan - yet more never-seen-before docs coming to light.

      Hi

      1 Reply Last reply Reply Quote 0
      • T Offline
        thomthom
        last edited by 12 Jan 2010, 22:31

        I have the mental image of Scott drowning in printouts from this thread... πŸ˜’ πŸ˜†

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

        1 Reply Last reply Reply Quote 0
        • J Offline
          Jim
          last edited by 12 Jan 2010, 22:36

          Oh, I think there is a completely undocumented UTM class in there somewhere under Geom.

          Hi

          1 Reply Last reply Reply Quote 0
          • T Offline
            thomthom
            last edited by 12 Jan 2010, 23:03

            @jim said:

            Oh, I think there is a completely undocumented UTM class in there somewhere under Geom.

            hm.. all I can find out about that one is:
            Geom::UTM.instance_methods.sort.join("\n") (eval):894: warning: instance_methods: parameter will default to 'true' as of 1.8.1 to_a to_latlong to_s x y zone_letter zone_number

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

            1 Reply Last reply Reply Quote 0
            • J Offline
              Jim
              last edited by 15 Jan 2010, 14:31

              View.show_frame

              Documentation for this method contains some poorly-parsed html tags.

              Hi

              1 Reply Last reply Reply Quote 0
              • D Offline
                Dan Rathbun
                last edited by 17 Jan 2010, 15:45

                @thomthom said:

                @jim said:

                Oh, I think there is a completely undocumented UTM class in there somewhere under Geom.

                hm.. all I can find out about that one is:
                Geom::UTM.instance_methods.sort.join("\n")... snip ...

                from Wikipedia search on "UTM":
                Universal Transverse Mercator coordinate system, a grid-based method of mapping locations on the surface of the Earth.
                http://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
                _

                I'm not here much anymore.

                1 Reply Last reply Reply Quote 0
                • D Offline
                  Dan Rathbun
                  last edited by 17 Jan 2010, 15:58

                  Model.get_product_family
                  http://code.google.com/apis/sketchup/docs/ourdoc/model.html#get_product_family

                  @unknownuser said:

                  Returns a constant number which indicates the product family of the installed SketchUp application.

                  This is an Application related attribute, why is it part of the Model class?

                  This should be a method of the Sketchup module as in: Sketchup.get_product_family
                  _

                  I'm not here much anymore.

                  1 Reply Last reply Reply Quote 0
                  • D Offline
                    Dan Rathbun
                    last edited by 17 Jan 2010, 16:00

                    Model.export
                    http://code.google.com/apis/sketchup/docs/ourdoc/model.html#export

                    @unknownuser said:

                    options_hash______ A hash containing the COLLADA (.dae) export options.

                    The options listed in the hash example is missing the option for hidden geometry.
                    The Registry Attribute Name is "ExportHiddenGeometry", but what is the options hash key?

                    • hiddengeometry ?* hidden_geometry ?
                      _

                    I'm not here much anymore.

                    1 Reply Last reply Reply Quote 0
                    • D Offline
                      Dan Rathbun
                      last edited by 17 Jan 2010, 16:00

                      Set class
                      http://code.google.com/apis/sketchup/docs/ourdoc/set.html

                      This class is defined in the Objectspace and should be listed under "Core Ruby Classes" (along with Array, Length, Numeric and String.)

                      Instead it's buried under "App Level Classes" and listed with all those classes that are defined inside the Sketchup module.
                      _

                      I'm not here much anymore.

                      1 Reply Last reply Reply Quote 0
                      • D Offline
                        Dan Rathbun
                        last edited by 17 Jan 2010, 17:22

                        OptionsProviderObserver.onOptionsProviderChanged
                        http://code.google.com/apis/sketchup/docs/ourdoc/optionsproviderobserver.html#onOptionsProviderChanged

                        @unknownuser said:

                        The onOptionsProviderChanged method is invoked when an element is added to an Pages object.

                        Should read, "The onOptionsProviderChanged method is invoked when an option is changed for an OptionsProvider object."
                        _

                        I'm not here much anymore.

                        1 Reply Last reply Reply Quote 0
                        • T Offline
                          thomthom
                          last edited by 22 Jan 2010, 11:41

                          Entities.add_curve
                          http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/entities.html#add_curve

                          Returns an array of edges - not a Curve object.

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

                          1 Reply Last reply Reply Quote 0
                          • T Offline
                            TIG Moderator
                            last edited by 22 Jan 2010, 12:04

                            @thomthom said:

                            Entities.add_curve
                            http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/entities.html#add_curve

                            Returns an array of edges - not a Curve object.

                            Ita's the same as add_circle which returns an array od edges and to find the just made curves curve you use edges=entities.add_curve(array_of_points) curve=edges[0].curve
                            But strangely not with add_arc which returns an ArcCurve ?

                            It would be unadvisable to change what the API does with these add_ methods - rather it we should keep it as is and fix the API's Guide to reflect it properly - too many scripts already get the curve from the edges array and would fail if it were updated to return the curve not the curve's edges...

                            TIG

                            1 Reply Last reply Reply Quote 0
                            • T Offline
                              thomthom
                              last edited by 22 Jan 2010, 12:21

                              @tig said:

                              But strangely not with add_arc which returns an ArcCurve ?

                              Nope, also returns an array.

                              @tig said:

                              It would be unadvisable to change what the API does with these add_ methods

                              Agree.

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

                              1 Reply Last reply Reply Quote 0
                              • T Offline
                                TIG Moderator
                                last edited by 22 Jan 2010, 12:25

                                @thomthom said:

                                @tig said:

                                But strangely not with add_arc which returns an ArcCurve ?

                                Nope, also returns an array.

                                @tig said:

                                It would be unadvisable to change what the API does with these add_ methods

                                Agree.

                                Perhaps I meant to say, "... add_arc which says it returns an ArcCurve wrongly!" πŸ˜’

                                TIG

                                1 Reply Last reply Reply Quote 0
                                • T Offline
                                  thomthom
                                  last edited by 22 Jan 2010, 12:29

                                  Sketchup.write_default
                                  Sketchup.read_default
                                  http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/sketchup.html#write_default
                                  http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/sketchup.html#read_default

                                  @unknownuser said:

                                  [..] the string associated with a value within the specified sub-section section of a .INI file or registry (within the Software > @Last Software > SketchUp section).

                                  Is it really stored under @Last any more?

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

                                  1 Reply Last reply Reply Quote 0
                                  • T Offline
                                    TIG Moderator
                                    last edited by 22 Jan 2010, 12:33

                                    @thomthom said:

                                    Sketchup.write_default
                                    Sketchup.read_default
                                    http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/sketchup.html#write_default
                                    http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/sketchup.html#read_default

                                    @unknownuser said:

                                    [..] the string associated with a value within the specified sub-section section of a .INI file or registry (within the Software > @Last Software > SketchUp section).

                                    Is it really stored under @Last any more?

                                    No, / Google / Sketchup 7 / etc... πŸ˜‰

                                    TIG

                                    1 Reply Last reply Reply Quote 0
                                    • T Offline
                                      thomthom
                                      last edited by 22 Jan 2010, 16:44

                                      Group.move!
                                      http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/group.html#move !

                                      .move! moves to an absolute point. Worth noting in the manual.

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

                                      1 Reply Last reply Reply Quote 0
                                      • D Offline
                                        Dan Rathbun
                                        last edited by 23 Jan 2010, 21:22

                                        Geom::Point3d.+
                                        http://code.google.com/apis/sketchup/docs/ourdoc/point3d.html#+

                                        @unknownuser said:

                                        The '+' operator is a fast way to add to the current x, y and z values of a point, or to set the values of a point by adding to other points together.
                                        The end of the sentence should read, "...by adding **two** other points together."

                                        @unknownuser said:

                                        Returns:
                                        vector a Vector object
                                        There is no defined object named 'vector'. If we follow the example the class of the result is given as Geom::Point3d.

                                        pt2 = Geom;;Point3d.new(100,200,300)
                                        pt3 = pt2 + [1,1,1]
                                        >> Point3d(101, 201, 301)
                                        pt3.class
                                        >> Geom;;Point3d
                                        

                                        @unknownuser said:

                                        Arguments:
                                        point2 A Point3d object.
                                        An ArugemtError exception is raised if point2 is a Point3d object.
                                        Valid argument classes are: Array or Vector3d. This means to use a Point3d as an argument, you must convert to Array. Example:

                                        pt3 = pt1 + pt2.to_a
                                        

                                        This method needs to be fixed to take a Point3d object and internally convert it to an Array...

                                        # internal to + method
                                        if arg[0].is_a? Point3d { arg[0]=arg[0].to_a }
                                        

                                        ...or a Vector3d:

                                        # internal to + method
                                        if arg[0].is_a? Point3d { arg[0]=[0,0,0].vector_to(arg[0]) }
                                        

                                        either way. The current implementation is clumsy.

                                        I'm not here much anymore.

                                        1 Reply Last reply Reply Quote 0
                                        • D Offline
                                          Dan Rathbun
                                          last edited by 23 Jan 2010, 21:24

                                          **Geom::Point3d.-**
                                          http://code.google.com/apis/sketchup/docs/ourdoc/point3d.html#-

                                          @unknownuser said:

                                          Returns:
                                          vector a Vector object
                                          There is no defined object named 'vector', but there IS one named ' Vector3d'. If we follow the example the class of the result is given as Geom::Vector3d.

                                          pt2 = Geom;;Point3d.new(100,200,300)
                                          pt3 = pt2 - [1,1,1]
                                          >> Vector3d(99, 199, 299)
                                          pt3.class
                                          >> Geom;;Vector3d
                                          

                                          It seems a bit strange that + returns Point3d, but - returns Vector3d.

                                          I'm not here much anymore.

                                          1 Reply Last reply Reply Quote 0
                                          • 1
                                          • 2
                                          • 11
                                          • 12
                                          • 13
                                          • 14
                                          • 15
                                          • 18
                                          • 19
                                          • 13 / 19
                                          13 / 19
                                          • First post
                                            257/370
                                            Last post
                                          Buy SketchPlus
                                          Buy SUbD
                                          Buy WrapR
                                          Buy eBook
                                          Buy Modelur
                                          Buy Vertex Tools
                                          Buy SketchCuisine
                                          Buy FormFonts

                                          Advertisement