Scol functions definition

Functions

int SO3BufferCreate (mmachine m)
 SO3BufferCreate : This function create a new SO3_BUFFER Object.
int SO3BufferSetProperties (mmachine m)
 SO3BufferSetProperties : This function set the properties of a SO3_BUFFER Object.
int SO3BufferSetPositionSize (mmachine m)
 SO3BufferSetPositionSize : This function set the position and size of a SO3_BUFFER Object and launch the size CallBack.
int SO3BufferGetPositionSize (mmachine m)
 SO3BufferGetPositionSize : This function retrieve the position and the size of a SO3_BUFFER Object.
int SO3BufferSetStereoVision (mmachine m)
 SO3BufferSetStereoVision : This function set the stereo vision mode on a SO3_BUFFER Object.
int SO3BufferSetFocus (mmachine m)
 SO3BufferSetFocus : function to set the focus on a SO3_BUFFER.
int SO3CbBufferClick (mmachine m)
 SO3CbBufferClick : This function sets the callback to be executed when SO3_BUFFER is clicked.
int SO3CbBufferUnclick (mmachine m)
 SO3CbBufferUnclick : This function sets the callback to be executed when SO3_BUFFER is clicked.
int SO3CbBufferDClick (mmachine m)
 SO3CbBufferDClick : This function sets the callback to be executed when SO3_BUFFER is double clicked.
int SO3CbBufferDrop (mmachine m)
 SO3CbBufferDrop : This function sets the callback to be executed when files are dropped to SO3_BUFFER.
int SO3CbBufferMouseMove (mmachine m)
 SO3CbBufferMouseMove : This function sets the callback to be executed when mouse is moving in a SO3_BUFFER.
int SO3CbBufferWheel (mmachine m)
 SO3CbBufferWheel : This function sets the callback to be executed when there is a mouse wheel event on a SO3_BUFFER.
int SO3CbBufferKeyDown (mmachine m)
 SO3CbBufferKeyDown : This function sets the callback to be executed when there is a keyDown event on a SO3_BUFFER.
int SO3CbBufferSize (mmachine m)
 SO3CbBufferSize : This function sets the callback to be executed when there is a reSize event on a SO3_BUFFER.
int SO3CbBufferClose (mmachine m)
 SO3CbBufferClose : This function sets the callback to be executed when there is a close event on a SO3_BUFFER.
int SO3CbBufferDestroy (mmachine m)
 SO3CbBufferDestroy : This function sets the callback to be executed when there is a destroy event on a SO3_BUFFER.
int SO3CbBufferKeyUp (mmachine m)
 SO3CbBufferKeyUp : This function sets the callback to be executed when there is a keyUp event on a SO3_BUFFER.
int SO3BufferGetStereoVisionProperties (mmachine m)
 SO3BufferGetStereoVisionProperties : Get stereo vision properties.
int SO3GetAPIVersion (mmachine m)
 SO3GetAPIVersion : Get the SO3 plugin API version.
int SO3GetGeneralInfo (mmachine m)
 SO3GetGeneralInfo : Get general informations about the user system.
int SO3GetFullscreenVideoMode (mmachine m)
 SO3GetFullscreenVideoMode : Get fullscreen video mode supported by user.
int SO3GetMultisamplingMode (mmachine m)
 SO3GetMultisamplingMode : Get multi sampling mode supported by user.
int SO3BufferGetFSAA (mmachine m)
 SO3BufferGetFSAA : Get multi sampling mode setted.
int SO3GetRendererInfo (mmachine m)
 SO3GetRendererInfo : get rendering informations.
int SO3GetRendererList (mmachine m)
 SO3GetRendererList : get renderers list.
int SO3GetActiveRenderer (mmachine m)
 SO3GetActiveRenderer : get active renderer.
int SO3BufferGetAverageFPS (mmachine m)
 SO3BufferGetAverageFPS : get the average FPS.
int SO3BufferGetBestFPS (mmachine m)
 SO3BufferGetBestFPS : get the best FPS.
int SO3BufferGetWorstFPS (mmachine m)
 SO3BufferGetWorstFPS : get the worst FPS.
int SO3BufferGetBestFrametime (mmachine m)
 SO3BufferGetBestFrametime : get the best frametime.
int SO3BufferGetWorstFrametime (mmachine m)
 SO3BufferGetWorstFrametime : get the worst frametime.
int SO3BufferGetTriangleCount (mmachine m)
 SO3BufferGetTriangleCount : get the number of triangle displayed in a SO3_BUFFER.
int SO3BufferGetBatchCount (mmachine m)
 SO3BufferGetBatchCount : get the batch count displayed in a SO3_BUFFER.
int SO3OverlayCreate (mmachine m)
 SO3OverlayCreate : Create an SO3_OVERLAY.
