New API doc - typos and questions

Jim

@chris fullmer said:

You can do a dropdown box?

Sure, and I made this to ease the pain a little: http://sketchuptips.blogspot.com/2008/03/inputbox-class.html

thomthom

Nice one Jim.

Chris Fullmer

http://code.google.com/apis/sketchup/docs/ourdoc/point3d.html#z=

It says:

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/sketchup/docs/ourdoc/face.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


 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/docs/ourdoc/tool.html#onMouseMove

 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/docs/ourdoc/face.html#get_UVHelper

The code example:


 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:

@unknownuser said:

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/docs/ourdoc/modelobserver.html#onPlaceComponent

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

@thomthom said:

ModelObserver.onPlaceComponent
http://code.google.com/apis/sketchup/docs/ourdoc/modelobserver.html#onPlaceComponent

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/docs/ourdoc/definitionobserver.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 http://www.sketchucation.com/forums/scf/viewtopic.php?f=180&t=17631 (Completely busted)
EntitiesObserver.onContentsModified http://www.sketchucation.com/forums/scf/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.