New API doc - typos and questions

[Chris Fullmer]

http://code.google.com/apis/sketchup/do ... 3d.html#z=

It says:

Code: Select all

Point3d.z=

    The y= method is used to set the z value of a 3D point.

That second line should say "The z= method..."

[thomthom]

http://code.google.com/intl/nb/apis/ske ... .html#area

Face.area actually takes an optional argument. I'm not sure what the argument is. It accepts pure numbers which then seems to be a scale factor. But it also accepts Transformation objects.

[thomthom]

Same applies to Edge.length

[thomthom]

Point3d.project_to_plane
The example uses project_to_line

Code: Select all

 plane = [Geom::Point3d.new(0,0,0), Geom::Vector3d.new(0,0,1)]
 point = Geom::Point3d.new 10,10,10
 projected_point = point.project_to_line line


[Chris Fullmer]

Tool - onMouseMove example has a bad local variable.
http://code.google.com/apis/sketchup/do ... nMouseMove

Code: Select all

 def onMouseMove(flags, x, y, view)
   puts "onMouseMove: flags = " + key.to_s
   puts "                 x = " + x.to_s
   puts "                 y = " + y.to_s
   puts "              view = " + view.to_s
 end

The variable "key" should be replaced with "flag" I think. That makes the example work.

Chris

[thomthom]

http://code.google.com/apis/sketchup/do ... t_UVHelper

The code example:

Code: Select all

 model = Sketchup.active_model
 entities = model.active_entities
 pts = []
 pts[0] = [0, 0, 0]
 pts[1] = [9, 0, 0]
 pts[2] = [9, 9, 0]
 pts[3] = [0, 9, 0]

 # Add the face to the entities in the model
 face = entities.add_face pts
 tw = Sketchup::TextureWriter.new
 uvHelp = face.get_UVHelper true, true, tw


This will return the error:

Error: #<TypeError: (eval):95:in `get_UVHelper': wrong argument type (expected Sketchup::TextureWriter)>
(eval):95

Instead of tw = Sketchup::TextureWriter.new, the method tw = Sketchup.create_texture_writer will work.
Which leads to another questions: why can't tw = Sketchup::TextureWriter.new be used as in the example?

[thomthom]

ModelObserver.onPlaceComponent
http://code.google.com/apis/sketchup/do ... eComponent

The manual claims that a Model is passed on as the argument, but instead it's the ComponentInstance. I have not tested the rest of the ModelObserver events to see if they also match.

onPlaceComponent FIXED

[ScottLininger]

ModelObserver.onPlaceComponent
http://code.google.com/apis/sketchup/do ... eComponent

The manual claims that a Model is passed on as the argument, but instead it's the ComponentInstance. I have not tested the rest of the ModelObserver events to see if they also match.

Thomas, you rock.

I'll double check all of the modelobserver arguments. Thanks!

[remus]

For Point3d.distance_to_line the docs give the same example as point3d.distance.

[thomthom]

I can't get the DefinitionObserver to trigger at all. http://code.google.com/apis/sketchup/do ... erver.html Neither the onComponentInstanceAdded or onComponentInstanceRemoved events. Are these the correct event names?

[ScottLininger]

I just had a big one reported to me... posting it here so folks are aware until the next fix.

The face.material method is entirely missing from the new docs.

[ScottLininger]

There's a new update live that fixes (most of) the problems reported above. There were one or two that will require me to pound on it a bit more. Keep 'em coming!

I also posted a new tutorial on reading attributes.

[thomthom]

Nice one Scott.

I seem to have come across three observer events that doesn't work. It would probably be useful to mark these in the docs with a warning so that people won't waste a whole lot of time trying to get them work work. ..like I have...