int SO3DebugDisplayProperties (mmachine m)
 SO3DebugDisplayProperties : Create an SO3_OVERLAY.
int SO3DebugSetText (mmachine m)
 SO3DebugSetText : Set Debug Text on a Viewport.
int SO3DebugSetEnable (mmachine m)
 SO3DebugSetEnable : Set Debug Text enable/disable on a Viewport.
int SO3DebugGetEnable (mmachine m)
 SO3DebugGetEnable : Get Debug Text enable/disable on a Viewport.
int SO3BufferUpdate (mmachine m)
 SO3BufferUpdate : function to update a SO3_BUFFER.
int SO3CbBufferPreRender (mmachine m)
 SO3CbBufferPreRender : Set the callback for pre render event.
int SO3CbBufferPostRender (mmachine m)
 SO3CbBufferPostRender : Set the callback for post render event.
int SO3DestroyBuffer (mmachine m)
 SO3DestroyBuffer : Scol function to destroy a SO3_BUFFER.
int SO3MathsQuatToEulerXYZ (mmachine m)
 SO3MathsQuatToEulerXYZ : Scol function to transform quaternion vector in euler angles (XYZ).
int SO3MathsQuatToEulerXZY (mmachine m)
 SO3MathsQuatToEulerXZY : Scol function to transform quaternion vector in euler angles (XZY).
int SO3MathsQuatToEulerYXZ (mmachine m)
 SO3MathsQuatToEulerYXZ : Scol function to transform quaternion vector in euler angles (YXZ).
int SO3MathsQuatToEulerYZX (mmachine m)
 SO3MathsQuatToEulerYZX : Scol function to transform quaternion vector in euler angles (YZX).
int SO3MathsQuatToEulerZXY (mmachine m)
 SO3MathsQuatToEulerZXY : Scol function to transform quaternion vector in euler angles (ZXY).
int SO3MathsQuatToEulerZYX (mmachine m)
 SO3MathsQuatToEulerZYX : Scol function to transform quaternion vector in euler angles (ZYX).
int SO3MathsQuatToEulerDegreeXYZ (mmachine m)
 SO3MathsQuatToEulerDegreeXYZ : Scol function to transform quaternion vector in euler angles (degree) (XYZ).
int SO3MathsQuatToEulerDegreeXZY (mmachine m)
 SO3MathsQuatToEulerDegreeXZY : Scol function to transform quaternion vector in euler angles (degree) (XZY).
int SO3MathsQuatToEulerDegreeYXZ (mmachine m)
 SO3MathsQuatToEulerDegreeYXZ : Scol function to transform quaternion vector in euler angles (degree) (YXZ).
int SO3MathsQuatToEulerDegreeYZX (mmachine m)
 SO3MathsQuatToEulerDegreeYZX : Scol function to transform quaternion vector in euler angles (degree) (YZX).
int SO3MathsQuatToEulerDegreeZXY (mmachine m)
 SO3MathsQuatToEulerDegreeZXY : Scol function to transform quaternion vector in euler angles (degree) (ZXY).
int SO3MathsQuatToEulerDegreeZYX (mmachine m)
 SO3MathsQuatToEulerDegreeZYX : Scol function to transform quaternion vector in euler angles (degree) (ZYX).
int SO3MathsEulerXYZToQuat (mmachine m)
 SO3MathsEulerXYZToQuat : Scol function to transform euler angles (XYZ) (redian) in a quaternion.
int SO3MathsEulerXZYToQuat (mmachine m)
 SO3MathsEulerXZYToQuat : Scol function to transform euler angles (XZY) (redian) in a quaternion.
int SO3MathsEulerYXZToQuat (mmachine m)
 SO3MathsEulerYXZToQuat : Scol function to transform euler angles (YXZ) (redian) in a quaternion.
int SO3MathsEulerYZXToQuat (mmachine m)
 SO3MathsEulerYZXToQuat : Scol function to transform euler angles (YZX) (redian) in a quaternion.
int SO3MathsEulerZYXToQuat (mmachine m)
 SO3MathsEulerZYXToQuat : Scol function to transform euler angles (ZYX) (redian) in a quaternion.
int SO3MathsEulerZXYToQuat (mmachine m)
 SO3MathsEulerZXYToQuat : Scol function to transform euler angles (ZXY) (redian) in a quaternion.
int SO3MathsQuatDiff (mmachine m)
 SO3MathsQuatDiff : Scol function to make the matematical difference between two quaternions.
int SO3MathsQuatSubstract (mmachine m)
 SO3MathsQuatSubstract : Scol function to substract two quaternions.
int SO3MathsQuatAdd (mmachine m)
 SO3MathsQuatAdd : Scol function to add two quaternions.
