New API doc - typos and questions

Chris Fullmer · 26 May 2009, 18:24

I hope Scott stops by soon. He's got a lot of stuff here to pick up

Chris

thomthom · 26 May 2009, 18:26

Looking back at this thread I can trail the subjects I was looking into while making plugins. Like breadcrumbs.

TIG · 28 May 2009, 14:43

UI.menu lists the valid menus titles, one is 'Create' isn't it 'Draw' ?

RunnerPack · 28 May 2009, 22:29

@unknownuser said:

Point3d.offset (http://code.google.com/apis/sketchup/docs/ourdoc/point3d.html#offset ) Description of the length parameter:

(optional) the distance to offset. If not provided, the offset is my a distance equal to the vector length.

Suggestion:

The (optional) offset distance. If not provided, the point is offset a distance equal to the vector's length.

thomthom · 29 May 2009, 09:01

Face.mesh
http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/face.html#mesh

@unknownuser said:

The mesh method creates a polygon mesh that represents the face. See the PolygonMesh class for more information.

Valid flags are:
* 0: Include PolygonMeshPoints,
* 1: Include PolygonMeshUVQFront,
* 2: Include PolygonMeshUVQBack,
* 4: Include PolygonMeshNormals.
Add these numbers together to combine flags. A value of 5 will include all flags, for example.

The example uses 7. Typo or undocumented feature?

avariant · 29 May 2009, 14:47

@thomthom said:

The example uses 7. Typo or undocumented feature?

You can bit-wise OR the options together. 7 means 4 + 2 + 1, so normals, front UV, and back UV.

remus · 29 May 2009, 19:56

@unknownuser said:

For acolor it's always = 255 [100% opaque]... there is a color.alpha= method but it's never ever worked, you must set alpha [transparency] for a material itself not material.color e.g. material.alpha=0.4 for 40% opacity will work but the material.color.alpha still reports 255 [100%], if you try to change it, it just does nothing !

So to recap - the fourth item in a SUp material.color array is its alpha [r,g,b,a] but it's not used ! The alpha of the material itself works as a 0 to 1.0, equivalent to % setting of opacity...
http://code.google.com/apis/sketchup/do ... color.html

thomthom · 31 May 2009, 10:28

UI.inputbox
http://code.google.com/apis/sketchup/docs/ourdoc/ui.html#inputbox

Returns false, not nil when user cancels.

thomthom · 4 Jun 2009, 20:44

WebDialog.new
http://code.google.com/apis/sketchup/docs/ourdoc/webdialog.html#new

Two last parameters isn't explained.

remus · 6 Jun 2009, 20:16

BoundingBox.min

@unknownuser said:

returns: a Point3d object representing the point where x, y, and z are the maximum in the bounding box.

Im guessing it should say minimum.

thomthom · 9 Jun 2009, 18:13

WebDialog.get_element_value
http://code.google.com/apis/sketchup/docs/ourdoc/webdialog.html#get_element_value

The example hasn't escaped the HTML tags - so the HTML sample text is instead interpreted by the browser..

thomthom · 11 Jun 2009, 12:19

Curve.move_vertices
http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/curve.html#move_vertices

Description says:

@unknownuser said:

The vertices method retrieves a collection of all vertices in a curve.

thomthom · 12 Jun 2009, 08:09

Tool.enableVCB?
http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/tool.html#enableVCB ?

@unknownuser said:

The enableVCB? method is used to tell SketchUp whether to allow the user to enter text into the VCB (value control box, aka the "measurements" panel). If you do not implement this method, then the vcb is disabled by default.

I've never used this method for my Tools. But the VCB has still worked.

thomthom · 17 Jun 2009, 21:40

Image.size=
http://code.google.com/apis/sketchup/docs/ourdoc/image.html#size=

It appears that the second argument is optional.

thomthom · 18 Jun 2009, 10:55

Entity.entityID
http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/entity.html#entityID

@unknownuser said:

The entityID method is used to retrieve a unique ID assigned to an entity.

The entityID is not persistent between sessions.

Is it persistent within a session? Can it be relied on for the length of one session?

thomthom · 18 Jun 2009, 11:04

ComponentDefinition.guid
http://code.google.com/intl/nb/apis/sketchup/docs/ourdoc/componentdefinition.html#guid

Is this value persistent between sessions?

Jim · 19 Jun 2009, 12:13

Sketchup::Color.new

new can accept a hex value (not string) as the parameter: for example 0xFF0000 (undocumented)

But, it reverses the red and blue values. Here is a Console session. (bug)


Sketchup;;Color.new 0xFF0000
Color(  0,   0, 255, 255)
Sketchup;;Color.new 0x0000FF
Color(255,   0,   0, 255)

scottlininger · 19 Jun 2009, 22:55

I've got some catching up to do. Thanks for all of the details, guys!

thomthom · 20 Jun 2009, 10:10

ModelObserver.onDeleteModel vs ModelObserver.onEraseAll
http://code.google.com/apis/sketchup/docs/ourdoc/modelobserver.html#onDeleteModel

When does the onDeleteModel event trigger? I don't think I've ever seen it trigger. When I open an existing model or create a new model onEraseAll is triggered.

Jim · 21 Jun 2009, 22:34

UI.start_timer

This post on the API blog is showing start_timer with a fraction of a second resolution. In my experience, UI.start_timer has a whole second resolution and rounds partial seconds down to the nearest second.


    t1=Time.now; UI.start_timer(0.1) {p Time.now-t1} ==> 0.01
    t1=Time.now; UI.start_timer(0.999) {p Time.now-t1} ==> 0.01
    t1=Time.now; UI.start_timer(1) {p Time.now-t1} ==> 1.001
    t1=Time.now; UI.start_timer(1.9) {p Time.now-t1} ==> 1.002