Documentation problems

[cridalab]

every so often I come across something wrong in the documentation, which I haven't bothered reporting because each one is so trivial. But together they are significant so I'll post any more that I find here.

I'm currently using version 3,0,0,2055


Here's one that I remember, with the problem in bold:
setimagevarbydesc
(setimagevarbydesc "MyMovie.avi" "MovieRewind" 0)

[cridalab]

some more issues:

getcurrentdirectory
Returns the name of the currently directory as a string.


createtable and movealterationonobjectstack listed twice in Lisp functions tree view
degreetoradian not listed in Lisp functions tree view


missing documentation:
addmaterialstagetoscene, addmaterialtoscene, alignImages, clearoutputwindow, command, physicsaddvehicletire

[RadishArtist]

got 'em, thanks

Sue

[cridalab]

some bad links:
movealterationonobjectstack -> modulus
cond -> command

[cridalab]

now I'm using 2075.

In the main CScript API page:
For example the CSctipt doesn't support (or have the need for) pointers that are hard fro programmers to master in the C language. CScript is close enough to C that a CScript program is written it can be exported to a .cpp file and with minimal changes changed into a actual .dll plugin.

[RadishArtist]

fixed

thanks for reporting!

Sue

[cridalab]

I found that the cscript example is broken:

ec_Object pBall = ecCB_AddObjectToScene("Sphere","Ball");
ec_AddAlterationToObject(pBall,"Taper","MyTaper");
ec_CreateObject( pBall);

ec_Object undefined
ecCB_AddObjectToScene undefined, and has wrong arguments for ec_AddObjectToScene
ec_AddAlterationToObject undefined


This is my fixed version:
ec_pObject pBall = ec_AddObjectToScene(EC_OBJECTTYPE_SPHERE,"Ball");
ec_AddAlterationToObjectA(pBall,"Taper","MyTaper");
ec_CreateObject(pBall);


The example following is also broken but I haven't managed to fix it yet. I get an error "ERR: Expected expression value", which I'll ask about in a separate thread.

[cridalab]

I realized the error means I need a pointer, so here is the second example fixed:

ec_pImage pImage = ec_GetImageByName("OakWood");
ec_LockImage(pImage);
ec_SetDrawColor(pImage,255,0,0,255);
ec_DrawCircle(pImage,100,100,30);
ec_UnLockImage(pImage);

Apparently default values don't work so the alpha channel argument must be passed.

[bmistal]

Thanks! I've made the suggested modifications to the help files. There will be more CSCript related modifications in there to make, but hopefully over a short amount of time these will all get caught and corrected:)

Cheers,
Ben

[cridalab]

I noticed the C++ example is broken in the C API docs:
ec_Object pBall = ec_AddObjectToScene("Sphere","Ball");

Needs a pointer and sphere int:
ec_Object *pBall = ec_AddObjectToScene(EC_OBJECTTYPE_SPHERE, "Ball");


Also most of the links on the "Lisp Functions by Category" page of the docs are broken.

[Mouse]

Hi Richard,

we will be doing a complete doc audit in the coming weeks and we have had people ask about having the docs available online as a wiki to customers (only) so we can make sure the latest versions with everyone's feedback gets captured.

We think this is a great idea and are looking into it.

thanks much for these.

best

Mouse

[cridalab]

I look forward to it.
Bookmarks and more advanced search would be great.