int SO3MathsQuatInterpolate (mmachine m)
 SO3MathsQuatInterpolate : function to interpolate two quaternions.
int SO3MathsDegreeToRadian (mmachine m)
 SO3MathsDegreeToRadian : function to convert a value from degrees to radians.
int SO3MathsRadianToDegree (mmachine m)
 SO3MathsRadianToDegree : function to convert a value from radians to degrees.
int SO3MathsQuatGetRoll (mmachine m)
 SO3MathsQuatGetRoll : function to get the roll value from quaternion.
int SO3MathsQuatGetYaw (mmachine m)
 SO3MathsQuatGetYaw : function to get the yaw value from quaternion.
int SO3MathsQuatGetPitch (mmachine m)
 SO3MathsQuatGetPitch : function to get the pitch value from quaternion.
int SO3MathsQuatGetDegreeRoll (mmachine m)
 SO3MathsQuatGetDegreeRoll : function to get the roll value in degree from quaternion.
int SO3MathsQuatGetDegreeYaw (mmachine m)
 SO3MathsQuatGetDegreeYaw : function to get the yaw value in degree from quaternion.
int SO3MathsQuatGetDegreePitch (mmachine m)
 SO3MathsQuatGetDegreePitch : function to get the pitch value in degree from quaternion.
int SO3MathsQuatToAxes (mmachine m)
 SO3MathsQuatToAxes : function to project quaternion to axis values.
int SO3MathsQuatFromAngleAxes (mmachine m)
 SO3MathsQuatFromAngleAxes : function to get Quaternion from angle axis.
int SO3MathsQuatFromAxes (mmachine m)
 SO3MathsQuatFromAxes : function to get Quaternion from axis.
int SO3MathsQuatGetXaxis (mmachine m)
 SO3MathsQuatGetXaxis : function to get X-axis from quaternion.
int SO3MathsQuatGetYaxis (mmachine m)
 SO3MathsQuatGetYaxis : function to get Y-axis from quaternion.
int SO3MathsQuatGetZaxis (mmachine m)
 SO3MathsQuatGetZaxis : function to get Z-axis from quaternion.
int SO3MathsQuatGetDirection (mmachine m)
 SO3MathsQuatGetDirection : function to get the direction from quaternion.
int SO3MathsClampValue (mmachine m)
 SO3MathsClampValue : function to clamp a value.

Detailed Description

Scol functions definition

Function Documentation

int SO3BufferCreate ( mmachine  m  ) 

SO3BufferCreate : This function create a new SO3_BUFFER Object.

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

Parameters:
Chn : the current channel
ObjWin : the current parent window
I : x position
I : y position
I : w size
I : h size
Returns:
SO3_BUFFER : The Buffer Object

Definition at line 2209 of file SO3SCOL.cpp.

int SO3BufferGetAverageFPS ( mmachine  m  ) 

SO3BufferGetAverageFPS : get the average FPS.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : average FPS if success, NIL otherwise

Definition at line 3242 of file SO3SCOL.cpp.

int SO3BufferGetBatchCount ( mmachine  m  ) 

SO3BufferGetBatchCount : get the batch count displayed in a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
I : batch count if success, NIL otherwise

Definition at line 3389 of file SO3SCOL.cpp.

int SO3BufferGetBestFPS ( mmachine  m  ) 

SO3BufferGetBestFPS : get the best FPS.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Best FPS if success, NIL otherwise

Definition at line 3266 of file SO3SCOL.cpp.

int SO3BufferGetBestFrametime ( mmachine  m  ) 

SO3BufferGetBestFrametime : get the best frametime.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Best FrameTime if success, NIL otherwise

Definition at line 3315 of file SO3SCOL.cpp.

int SO3BufferGetFSAA ( mmachine  m  ) 

SO3BufferGetFSAA : Get multi sampling mode setted.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
I : multisampling mode if success , NIL otherwise

Definition at line 3130 of file SO3SCOL.cpp.

int SO3BufferGetPositionSize ( mmachine  m  ) 

SO3BufferGetPositionSize : This function retrieve the position and the size of a SO3_BUFFER Object.

Prototype: fun [SO3_BUFFER] [I I I I]

Parameters:
SO3_BUFFER : the current buffer
Returns:
[I I I I] : position and size if success, NIL otherwise

Definition at line 2449 of file SO3SCOL.cpp.

int SO3BufferGetStereoVisionProperties ( mmachine  m  ) 

SO3BufferGetStereoVisionProperties : Get stereo vision properties.

Prototype: fun [SO3_BUFFER] [I F F]

Parameters:
SO3_BUFFER : Current Buffer
Returns:
[I F F] : mode, eyes spacing and focal lenght if success, NIL otherwise

