Project

General

Profile

Scol standard library package  0.3.1
Common and usefull functions for all Scol applications
The library : 3d initialization API

Functions

 b3d_initError (logfilename, mask, hardlog)
 Initialiaze the internal error 3d library.
 b3d_initPhysics (strSession)
 Initialiaze the 3D PhysicsPrototype: fun [LIB3D_Session] LIB3D_Physics.
 b3d_initSession (strView, name, cbInit)
 Initialiaze the 3D Session. A default camera "camera_init", a default group "_defaultResources" and an ambiant light are defined too.
 b3d_initView (ch, winFather, cbInit, cbEnd)
 Initialiaze the 3D View.

Detailed Description

Function Documentation

b3d_initError ( logfilename  ,
mask  ,
hardlog   
)

Initialiaze the internal error 3d library.

This function should be called in a development mode or in a debugging mode.

Prototype: fun [S I I] I

Parameters
S: a base name for the log file, if any this file will put in the Logs directory
I: the mask level to set
I: a flag :
  • iLIB3D_LOGTEMPFILE : to put the datas in a temporary file;
  • iLIB3D_LOGHARDFILE : to put the datas in a hard file;
Returns
I : 0 if success or a positive value if error :
  • 1 : unable to build the internal error structure
  • 2 : unable to set the 'temporary file" mode
  • 3 : unable to create the error manager
  • 4 : unable to open the 'hard file' error manager
Examples:
3d_test/test_3d.pkg_.
b3d_initView ( ch  ,
winFather  ,
cbInit  ,
cbEnd   
)

Initialiaze the 3D View.

Prototype: fun [Chn ObjWin fun [LIB3D_View I] fun [LIB3D_View] I] I

Parameters
Chn: a channel, typically could be the current channel : _channel
ObjWin: the window mother
fun[LIB3D_View I] I : a function to run immediately after this initialization. The supplemental argument is 0 if success or a positive number if error.
fun[LIB3D_View] I : a function to run immediately before the 3d view destruction
Returns
LIB3D_View : the new 3d view object or nil if error.
Examples:
3d_test/test_3d.pkg_.
b3d_initSession ( strView  ,
name  ,
cbInit   
)

Initialiaze the 3D Session. A default camera "camera_init", a default group "_defaultResources" and an ambiant light are defined too.

Prototype: fun [LIB3D_View S fun [LIB3D_Session I] I] LIB3D_Session

Parameters
LIB3D_View: a valide View object
S: the session name \ param fun [LIB3D_Session I] I : function called when the initialization is ended. The supplemental argument is the result : 0 -> success, other value -> fail.
Returns
LIB3D_Session : the new 3d session object or nil if error.
Examples:
3d_test/test_3d.pkg_.
b3d_initPhysics ( strSession  )

Initialiaze the 3D PhysicsPrototype: fun [LIB3D_Session] LIB3D_Physics.

Parameters
LIB3D_Session: a valide Session object
Returns
LIB3D_Physics : the new 3d physics object or nil if error.