DefinitionObserver viewtopic.php?f=180&t=17631 (Completely busted)
EntitiesObserver.onContentsModified viewtopic.php?f=180&t=17970 (Add and Remove event works though. Haven't tried the Erase event.)

[ScottLininger]

I also just got this one from a coworker:

Sketchup.get_resource_path example fails. Looks like there's a required parameter that's not properly documented.

-Scott

[thomthom]

These failing observers is quite severe. I don't suppose there's a chance the dev team can push out an update outside the servicepack schedule? (I don't know what your schedule is, but seeing that we just got an servicepack I'm a bit pessimistic to when this might be addressed...)

[remus]

A semi related typo:

in this tutorial pt4=[0,9,9] whereas it should be [0,9,0].

[Chris Fullmer]

::OFF TOPIC::
All right Remus, come clean. Your always in the Ruby forum, you spotted a typo in tutorial, you answer questions once in a while....how much ruby do you know? Are you making plugins and selling them overseas for big money or something?

Chris

[ScottLininger]

Just saw another one: the Sketchup.break_edges= example is the Sketchup.break_edges? example.

Thom, step 1 with the observers is to confirm if it's the implementation that is broken or the documentation. Simone has filed A-list bugs against the observer problems you've found, and he and I have been chatting about it. Any fixes will have to wait until the next maintenance release.

Feel free to PM me if you want to brainstorm workarounds for what you're trying to accomplish. I know a few tricks.

[remus]

Dont pretend your not in on it as well

on a more serious note, it seems a shame to miss out on the ever so powerful ruby based capabilities of sketchup, so i thought i'd try my hand at it and see if i got anywhere.

I reckon i could just about right a box making script at the moment just as long as you dont want to change your box at all...

[thomthom]

Seems that InstanceObserver.onClose is dead as well. http://code.google.com/apis/sketchup/do ... ml#onClose
But onOpen works.

[thomthom]

http://code.google.com/intl/nb/apis/ske ... ctive_path

For example, if a user has double-clicked into a component to edit its geometry, and then double clicked into a sub-group to edit that, the active_path might contain:

And there it stops. Doesn't actually display an example.

[ScottLininger]

Self note: We should add these codes to the send_action docs:

http://groups.google.com/group/Ruby-API ... f2b21cb228

[TIG]

Self note: We should add these codes to the send_action docs:

http://groups.google.com/group/Ruby-API ... f2b21cb228

Does this list work 'across-platforms' - my understanding was that PCs and Macs differ ?

If there are such codes it makes like a lot easier...

Some "wrong": Sketchup.send_action 21513 >>> opens the Outliner ???
.

[thomthom]

http://code.google.com/apis/sketchup/do ... erver.html

Code: Select all

     # This is an example of an observer that watches tool interactions.
     class MyToolsObserver < Sketchup::ShadowInfoObserver
       def onActiveToolChanged(tools, tool_name, tool_id)
         UI.messagebox("onActiveToolChanged: " + tool_name.to_s)
       end
     end

     # Attach the observer.
     Sketchup.active_model.tools.add_observer(MyToolsObserver.new)


Note that it refers to Sketchup::ShadowInfoObserver instead of Sketchup::ToolsObserver.

[thomthom]

http://code.google.com/intl/nb/apis/ske ... l#dynamic=

The manual says the argument should be either true or false, but the example sets it to 3.

[Chris Fullmer]

The FAQ page lists some sites that carry/catalog ruby scripts. the Sketchucation extensions index (thanks to Jim!) would also be a great resource to add to that list now

extensions url:

http://www.sketchucation.com/extensions-index/

Chris

[thomthom]

http://code.google.com/apis/sketchup/do ... erver.html
It'd be nice if the ToolsObserver listed the full list of tools IDs.

I've begun a list here which associates constants to the IDs for convenient use in scripts: viewtopic.php?f=180&t=18124

[Jim]

http://code.google.com/apis/sketchup/docs/ourdoc/toolsobserver.html
It'd be nice if the ToolsObserver listed the full list of tools IDs.

I've begun a list here which associates constants to the IDs for convenient use in scripts: viewtopic.php?f=180&t=18124

In the back of my mind I have the idea the the tool id's were not reliable and shouldn't be used; but I can't remember why.

[thomthom]

http://code.google.com/apis/sketchup/docs/ourdoc/toolsobserver.html
It'd be nice if the ToolsObserver listed the full list of tools IDs.

I've begun a list here which associates constants to the IDs for convenient use in scripts: viewtopic.php?f=180&t=18124

In the back of my mind I have the idea the the tool id's were not reliable and shouldn't be used; but I can't remember why.

I thought is was the tool names as on Mac the first four characters where truncated? No?

[Chris Fullmer]

http://code.google.com/apis/sketchup/do ... definition

The ComponentInstance.definition example does not include the method in the example anywhere, so by definition it is not really an example.

This is the given example:

Code: Select all

 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/"