Definition at line 2837 of file SO3SCOL.cpp.

int SO3BufferGetTriangleCount ( mmachine  m  ) 

SO3BufferGetTriangleCount : get the number of triangle displayed in a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
I : Number of triangle if success, NIL otherwise

Definition at line 3364 of file SO3SCOL.cpp.

int SO3BufferGetWorstFPS ( mmachine  m  ) 

SO3BufferGetWorstFPS : get the worst FPS.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Worst FPS if success, NIL otherwise

Definition at line 3290 of file SO3SCOL.cpp.

int SO3BufferGetWorstFrametime ( mmachine  m  ) 

SO3BufferGetWorstFrametime : get the worst frametime.

Prototype: fun [SO3_BUFFER] F

Parameters:
SO3_BUFFER : current SO3_BUFFER
Returns:
F : Worst FrameTime if success, NIL otherwise

Definition at line 3339 of file SO3SCOL.cpp.

int SO3BufferSetFocus ( mmachine  m  ) 

SO3BufferSetFocus : function to set the focus on a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : the current buffer
Returns:
I : 1 if success, NIL otherwise

Definition at line 2604 of file SO3SCOL.cpp.

int SO3BufferSetPositionSize ( mmachine  m  ) 

SO3BufferSetPositionSize : This function set the position and size of a SO3_BUFFER Object and launch the size CallBack.

Prototype: fun [SO3_BUFFER I I I] I

Parameters:
SO3_BUFFER : the current buffer
I : w size
I : h size
I : x position
I : y position
Returns:
1 if success , NIL otherwise

Definition at line 2418 of file SO3SCOL.cpp.

int SO3BufferSetProperties ( mmachine  m  ) 

SO3BufferSetProperties : This function set the properties of a SO3_BUFFER Object.

Prototype: fun [SO3_BUFFER I I I] I

Parameters:
SO3_BUFFER : the current buffer
I : w size
I : h size
I : boolean for fullsceen mode
Returns:
1 if success , NIL otherwise

Definition at line 2292 of file SO3SCOL.cpp.

int SO3BufferSetStereoVision ( mmachine  m  ) 

SO3BufferSetStereoVision : This function set the stereo vision mode on a SO3_BUFFER Object.

Prototype: fun [SO3_BUFFER I F F] I

Parameters:
SO3_BUFFER : the current buffer
I : the current mode
F : the current eyes spacing
F : the current focal lenght
Returns:
I : 1 if success, NIL otherwise

Definition at line 2481 of file SO3SCOL.cpp.

int SO3BufferUpdate ( mmachine  m  ) 

SO3BufferUpdate : function to update a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : given buffer object
Returns:
I : 1 if success, NIL otherwise

Definition at line 3631 of file SO3SCOL.cpp.

int SO3CbBufferClick ( mmachine  m  ) 

SO3CbBufferClick : This function sets the callback to be executed when SO3_BUFFER is clicked.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I I I] u1 : The callback to call when the event occurs ; paramters are x,y mouse coordinates, button, flags
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2623 of file SO3SCOL.cpp.

int SO3CbBufferClose ( mmachine  m  ) 

SO3CbBufferClose : This function sets the callback to be executed when there is a close event on a SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0] u1 : The callback to call when the event occurs
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2778 of file SO3SCOL.cpp.

int SO3CbBufferDClick ( mmachine  m  ) 

SO3CbBufferDClick : This function sets the callback to be executed when SO3_BUFFER is double clicked.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I I] u1 : The callback to call when the event occurs ; paramters are x,y mouse coordinates, button
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2661 of file SO3SCOL.cpp.

int SO3CbBufferDestroy ( mmachine  m  ) 

SO3CbBufferDestroy : This function sets the callback to be executed when there is a destroy event on a SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0] u1 : The callback to call when the event occurs
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2798 of file SO3SCOL.cpp.

int SO3CbBufferDrop ( mmachine  m  ) 

SO3CbBufferDrop : This function sets the callback to be executed when files are dropped to SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I [P r1]] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I [P r1]] u1 : The callback to call when the event occurs ; paramters are x,y mouse cordinates, files drop
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2680 of file SO3SCOL.cpp.

int SO3CbBufferKeyDown ( mmachine  m  ) 

SO3CbBufferKeyDown : This function sets the callback to be executed when there is a keyDown event on a SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I] u1 : The callback to call when the event occurs
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2738 of file SO3SCOL.cpp.

int SO3CbBufferKeyUp ( mmachine  m  ) 

SO3CbBufferKeyUp : This function sets the callback to be executed when there is a keyUp event on a SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I] u1 : The callback to call when the event occurs
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2818 of file SO3SCOL.cpp.

int SO3CbBufferMouseMove ( mmachine  m  ) 

