|
OpenSpace3D libs
OpenSpace 3D libraries for plugITs and OS3D developer
|
Modules | |
| Common global variables | |
Functions | |
| getPluginInstanceUserActions (inst) | |
| Get a plugIT instance user actions. | |
| getPluginInstanceUserEvents (inst) | |
| Get a plugIT instance user events. | |
| getPluginInstanceParam (inst, param) | |
| Get a plugIT instance param value. | |
| getPluginInstanceGroupName (inst) | |
| Get a plugIT instance group name. | |
| getPluginInstanceName (inst) | |
| Get a plugIT instance name. | |
| getPluginInstanceFullname (inst) | |
| Get a plugIT instance full name. | |
| setPluginInstanceShowHelper (inst, state) | |
| Set a plugIT instance helper state. | |
| getPluginInstanceShowHelper (inst) | |
| Get a plugIT instance helper state. | |
| setPluginInstanceShowInGroup (inst, state) | |
| Set a plugIT instance show in group state. | |
| getPluginInstanceShowInGroup (inst) | |
| Get a plugIT instance show in group state. | |
| setPluginInstanceCbGeneric (inst, cbfun) | |
| Define a generic plugIT instance callback that can be triggered by calling cbPlugGeneric with an unique id. | |
| setPluginInstanceCbAllPluginsLoaded (inst, cbfun) | |
| Define a plugIT instance callback that is triggered when all the plugins of the group are loaded. | |
| setPluginInstanceCbDel (inst, cbfun) | |
| Define the instance callback on delete event. | |
| setPluginInstanceCbPreRender (inst, cbfun) | |
| Define the instance callback on preRender event. | |
| setPluginInstanceCbPreRender2 (inst, cbfun) | |
| Define the instance callback on preRender2 event. | |
| setPluginInstanceCbPostRender (inst, cbfun) | |
| Define the instance callback on postRender event. | |
| setPluginInstanceEditorCbPreRender (inst, cbfun) | |
| Define the editor instance callback on preRender event. | |
| setPluginInstanceEditorCbPostRender (inst, cbfun) | |
| Define the instance editor callback on postRender event. | |
| setPluginInstanceEditorCbHelperState (inst, cbfun) | |
| Define the instance editor callback on helper state change. | |
| setPluginInstanceCbScenePreRender (inst, cbfun) | |
| Define the instance callback on Scene preRender event, this one is called before the animations and physics updates. | |
| setPluginInstanceCbScenePreRender2 (inst, cbfun) | |
| Define the instance callback on Scene preRender2 event, this one is called after the animations and physics updates. | |
| setPluginInstanceCbScenePreRenderPhysic (inst, cbfun) | |
| Define the instance callback on Scene preRenderPhysic event, this one is called after the animations and before physics updates. | |
| setPluginInstanceCbScenePostRender (inst, cbfun) | |
| Define the instance callback on Scene postRender event. | |
| setPluginInstanceCbNavigateControlState (inst, cbfun) | |
| Define the instance callback on navigate control enable event. | |
| setPluginInstanceCbClick (inst, cbfun) | |
| Define the instance callback on mouse click event. | |
| setPluginInstanceCbDbClick (inst, cbfun) | |
| Define the instance callback on mouse double click event. | |
| setPluginInstanceCbUnClick (inst, cbfun) | |
| Define the instance callback on mouse unclick event. | |
| setPluginInstanceCbWheel (inst, cbfun) | |
| Define the instance callback on mouse wheel event. | |
| setPluginInstanceCbCursorMove (inst, cbfun) | |
| Define the instance callback on mouse move event. | |
| setPluginInstanceCbInputClick (inst, cbfun) | |
| Define the instance callback on input click event. | |
| setPluginInstanceCbInputUnClick (inst, cbfun) | |
| Define the instance callback on input unclick event. | |
| setPluginInstanceCbInputUpdate (inst, cbfun) | |
| Define the instance callback on input update event. | |
| setPluginInstanceCbKeyDown (inst, cbfun) | |
| Define the instance callback on keyboard key down event. | |
| setPluginInstanceCbKeyUp (inst, cbfun) | |
| Define the instance callback on keyboard key up event. | |
| setPluginInstanceCbTouchPointAdd (inst, cbfun) | |
| Define the instance callback on touch point add event. | |
| setPluginInstanceCbTouchPointRemove (inst, cbfun) | |
| Define the instance callback on touch point remove event. | |
| setPluginInstanceCbTouchPointUpdate (inst, cbfun) | |
| Define the instance callback on touch point update event. | |
| setPluginInstanceCbCameraChange (inst, cbfun) | |
| Define the instance callback on default camera change. | |
| setPluginInstanceCbResizeView (inst, cbfun) | |
| Define the instance callback on 3d view resize event. | |
| setPluginInstanceCbFocusView (inst, cbfun) | |
| Define the instance callback on 3d view get focus event. | |
| setPluginInstanceCbKillFocusView (inst, cbfun) | |
| Define the instance callback on 3d view lost focus event. | |
| setPluginInstanceCbDropFile (inst, cbfun) | |
| Define the instance callback on 3d view Drag&Drop files event. | |
| setPluginInstanceCbVrModeChanged (inst, cbfun) | |
| Define the instance callback on 3d view VR mode event. | |
| setPluginInstanceCbCameraTeleport (inst, cbfun) | |
| Define the instance callback on main camera position change. | |
| setPluginInstanceCbNetConnected (inst, cbfun) | |
| Define the instance callback on network server connection. | |
| setPluginInstanceCbNetClosed (inst, cbfun) | |
| Define the instance callback on network server connection lost. | |
| setPluginInstanceCbNetSConnected (inst, cbfun) | |
| Define the instance callback on network server secure connection. | |
| setPluginInstanceCbNetSrvMessage (inst, cbfun) | |
| Define the instance callback on network incoming server message. | |
| setPluginInstanceCbNetUserMessage (inst, cbfun) | |
| Define the instance callback on network incoming user message. | |
| setPluginInstanceCbNetUserPrivateMessage (inst, cbfun) | |
| Define the instance callback on network incoming user private message. | |
| setPluginInstanceCbNetGetFile (inst, cbfun) | |
| Define the instance callback on network incoming user file. | |
| setPluginInstanceCbNetUserGetItem (inst, cbfun) | |
| Define the instance callback on network user item value change. | |
| setPluginInstanceCbNetRoomGetItem (inst, cbfun) | |
| Define the instance callback on network room item value change. | |
| setPluginInstanceCbNetNewUser (inst, cbfun) | |
| Define the instance callback on network new user connected. | |
| setPluginInstanceCbNetDelUser (inst, cbfun) | |
| Define the instance callback on network user is disconnected. | |
| setPluginInstanceCbNetUserChangeLogin (inst, cbfun) | |
| Define the instance callback on network user change his login. | |
| setPluginInstanceCbNetNbUsers (inst, cbfun) | |
| Define the instance callback on network number of users change. | |
| setPluginInstanceCbNetRoomChanged (inst, cbfun) | |
| Define the instance callback on network room change. | |
| getInstancePlugin (inst) | |
| Get the plugIT structure from an instance. | |
| getPluginFile (p) | |
| Get a plugIT file name. | |
| getPluginDirectory (p) | |
| Get a plugIT directory. | |
| getPluginClass (p) | |
| Get a plugIT class. | |
| getPluginUseHelper (p) | |
| Get if a plugIT editor use helper. | |
| getPluginParams (p) | |
| Get a plugIT general parameters. | |
| getPluginType (p) | |
| Get a plugIT type. | |
| setPluginType (p, x) | |
| Set a plugIT type. | |
| getPluginTypeName (p) | |
| Get a plugIT type name. | |
| setPluginTypeName (p, x) | |
| Set a plugIT type name. | |
| getPluginPath (p) | |
| Get a plugIT path. | |
| setPluginEditor (edtfun) | |
| Define a plugIT editor function, this must be called in the plugIT client or editor. | |
| setPluginEditorInstanceCb (initfun, dsfun, startfun, stopfun) | |
| Define plugIT editor functions for init and destroy instance, this must be called in the plugIT client. | |
| PlugRegister (new, close) | |
| Define a plugIT new and close callback for instances. | |
| getPluginInstanceEvent (inst, event) | |
| Get a plugIT instance event name. | |
| SendPluginEvent (inst, event, param, reply) | |
| Send an event to another plugITs. | |
| PluginRegisterAction (inst, action, f) | |
| Define the instance callback on an action call. | |
| PluginUnRegisterAction (inst, action) | |
| Remove the instance callback on an action call. | |
| dlgSelectPluginInstanceResource (inst, winfather, mask, value, cbend, cbclose, defmode) | |
| Show a dialog window to choose a resource in the editor. | |
Variables | |
| proto | addLogMessage =fun [S] S |
| Add a log message in the OS3D log window. | |
| proto | addLogMessageMulti =fun [S [S r1]] I |
| Add a log message in the OS3D log window from a list. | |
OpenSpace3D plugIT Api
| getPluginInstanceUserActions | ( | inst | ) |
| getPluginInstanceUserEvents | ( | inst | ) |
| getPluginInstanceParam | ( | inst | , |
| param | |||
| ) |
| getPluginInstanceGroupName | ( | inst | ) |
| getPluginInstanceName | ( | inst | ) |
| getPluginInstanceFullname | ( | inst | ) |
| setPluginInstanceShowHelper | ( | inst | , |
| state | |||
| ) |
| getPluginInstanceShowHelper | ( | inst | ) |
| setPluginInstanceShowInGroup | ( | inst | , |
| state | |||
| ) |
| getPluginInstanceShowInGroup | ( | inst | ) |
| setPluginInstanceCbGeneric | ( | inst | , |
| cbfun | |||
| ) |
Define a generic plugIT instance callback that can be triggered by calling cbPlugGeneric with an unique id.
Prototype: fun [PInstance fun [PInstance I S S] u0] fun [PInstance I S S] u0
| PInstance | : the plugIT instance |
| fun | [PInstance I S S] u0 : the callback function called event |
| - | PInstance : the plugIT instance |
| - | I : an unique event id |
| - | S : the event value |
| - | S : the event param |
| setPluginInstanceCbAllPluginsLoaded | ( | inst | , |
| cbfun | |||
| ) |
Define a plugIT instance callback that is triggered when all the plugins of the group are loaded.
Prototype: fun [PInstance fun [PInstance] u0] fun [PInstance] u0
| PInstance | : the plugIT instance |
| fun | [PInstance] u0 : the callback function called event |
| - | PInstance : the plugIT instance |
| setPluginInstanceCbDel | ( | inst | , |
| cbfun | |||
| ) |
| setPluginInstanceCbPreRender | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on preRender event.
Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview] u0 : the callback function called on preRender event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| setPluginInstanceCbPreRender2 | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on preRender2 event.
Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview] u0 : the callback function called on preRender event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| setPluginInstanceCbPostRender | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on postRender event.
Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0
| setPluginInstanceEditorCbPreRender | ( | inst | , |
| cbfun | |||
| ) |
Define the editor instance callback on preRender event.
Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview] u0 : the callback function called on preRender event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| setPluginInstanceEditorCbPostRender | ( | inst | , |
| cbfun | |||
| ) |
Define the instance editor callback on postRender event.
Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0
| setPluginInstanceEditorCbHelperState | ( | inst | , |
| cbfun | |||
| ) |
Define the instance editor callback on helper state change.
Prototype: fun [PInstance fun [PInstance I] u0] fun [PInstance I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance I] u0 : the callback function called on helper state change |
| - | PInstance : the plugIT instance |
| - | I : the new helper state |
| setPluginInstanceCbScenePreRender | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on Scene preRender event, this one is called before the animations and physics updates.
Prototype: fun [PInstance fun [PInstance V3Dsession I] u0] fun [PInstance V3Dsession I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dsession I] u0 : the callback function called on Scene preRender event |
| - | PInstance : the plugIT instance |
| - | V3Dsession : the scene 3d session structure |
| - | I : the time passed since last frame in milli second |
| setPluginInstanceCbScenePreRender2 | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on Scene preRender2 event, this one is called after the animations and physics updates.
Prototype: fun [PInstance fun [PInstance V3Dsession I] u0] fun [PInstance V3Dsession I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dsession I] u0 : the callback function called on Scene preRender2 event |
| - | PInstance : the plugIT instance |
| - | V3Dsession : the scene 3d session structure |
| - | I : the time passed since last frame in milli second |
| setPluginInstanceCbScenePreRenderPhysic | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on Scene preRenderPhysic event, this one is called after the animations and before physics updates.
Prototype: fun [PInstance fun [PInstance V3Dsession I] u0] fun [PInstance V3Dsession I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dsession I] u0 : the callback function called on Scene preRender2 event |
| - | PInstance : the plugIT instance |
| - | V3Dsession : the scene 3d session structure |
| - | I : the time passed since last frame in milli second |
| setPluginInstanceCbScenePostRender | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on Scene postRender event.
Prototype: fun [PInstance fun [PInstance V3Dsession I] u0] fun [PInstance V3Dsession I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dsession I] u0 : the callback function called on Scene postRender event |
| - | PInstance : the plugIT instance |
| - | V3Dsession : the scene 3d session structure |
| - | I : the time passed since last frame in milli second |
| setPluginInstanceCbNavigateControlState | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on navigate control enable event.
Prototype: fun [PInstance fun [PInstance V3Dsession I] u0] fun [PInstance V3Dsession I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dsession I] u0 : the callback function called on navigate control enable event |
| - | PInstance : the plugIT instance |
| - | V3Dsession : the scene 3d session structure |
| - | I : the time passed since last frame in milli second |
| setPluginInstanceCbClick | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on mouse click event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I] u0] fun [PInstance V3Dview I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I] u0 : the callback function called on mouse click event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| setPluginInstanceCbDbClick | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on mouse double click event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I] u0] fun [PInstance V3Dview I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I] u0 : the callback function called on mouse double click event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| setPluginInstanceCbUnClick | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on mouse unclick event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I] u0] fun [PInstance V3Dview I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I] u0 : the callback function called on mouse unclick event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| setPluginInstanceCbWheel | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on mouse wheel event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I I] u0] fun [PInstance V3Dview I I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I I] u0 : the callback function called on mouse wheel event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : wheel delta |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| setPluginInstanceCbCursorMove | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on mouse move event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I] u0] fun [PInstance V3Dview I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I] u0 : the callback function called on mouse move event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| setPluginInstanceCbInputClick | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on input click event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I I [SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F]] u0] fun [PInstance V3Dview I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I] u0 : the callback function called on input click event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| - | [SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F] : 3d mouse infos |
| setPluginInstanceCbInputUnClick | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on input unclick event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I I [SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F]] u0] fun [PInstance V3Dview I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I] u0 : the callback function called on input unclick event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| - | [SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F] : 3d mouse infos |
| setPluginInstanceCbInputUpdate | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on input update event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I I [SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F]] u0] fun [PInstance V3Dview I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I] u0 : the callback function called on input update event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : click position on X |
| - | I : click position on Y |
| - | I : mouse button, 1 for left, 2 for right, 16 for middle button |
| - | [SO3_OBJECT SO3_MATERIAL I [F F F] [F F] F] : 3d mouse infos |
| setPluginInstanceCbKeyDown | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on keyboard key down event.
Prototype: fun [PInstance fun [PInstance V3Dview I I] u0] fun [PInstance V3Dview I I] u0
| setPluginInstanceCbKeyUp | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on keyboard key up event.
Prototype: fun [PInstance fun [PInstance V3Dview I] u0] fun [PInstance V3Dview I] u0
| setPluginInstanceCbTouchPointAdd | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on touch point add event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I] u0] fun [PInstance V3Dview I I I] u0
| setPluginInstanceCbTouchPointRemove | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on touch point remove event.
Prototype: fun [PInstance fun [PInstance V3Dview I] u0] fun [PInstance V3Dview I] u0
| setPluginInstanceCbTouchPointUpdate | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on touch point update event.
Prototype: fun [PInstance fun [PInstance V3Dview I I I I I] u0] fun [PInstance V3Dview I I I I I] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview I I I I I] u0 : the callback function called on touch point update event |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | I : the point id |
| - | I : the point position in window on X |
| - | I : the point position in window on Y |
| - | I : relative move on X |
| - | I :relative move on X |
| setPluginInstanceCbCameraChange | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on default camera change.
Prototype: fun [PInstance fun [PInstance V3Dview V3Dsession SO3_OBJECT] u0] fun [PInstance V3Dview V3Dsession SO3_OBJECT] u0
| PInstance | : the plugIT instance |
| fun | [PInstance V3Dview V3Dsession SO3_OBJECT] u0 : the callback function called on default camera change |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | V3Dsession : the scene 3d session structure |
| - | SO3_OBJECT : the new default camera |
| setPluginInstanceCbResizeView | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on 3d view resize event.
Prototype: fun [PInstance fun [PInstance V3Dview I I] u0] fun [PInstance V3Dview I I] u0
| setPluginInstanceCbFocusView | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on 3d view get focus event.
Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0
| setPluginInstanceCbKillFocusView | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on 3d view lost focus event.
Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0
| setPluginInstanceCbDropFile | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on 3d view Drag&Drop files event.
Prototype: fun [PInstance fun [PInstance V3Dview I I [P r1]] u0] fun [PInstance V3Dview I I [P r1]] u0
| setPluginInstanceCbVrModeChanged | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on 3d view VR mode event.
Prototype: fun [PInstance fun [PInstance V3Dview I] u0] fun [PInstance V3Dview I] u0
| setPluginInstanceCbCameraTeleport | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on main camera position change.
Prototype: fun [PInstance fun [PInstance V3Dview SO3_OBJECT] u0] fun [PInstance V3Dview SO3_OBJECT] u0
| setPluginInstanceCbNetConnected | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network server connection.
Prototype: fun [PInstance fun [PInstance NetComm] u0] fun [PInstance NetComm] u0
| setPluginInstanceCbNetClosed | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network server connection lost.
Prototype: fun [PInstance fun [PInstance NetComm] u0] fun [PInstance NetComm] u0
| setPluginInstanceCbNetSConnected | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network server secure connection.
Prototype: fun [PInstance fun [PInstance NetComm] u0] fun [PInstance NetComm] u0
| setPluginInstanceCbNetSrvMessage | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network incoming server message.
Prototype: fun [PInstance fun [PInstance NetComm S S S] u0] fun [PInstance NetComm S S S] u0
| setPluginInstanceCbNetUserMessage | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network incoming user message.
Prototype: fun [PInstance fun [PInstance NetComm NetUser S S S] u0] fun [PInstance NetComm NetUser S S S] u0
| PInstance | : the plugIT instance |
| fun | [PInstance NetComm NetUser S S S] u0 : the callback function called on network incoming user message |
| - | PInstance : the plugIT instance |
| - | NetComm : the network structure |
| - | NetUser : the user structure who sent the message |
| - | S : command |
| - | S : message |
| - | S : parameters |
| setPluginInstanceCbNetUserPrivateMessage | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network incoming user private message.
Prototype: fun [PInstance fun [PInstance NetComm NetUser S S S] u0] fun [PInstance NetComm NetUser S S S] u0
| PInstance | : the plugIT instance |
| fun | [PInstance NetComm NetUser S S S] u0 : the callback function called on network incoming user private message |
| - | PInstance : the plugIT instance |
| - | NetComm : the network structure |
| - | NetUser : the user structure who sent the message |
| - | S : command |
| - | S : message |
| - | S : parameters |
| setPluginInstanceCbNetGetFile | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network incoming user file.
Prototype: fun [PInstance fun [PInstance NetComm NetUser S S S] u0] fun [PInstance NetComm NetUser S S S] u0
| setPluginInstanceCbNetUserGetItem | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network user item value change.
Prototype: fun [PInstance fun [PInstance NetComm NetUser S S] u0] fun [PInstance NetComm NetUser S S] u0
| setPluginInstanceCbNetRoomGetItem | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network room item value change.
Prototype: fun [PInstance fun [PInstance NetComm S S] u0] fun [PInstance NetComm S S] u0
| setPluginInstanceCbNetNewUser | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network new user connected.
Prototype: fun [PInstance fun [PInstance NetComm NetUser] u0] fun [PInstance NetComm NetUser] u0
| setPluginInstanceCbNetDelUser | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network user is disconnected.
Prototype: fun [PInstance fun [PInstance NetComm NetUser] u0] fun [PInstance NetComm NetUser] u0
| setPluginInstanceCbNetUserChangeLogin | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network user change his login.
Prototype: fun [PInstance fun [PInstance NetComm NetUser S] u0] fun [PInstance NetComm NetUser S] u0
| setPluginInstanceCbNetNbUsers | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network number of users change.
Prototype: fun [PInstance fun [PInstance NetComm I] u0] fun [PInstance NetComm I] u0
| setPluginInstanceCbNetRoomChanged | ( | inst | , |
| cbfun | |||
| ) |
Define the instance callback on network room change.
Prototype: fun [PInstance fun [PInstance NetComm S] u0] fun [PInstance NetComm S] u0
| getInstancePlugin | ( | inst | ) |
| getPluginFile | ( | p | ) |
| getPluginDirectory | ( | p | ) |
| getPluginClass | ( | p | ) |
| getPluginUseHelper | ( | p | ) |
| getPluginParams | ( | p | ) |
| getPluginType | ( | p | ) |
| setPluginType | ( | p | , |
| x | |||
| ) |
| getPluginTypeName | ( | p | ) |
| setPluginTypeName | ( | p | , |
| x | |||
| ) |
| getPluginPath | ( | p | ) |
| setPluginEditor | ( | edtfun | ) |
Define a plugIT editor function, this must be called in the plugIT client or editor.
Prototype: fun [fun [EdWindow PInstance V3Dview EdControl] [fun [] [[S S] r1] fun [] I]] I
| PInstance | : the plugIT instance |
| fun | [EdWindow PInstance V3Dview] [fun [] [[S S] r1] fun [] I] : the callback function of the editor |
| - | EdWindow : the editor window |
| - | PInstance : the plugIT instance |
| - | V3Dview : the 3d view structure |
| - | return [fun [] [[S S] r1] fun [] I] : the editor close callback and the editor destroy callback |
| setPluginEditorInstanceCb | ( | initfun | , |
| dsfun | , | ||
| startfun | , | ||
| stopfun | |||
| ) |
Define plugIT editor functions for init and destroy instance, this must be called in the plugIT client.
Prototype: fun [fun [PInstance] I fun [PInstance] I fun [PInstance] I fun [PInstance] I] I
| PInstance | : the plugIT instance |
| fun | [PInstance] I : the init callback function of the editor |
| fun | [PInstance] I : the destroy callback function of the editor |
| fun | [PInstance] I : the start callback function of the editor / play mode |
| fun | [PInstance] I : the stop callback function of the editor / stop mode |
| - | PInstance : the plugIT instance |
| - | return I : 0 |
| PlugRegister | ( | new | , |
| close | |||
| ) |
| getPluginInstanceEvent | ( | inst | , |
| event | |||
| ) |
| SendPluginEvent | ( | inst | , |
| event | , | ||
| param | , | ||
| reply | |||
| ) |
| PluginRegisterAction | ( | inst | , |
| action | , | ||
| f | |||
| ) |
Define the instance callback on an action call.
Prototype: fun [PInstance S fun [PInstance DMI S S S] u0] I
| PInstance | : the plugIT instance |
| S | : the action name |
| fun | [PInstance DMI S S S] u0 : the callback function |
| - | PInstance : the plugIT instance |
| - | DMI : the sender module (ignore this for OS3D) |
| - | S : action name |
| - | S : param |
| - | S : reply param |
| PluginUnRegisterAction | ( | inst | , |
| action | |||
| ) |
| dlgSelectPluginInstanceResource | ( | inst | , |
| winfather | , | ||
| mask | , | ||
| value | , | ||
| cbend | , | ||
| cbclose | , | ||
| defmode | |||
| ) |
Show a dialog window to choose a resource in the editor.
Prototype: fun [PInstance EdWindow I S fun [S I] I fun [] I I] I
| PInstance | : the plugIT instance |
| EdWindow | : the parent window |
| I | : the resources types iTypeEntity|iTypeNode|iTypeLight|iTypeBone|iTypeCamera|iTypeParticle|iTypeCubeMap|iTypeAnim |
| fun | [S I] I : the callback function on selection |
| - | S : selected value |
| - | I : selected type |
| fun | [] I : the callback function on close |
| I | : 1 for a filtered list, 0 for the resource tree |
| proto addLogMessage =fun [S] S |
Add a log message in the OS3D log window.
Prototype: fun [S] S
| S | : the message to print in the log window |
| proto addLogMessageMulti =fun [S [S r1]] I |
Add a log message in the OS3D log window from a list.
Prototype: fun [S [S r1]] I
| S | : the message prefix |
| [S | r1] : a list of messages to print in the log window |