SO3CbBufferMouseMove : This function sets the callback to be executed when mouse is moving in a SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I I] u1 : The callback to call when the event occurs ; paramters are x,y mouse cordinates
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2700 of file SO3SCOL.cpp.

int SO3CbBufferPostRender ( mmachine  m  ) 

SO3CbBufferPostRender : Set the callback for post render event.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : given buffer object
fun [SO3_BUFFER u0] u1 : function scol to call
u0 : user parameter
Returns:
SO3_BUFFER : buffer object if success

Definition at line 3679 of file SO3SCOL.cpp.

int SO3CbBufferPreRender ( mmachine  m  ) 

SO3CbBufferPreRender : Set the callback for pre render event.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : given buffer object
fun [SO3_BUFFER u0] u1 : function scol to call
u0 : user parameter
Returns:
SO3_BUFFER : buffer object if success

Definition at line 3654 of file SO3SCOL.cpp.

int SO3CbBufferSize ( mmachine  m  ) 

SO3CbBufferSize : This function sets the callback to be executed when there is a reSize event on a SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I] u1 : The callback to call when the event occurs
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2758 of file SO3SCOL.cpp.

int SO3CbBufferUnclick ( mmachine  m  ) 

SO3CbBufferUnclick : This function sets the callback to be executed when SO3_BUFFER is clicked.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I I I] u1 : The callback to call when the event occurs ; paramters are x,y mouse coordinates, button, flags
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2642 of file SO3SCOL.cpp.

int SO3CbBufferWheel ( mmachine  m  ) 

SO3CbBufferWheel : This function sets the callback to be executed when there is a mouse wheel event on a SO3_BUFFER.

Prototype: fun [SO3_BUFFER fun [SO3_BUFFER u0 I I I I] u1 u0] SO3_BUFFER

Parameters:
SO3_BUFFER : curent SO3_BUFFER
fun [SO3_BUFFER u0 I I I I] u1 : The callback to call when the event occurs
u0 : User parameter
Returns:
SO3_BUFFER : the current SO3_BUFFER

Definition at line 2719 of file SO3SCOL.cpp.

int SO3DebugDisplayProperties ( mmachine  m  ) 

SO3DebugDisplayProperties : Create an SO3_OVERLAY.

Prototype: fun [SO3_SCENE SO3_VIEWPORT SO3_MATERIAL I [I I] [I I] I] I

Parameters:
SO3_SCENE : current scene
SO3_VIEWPORT : current viewport
SO3_MATERIAL : material for font display
I : given color
[I I] : given dimensions
[I I] : given positions
I : given char Height
Returns:
I : 1 if success, NIL otherwise

Definition at line 3444 of file SO3SCOL.cpp.

int SO3DebugGetEnable ( mmachine  m  ) 

SO3DebugGetEnable : Get Debug Text enable/disable on a Viewport.

Prototype: fun [SO3_VIEWPORT] I

Parameters:
SO3_VIEWPORT : current viewport
Returns:
I : 1 if enable, 0 if disable, NIL otherwise

Definition at line 3605 of file SO3SCOL.cpp.

int SO3DebugSetEnable ( mmachine  m  ) 

SO3DebugSetEnable : Set Debug Text enable/disable on a Viewport.

Prototype: fun [SO3_VIEWPORT I] I

Parameters:
SO3_VIEWPORT : current viewport
I : boolean for enable/disable
Returns:
I : 1 if success, NIL otherwise

Definition at line 3565 of file SO3SCOL.cpp.

int SO3DebugSetText ( mmachine  m  ) 

SO3DebugSetText : Set Debug Text on a Viewport.

Prototype: fun [SO3_VIEWPORT S] I

Parameters:
SO3_VIEWPORT : current viewport
S : Text to set
Returns:
I : 1 if success, NIL otherwise

Definition at line 3523 of file SO3SCOL.cpp.

int SO3DestroyBuffer ( mmachine  m  ) 

SO3DestroyBuffer : Scol function to destroy a SO3_BUFFER.

Prototype: fun [SO3_BUFFER] I

Parameters:
SO3_BUFFER : current buffer window
Returns:
I : 1 if success, NIL otherwise

Definition at line 3724 of file SO3SCOL.cpp.

int SO3GetActiveRenderer ( mmachine  m  ) 

SO3GetActiveRenderer : get active renderer.

Prototype: fun [] S

Returns:
S : Active renderder if success, NIL otherwise

Definition at line 3221 of file SO3SCOL.cpp.

int SO3GetAPIVersion ( mmachine  m  ) 

SO3GetAPIVersion : Get the SO3 plugin API version.

Prototype: fun [] [S S]

Returns:
[S S] : scol VM version and Ogre3d version if success, NIL otherwise

Definition at line 2881 of file SO3SCOL.cpp.

int SO3GetFullscreenVideoMode ( mmachine  m  ) 

SO3GetFullscreenVideoMode : Get fullscreen video mode supported by user.

Prototype: fun [] [S r1]

Returns:
[S r1] : video mode

Definition at line 3033 of file SO3SCOL.cpp.

int SO3GetGeneralInfo ( mmachine  m  ) 

SO3GetGeneralInfo : Get general informations about the user system.

Prototype: fun [] [S S S S S S S S]

Returns:
[S S S S S S S S] : Genral Informations
  • Vendor CPU Name ;
  • CPU Name ;
  • Number of processors ;
  • RAM ;
  • OS version ;
  • Graphic device ;
  • Graphic driver ;
  • DirectX version ;

Definition at line 2910 of file SO3SCOL.cpp.

int SO3GetMultisamplingMode ( mmachine  m  ) 

SO3GetMultisamplingMode : Get multi sampling mode supported by user.

Prototype: fun [] [S r1]

Returns:
[S r1] : multisampling mode

Definition at line 3076 of file SO3SCOL.cpp.

int SO3GetRendererInfo ( mmachine  m  ) 

SO3GetRendererInfo : get rendering informations.

Prototype: fun [] [S S]

Returns:
[S S] : Rendering Informations
  • current render system
  • list of rendering system supported

Definition at line 3159 of file SO3SCOL.cpp.

int SO3GetRendererList ( mmachine  m  ) 

SO3GetRendererList : get renderers list.

Prototype: fun [] [S r1]

Returns:
[S r1] : Renderer list

Definition at line 3184 of file SO3SCOL.cpp.

int SO3MathsClampValue ( mmachine  m  ) 

SO3MathsClampValue : function to clamp a value.

Prototype: fun [F F F] F

Parameters:
[F F F] : values : min, max and clamp value
Returns:
F : result value if success, NIL otherwise

Definition at line 5296 of file SO3SCOL.cpp.

int SO3MathsDegreeToRadian ( mmachine  m  ) 

SO3MathsDegreeToRadian : function to convert a value from degrees to radians.

Prototype: fun [F] F

Parameters:
F : value in degree
Returns:
F : result in radian if success, NIL otherwise

Definition at line 4717 of file SO3SCOL.cpp.

int SO3MathsEulerXYZToQuat ( mmachine  m  ) 

SO3MathsEulerXYZToQuat : Scol function to transform euler angles (XYZ) (redian) in a quaternion.

Prototype: fun [[F F F]] [F F F F]

Parameters:
[F F F] : current quaternion
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 4240 of file SO3SCOL.cpp.

int SO3MathsEulerXZYToQuat ( mmachine  m  ) 

SO3MathsEulerXZYToQuat : Scol function to transform euler angles (XZY) (redian) in a quaternion.

Prototype: fun [[F F F]] [F F F F]

Parameters:
[F F F] : current quaternion
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 4283 of file SO3SCOL.cpp.

int SO3MathsEulerYXZToQuat ( mmachine  m  ) 

SO3MathsEulerYXZToQuat : Scol function to transform euler angles (YXZ) (redian) in a quaternion.

Prototype: fun [[F F F]] [F F F F]

Parameters:
[F F F] : current quaternion
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 4326 of file SO3SCOL.cpp.

int SO3MathsEulerYZXToQuat ( mmachine  m  ) 

SO3MathsEulerYZXToQuat : Scol function to transform euler angles (YZX) (redian) in a quaternion.

Prototype: fun [[F F F]] [F F F F]

Parameters:
[F F F] : current quaternion
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 4370 of file SO3SCOL.cpp.

int SO3MathsEulerZXYToQuat ( mmachine  m  ) 

SO3MathsEulerZXYToQuat : Scol function to transform euler angles (ZXY) (redian) in a quaternion.

Prototype: fun [[F F F]] [F F F F]

Parameters:
[F F F] : current quaternion
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 4458 of file SO3SCOL.cpp.

int SO3MathsEulerZYXToQuat ( mmachine  m  ) 

SO3MathsEulerZYXToQuat : Scol function to transform euler angles (ZYX) (redian) in a quaternion.

Prototype: fun [[F F F]] [F F F F]

Parameters:
[F F F] : current quaternion
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 4414 of file SO3SCOL.cpp.

int SO3MathsQuatAdd ( mmachine  m  ) 

SO3MathsQuatAdd : Scol function to add two quaternions.

Prototype: fun [[F F F F] [F F F F]] [F F F F]

Parameters:
[F F F F] : quaternion 1
[F F F F] : quaternion 2
Returns:
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 4608 of file SO3SCOL.cpp.

int SO3MathsQuatDiff ( mmachine  m  ) 

SO3MathsQuatDiff : Scol function to make the matematical difference between two quaternions.

Prototype: fun [[F F F F] [F F F F]] [F F F F]

Parameters:
[F F F F] : quaternion 1
[F F F F] : quaternion 2
Returns:
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 4503 of file SO3SCOL.cpp.

int SO3MathsQuatFromAngleAxes ( mmachine  m  ) 

SO3MathsQuatFromAngleAxes : function to get Quaternion from angle axis.

Prototype: fun [[F F F] [F F F] [F F F]] [F F F F]

Parameters:
[F F F] [F F F] [F F F] : given angle axis transformations
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 5030 of file SO3SCOL.cpp.

int SO3MathsQuatFromAxes ( mmachine  m  ) 

SO3MathsQuatFromAxes : function to get Quaternion from axis.

Prototype: fun [[F F F] [F F F] [F F F]] [F F F F]

Parameters:
[F F F] [F F F] [F F F] : given angle axis transformations
Returns:
[F F F F] : quaternion if success, NIL otherwise

Definition at line 5081 of file SO3SCOL.cpp.

int SO3MathsQuatGetDegreePitch ( mmachine  m  ) 

SO3MathsQuatGetDegreePitch : function to get the pitch value in degree from quaternion.

Prototype: fun [[F F F F] I] F

Parameters:
[F F F F] : given quaternion
I : boolean : if true : reproject axis
Returns:
F : pitch value in degree if success, NIL otherwise

Definition at line 4935 of file SO3SCOL.cpp.

int SO3MathsQuatGetDegreeRoll ( mmachine  m  ) 

SO3MathsQuatGetDegreeRoll : function to get the roll value in degree from quaternion.

Prototype: fun [[F F F F] I] F

Parameters:
[F F F F] : given quaternion
I : boolean : if true : reproject axis
Returns:
F : roll value in degree if success, NIL otherwise

Definition at line 4869 of file SO3SCOL.cpp.

int SO3MathsQuatGetDegreeYaw ( mmachine  m  ) 

SO3MathsQuatGetDegreeYaw : function to get the yaw value in degree from quaternion.

Prototype: fun [[F F F F] I] F

Parameters:
[F F F F] : given quaternion
I : boolean : if true : reproject axis
Returns:
F : yaw value in degree if success, NIL otherwise

Definition at line 4902 of file SO3SCOL.cpp.

int SO3MathsQuatGetDirection ( mmachine  m  ) 

SO3MathsQuatGetDirection : function to get the direction from quaternion.

Prototype: fun [[F F F F] [F F F]] [F F F]

Parameters:
[F F F F] : given quaternion
[F F F] : given vector for projection
Returns:
[F F F] : Direction vector if success, NIL otherwise

Definition at line 5251 of file SO3SCOL.cpp.

int SO3MathsQuatGetPitch ( mmachine  m  ) 

SO3MathsQuatGetPitch : function to get the pitch value from quaternion.

Prototype: fun [[F F F F] I] F

Parameters:
[F F F F] : given quaternion
I : boolean : if true : reproject axis
Returns:
F : pitch value in radian if success, NIL otherwise

Definition at line 4836 of file SO3SCOL.cpp.

int SO3MathsQuatGetRoll ( mmachine  m  ) 

SO3MathsQuatGetRoll : function to get the roll value from quaternion.

Prototype: fun [[F F F F] I] F

Parameters:
[F F F F] : given quaternion
I : boolean : if true : reproject axis
Returns:
F : roll value in radian if success, NIL otherwise

Definition at line 4770 of file SO3SCOL.cpp.

int SO3MathsQuatGetXaxis ( mmachine  m  ) 

SO3MathsQuatGetXaxis : function to get X-axis from quaternion.

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : given quaternion
Returns:
[F F F] : X axis if success, NIL otherwise

Definition at line 5132 of file SO3SCOL.cpp.

int SO3MathsQuatGetYaw ( mmachine  m  ) 

SO3MathsQuatGetYaw : function to get the yaw value from quaternion.

Prototype: fun [[F F F F] I] F

Parameters:
[F F F F] : given quaternion
I : boolean : if true : reproject axis
Returns:
F : yaw value in radian if success, NIL otherwise

Definition at line 4803 of file SO3SCOL.cpp.

int SO3MathsQuatGetYaxis ( mmachine  m  ) 

SO3MathsQuatGetYaxis : function to get Y-axis from quaternion.

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : given quaternion
Returns:
[F F F] : Y axis if success, NIL otherwise

Definition at line 5170 of file SO3SCOL.cpp.

int SO3MathsQuatGetZaxis ( mmachine  m  ) 

SO3MathsQuatGetZaxis : function to get Z-axis from quaternion.

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : given quaternion
Returns:
[F F F] : Z axis if success, NIL otherwise

Definition at line 5210 of file SO3SCOL.cpp.

int SO3MathsQuatInterpolate ( mmachine  m  ) 

SO3MathsQuatInterpolate : function to interpolate two quaternions.

Prototype: fun [[F F F F] [F F F F]] [F F F F]

Parameters:
[F F F F] : quaternion 1
[F F F F] : quaternion 2
Returns:
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 4660 of file SO3SCOL.cpp.

int SO3MathsQuatSubstract ( mmachine  m  ) 

SO3MathsQuatSubstract : Scol function to substract two quaternions.

Prototype: fun [[F F F F] [F F F F]] [F F F F]

Parameters:
[F F F F] : quaternion 1
[F F F F] : quaternion 2
Returns:
[F F F F] : quaternion result if success, NIL otherwise

Definition at line 4556 of file SO3SCOL.cpp.

int SO3MathsQuatToAxes ( mmachine  m  ) 

SO3MathsQuatToAxes : function to project quaternion to axis values.

Prototype: fun [[F F F F]] [[F F F] [F F F] [F F F]]

Parameters:
[F F F F] : given quaternion
Returns:
[[F F F] [F F F] [F F F]] : axis vectors if success, NIL otherwise

Definition at line 4967 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerDegreeXYZ ( mmachine  m  ) 

SO3MathsQuatToEulerDegreeXYZ : Scol function to transform quaternion vector in euler angles (degree) (XYZ).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 4000 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerDegreeXZY ( mmachine  m  ) 

SO3MathsQuatToEulerDegreeXZY : Scol function to transform quaternion vector in euler angles (degree) (XZY).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 4040 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerDegreeYXZ ( mmachine  m  ) 

SO3MathsQuatToEulerDegreeYXZ : Scol function to transform quaternion vector in euler angles (degree) (YXZ).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 4080 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerDegreeYZX ( mmachine  m  ) 

SO3MathsQuatToEulerDegreeYZX : Scol function to transform quaternion vector in euler angles (degree) (YZX).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 4120 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerDegreeZXY ( mmachine  m  ) 

SO3MathsQuatToEulerDegreeZXY : Scol function to transform quaternion vector in euler angles (degree) (ZXY).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 4160 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerDegreeZYX ( mmachine  m  ) 

SO3MathsQuatToEulerDegreeZYX : Scol function to transform quaternion vector in euler angles (degree) (ZYX).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles in degrees if success, NIL otherwise

Definition at line 4200 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerXYZ ( mmachine  m  ) 

SO3MathsQuatToEulerXYZ : Scol function to transform quaternion vector in euler angles (XYZ).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles if success, NIL otherwise

Definition at line 3759 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerXZY ( mmachine  m  ) 

SO3MathsQuatToEulerXZY : Scol function to transform quaternion vector in euler angles (XZY).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles if success, NIL otherwise

Definition at line 3800 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerYXZ ( mmachine  m  ) 

SO3MathsQuatToEulerYXZ : Scol function to transform quaternion vector in euler angles (YXZ).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles if success, NIL otherwise

Definition at line 3840 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerYZX ( mmachine  m  ) 

SO3MathsQuatToEulerYZX : Scol function to transform quaternion vector in euler angles (YZX).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles if success, NIL otherwise

Definition at line 3880 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerZXY ( mmachine  m  ) 

SO3MathsQuatToEulerZXY : Scol function to transform quaternion vector in euler angles (ZXY).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles if success, NIL otherwise

Definition at line 3920 of file SO3SCOL.cpp.

int SO3MathsQuatToEulerZYX ( mmachine  m  ) 

SO3MathsQuatToEulerZYX : Scol function to transform quaternion vector in euler angles (ZYX).

Prototype: fun [[F F F F]] [F F F]

Parameters:
[F F F F] : current quaternion
Returns:
[F F F] : euler angles if success, NIL otherwise

Definition at line 3960 of file SO3SCOL.cpp.

int SO3MathsRadianToDegree ( mmachine  m  ) 

SO3MathsRadianToDegree : function to convert a value from radians to degrees.

Prototype: fun [F] F

Parameters:
F : value in radians
Returns:
F : result in degrees if success, NIL otherwise

Definition at line 4743 of file SO3SCOL.cpp.

int SO3OverlayCreate ( mmachine  m  ) 

SO3OverlayCreate : Create an SO3_OVERLAY.

Prototype: fun [Chn S] SO3_OVERLAY

Parameters:
Chn : current channel
S : given name
Returns:
SO3_OVERLAY : the overlay object if success, NIL otherwise

Definition at line 3414 of file SO3SCOL.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Sat May 15 17:13:22 2010 for SO3Engine by  doxygen 1.6.3