Modules
	Common global variables

Functions
	_DMSevent (d, ev, param, repl)
	Send an event to another plugITs. More...

	getPluginInstanceUserActions (inst)
	Get a plugIT instance user actions. More...

	getPluginInstanceUserEvents (inst)
	Get a plugIT instance user events. More...

	getPluginInstanceParam (inst, param)
	Get a plugIT instance param value. More...

	getPluginInstanceGroupName (inst)
	Get a plugIT instance group name. More...

	getPluginInstanceName (inst)
	Get a plugIT instance name. More...

	setPluginInstanceCbGeneric (inst, cbfun)
	Define a generic plugIT instance callback that can be triggered by calling cbPlugGeneric with an unique id. More...

	setPluginInstanceCbAllPluginsLoaded (inst, cbfun)
	Define a plugIT instance callback that is triggered when all the plugins of the group are loaded. More...

	setPluginInstanceCbDel (inst, cbfun)
	Define the instance callback on delete event. More...

	setPluginInstanceCbPreRender (inst, cbfun)
	Define the instance callback on preRender event. More...

	setPluginInstanceCbPostRender (inst, cbfun)
	Define the instance callback on postRender event. More...

	setPluginInstanceEditorCbPreRender (inst, cbfun)
	Define the editor instance callback on preRender event. More...

	setPluginInstanceEditorCbPostRender (inst, cbfun)
	Define the instance editor callback on postRender event. More...

	setPluginInstanceCbScenePreRender (inst, cbfun)
	Define the instance callback on Scene preRender event, this one is called before the animations and physics updates. More...

	setPluginInstanceCbScenePreRender2 (inst, cbfun)
	Define the instance callback on Scene preRender2 event, this one is called after the animations and physics updates. More...

	setPluginInstanceCbScenePreRenderPhysic (inst, cbfun)
	Define the instance callback on Scene preRenderPhysic event, this one is called after the animations and before physics updates. More...

	setPluginInstanceCbScenePostRender (inst, cbfun)
	Define the instance callback on Scene postRender event. More...

	setPluginInstanceCbClick (inst, cbfun)
	Define the instance callback on mouse click event. More...

	setPluginInstanceCbDbClick (inst, cbfun)
	Define the instance callback on mouse double click event. More...

	setPluginInstanceCbUnClick (inst, cbfun)
	Define the instance callback on mouse unclick event. More...

	setPluginInstanceCbWheel (inst, cbfun)
	Define the instance callback on mouse wheel event. More...

	setPluginInstanceCbCursorMove (inst, cbfun)
	Define the instance callback on mouse move event. More...

	setPluginInstanceCbKeyDown (inst, cbfun)
	Define the instance callback on keyboard key down event. More...

	setPluginInstanceCbKeyUp (inst, cbfun)
	Define the instance callback on keyboard key up event. More...

	setPluginInstanceCbTouchPointAdd (inst, cbfun)
	Define the instance callback on touch point add event. More...

	setPluginInstanceCbTouchPointRemove (inst, cbfun)
	Define the instance callback on touch point remove event. More...

	setPluginInstanceCbTouchPointUpdate (inst, cbfun)
	Define the instance callback on touch point update event. More...

	setPluginInstanceCbCameraChange (inst, cbfun)
	Define the instance callback on default camera change. More...

	setPluginInstanceCbResizeView (inst, cbfun)
	Define the instance callback on 3d view resize event. More...

	setPluginInstanceCbFocusView (inst, cbfun)
	Define the instance callback on 3d view get focus event. More...

	setPluginInstanceCbKillFocusView (inst, cbfun)
	Define the instance callback on 3d view lost focus event. More...

	setPluginInstanceCbDropFile (inst, cbfun)
	Define the instance callback on 3d view Drag&Drop files event. More...

	setPluginInstanceCbNetConnected (inst, cbfun)
	Define the instance callback on network server connection. More...

	setPluginInstanceCbNetClosed (inst, cbfun)
	Define the instance callback on network server connection lost. More...

	setPluginInstanceCbNetSConnected (inst, cbfun)
	Define the instance callback on network server secure connection. More...

	setPluginInstanceCbNetSrvMessage (inst, cbfun)
	Define the instance callback on network incoming server message. More...

	setPluginInstanceCbNetUserMessage (inst, cbfun)
	Define the instance callback on network incoming user message. More...

	setPluginInstanceCbNetUserPrivateMessage (inst, cbfun)
	Define the instance callback on network incoming user private message. More...

	setPluginInstanceCbNetGetFile (inst, cbfun)
	Define the instance callback on network incoming user file. More...

	setPluginInstanceCbNetUserGetItem (inst, cbfun)
	Define the instance callback on network user item value change. More...

	setPluginInstanceCbNetRoomGetItem (inst, cbfun)
	Define the instance callback on network room item value change. More...

	setPluginInstanceCbNetNewUser (inst, cbfun)
	Define the instance callback on network new user connected. More...

	setPluginInstanceCbNetDelUser (inst, cbfun)
	Define the instance callback on network user is disconnected. More...

	setPluginInstanceCbNetUserChangeLogin (inst, cbfun)
	Define the instance callback on network user change his login. More...

	setPluginInstanceCbNetNbUsers (inst, cbfun)
	Define the instance callback on network number of users change. More...

	setPluginInstanceCbNetRoomChanged (inst, cbfun)
	Define the instance callback on network room change. More...

	getInstancePlugin (inst)
	Get the plugIT structure from an instance. More...

	getPluginFile (p)
	Get a plugIT file name. More...

	getPluginDirectory (p)
	Get a plugIT directory. More...

	getPluginClass (p)
	Get a plugIT class. More...

	getPluginParams (p)
	Get a plugIT general parameters. More...

	getPluginType (p)
	Get a plugIT type. More...

	setPluginType (p, x)
	Set a plugIT type. More...

	getPluginTypeName (p)
	Get a plugIT type name. More...

	setPluginTypeName (p, x)
	Set a plugIT type name. More...

	getPluginPath (p)
	Get a plugIT path. More...

	setPluginEditor (edtfun)
	Define a plugIT editor function, this must be called in the plugIT client. More...

	PlugRegister (new, close)
	Define a plugIT new and close callback for instances. More...

	getPluginInstanceEvent (inst, event)
	Get a plugIT instance event name. More...

	SendPluginEvent (inst, event, param, reply)
	Send an event to another plugITs. More...

	PluginRegisterAction (inst, action, f)
	Define the instance callback on an action call. More...

	PluginUnRegisterAction (inst, action)
	Remove the instance callback on an action call. More...

	dlgSelectPluginInstanceResource (inst, winfather, mask, value, cbend, cbclose, defmode)
	Show a dialog window to choose a resource in the editor. More...

Variables
proto	addLogMessage =fun [S] S
	Add a log message in the OS3D log window. More...

proto	addLogMessageMulti =fun [S [S r1]] I
	Add a log message in the OS3D log window from a list. More...

Detailed Description

OpenSpace3D plugIT Api

Function Documentation

◆ _DMSevent()

_DMSevent	(	d	,
		ev	,
		param	,
		repl
	)

Send an event to another plugITs.

Prototype: fun [DMI S S S] I

Parameters

DMI	: use 'this' for this parameter in OpenSpace3D
S	: the event name, generally constructed with (getPluginInstanceEvent inst "Event name")
S	: the event user parameter
S	: the event reply value

Returns: 0

◆ getPluginInstanceUserActions()

getPluginInstanceUserActions ( inst )

Get a plugIT instance user actions.

Prototype: fun [PInstance] [S r1]

Parameters

PInstance : the plugIT instance

Returns: [S r1] : the list of user actions

◆ getPluginInstanceUserEvents()

getPluginInstanceUserEvents ( inst )

Get a plugIT instance user events.

Prototype: fun [PInstance] [S r1]

Parameters

PInstance : the plugIT instance

Returns: [S r1] : the list of user events

◆ getPluginInstanceParam()

getPluginInstanceParam	(	inst	,
		param
	)

Get a plugIT instance param value.

Prototype: fun [PInstance S] S

Parameters

PInstance	: the plugIT instance
S	: param name

Returns: S : the param value

◆ getPluginInstanceGroupName()

getPluginInstanceGroupName ( inst )

Get a plugIT instance group name.

Prototype: fun [PInstance] S

Parameters

PInstance : the plugIT instance

Returns: S : the group name

◆ getPluginInstanceName()

getPluginInstanceName ( inst )

Get a plugIT instance name.

Prototype: fun [PInstance] S

Parameters

PInstance : the plugIT instance

Returns: S : the instance name

◆ setPluginInstanceCbGeneric()

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

Parameters

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

Returns: 0

◆ setPluginInstanceCbAllPluginsLoaded()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance] u0 : the callback function called event
-	PInstance : the plugIT instance

Returns: 0

◆ setPluginInstanceCbDel()

setPluginInstanceCbDel	(	inst	,
		cbfun
	)

Define the instance callback on delete event.

Prototype: fun [PInstance fun [PInstance] u0] fun [PInstance] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance] u0 : the callback function called on del event
-	PInstance : the plugIT instance

Returns: 0

◆ setPluginInstanceCbPreRender()

setPluginInstanceCbPreRender	(	inst	,
		cbfun
	)

Define the instance callback on preRender event.

Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview] u0 : the callback function called on preRender event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure

Returns: fun [PInstance] u0 : the same callback

◆ setPluginInstanceCbPostRender()

setPluginInstanceCbPostRender	(	inst	,
		cbfun
	)

Define the instance callback on postRender event.

Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview] u0 : the callback function called on postRender event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure

Returns: fun [PInstance V3Dview] u0 : the same callback

◆ setPluginInstanceEditorCbPreRender()

setPluginInstanceEditorCbPreRender	(	inst	,
		cbfun
	)

Define the editor instance callback on preRender event.

Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview] u0 : the callback function called on preRender event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure

Returns: fun [PInstance] u0 : the same callback

◆ setPluginInstanceEditorCbPostRender()

setPluginInstanceEditorCbPostRender	(	inst	,
		cbfun
	)

Define the instance editor callback on postRender event.

Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview] u0 : the callback function called on postRender event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure

Returns: fun [PInstance V3Dview] u0 : the same callback

◆ setPluginInstanceCbScenePreRender()

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

Parameters

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

Returns: fun [PInstance V3Dsession I] u0 : the same callback

◆ setPluginInstanceCbScenePreRender2()

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

Parameters

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

Returns: fun [PInstance V3Dsession I] u0 : the same callback

◆ setPluginInstanceCbScenePreRenderPhysic()

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

Parameters

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

Returns: fun [PInstance V3Dsession I] u0 : the same callback

◆ setPluginInstanceCbScenePostRender()

setPluginInstanceCbScenePostRender	(	inst	,
		cbfun
	)

Define the instance callback on Scene postRender event.

Prototype: fun [PInstance fun [PInstance V3Dsession I] u0] fun [PInstance V3Dsession I] u0

Parameters

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

Returns: fun [PInstance V3Dsession I] u0 : the same callback

◆ setPluginInstanceCbClick()

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

Parameters

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

Returns: fun [PInstance V3Dview I I I] u0 : the same callback

◆ setPluginInstanceCbDbClick()

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

Parameters

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

Returns: fun [PInstance V3Dview I I I] u0 : the same callback

◆ setPluginInstanceCbUnClick()

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

Parameters

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

Returns: fun [PInstance V3Dview I I I] u0 : the same callback

◆ setPluginInstanceCbWheel()

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

Parameters

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

Returns: fun [PInstance V3Dview I I I I] u0 : the same callback

◆ setPluginInstanceCbCursorMove()

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

Parameters

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

Returns: fun [PInstance V3Dview I I I] u0 : the same callback

◆ setPluginInstanceCbKeyDown()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview I I] u0 : the callback function called on keyboard key down event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure
-	I : key scancode
-	I : key ascii code

Returns: fun [PInstance V3Dview I I] u0 : the same callback

◆ setPluginInstanceCbKeyUp()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview I] u0 : the callback function called on keyboard key up event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure
-	I : key scancode

Returns: fun [PInstance V3Dview I] u0 : the same callback

◆ setPluginInstanceCbTouchPointAdd()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview I I I] u0 : the callback function called on touch point add 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

Returns: fun [PInstance V3Dview I I I] u0 : the same callback

◆ setPluginInstanceCbTouchPointRemove()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview I] u0 : the callback function called on touch point remove event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure
-	I : the point id

Returns: fun [PInstance V3Dview I] u0 : the same callback

◆ setPluginInstanceCbTouchPointUpdate()

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

Parameters

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

Returns: fun [PInstance V3Dview I I I I I] u0 : the same callback

◆ setPluginInstanceCbCameraChange()

setPluginInstanceCbCameraChange	(	inst	,
		cbfun
	)

Define the instance callback on default camera change.

Prototype: fun [PInstance fun [PInstance V3Dview V3Dsession SO3Object] u0] fun [PInstance V3Dview V3Dsession SO3Object] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview V3Dsession SO3Object] u0 : the callback function called on default camera change
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure
-	V3Dsession : the scene 3d session structure
-	SO3Object : the new default camera

Returns: fun [PInstance V3Dview V3Dsession SO3Object] u0 : the same callback

◆ setPluginInstanceCbResizeView()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview I I] u0 : the callback function called on 3d view resize event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure
-	I : the new width of the 3d view
-	I : the new height of the 3d view

Returns: fun [PInstance V3Dview I I] u0 : the same callback

◆ setPluginInstanceCbFocusView()

setPluginInstanceCbFocusView	(	inst	,
		cbfun
	)

Define the instance callback on 3d view get focus event.

Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview] u0 : the callback function called on 3d view get focus event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure

Returns: fun [PInstance V3Dview] u0 : the same callback

◆ setPluginInstanceCbKillFocusView()

setPluginInstanceCbKillFocusView	(	inst	,
		cbfun
	)

Define the instance callback on 3d view lost focus event.

Prototype: fun [PInstance fun [PInstance V3Dview] u0] fun [PInstance V3Dview] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview] u0 : the callback function called on 3d view lost focus event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure

Returns: fun [PInstance V3Dview] u0 : the same callback

◆ setPluginInstanceCbDropFile()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance V3Dview I I [P r1]] u0 : the callback function called on 3d view Drag&Drop files event
-	PInstance : the plugIT instance
-	V3Dview : the 3d view structure
-	I : Cursor X position
-	I : Cursor Y position
-	[P r1] : list of files

Returns: fun [PInstance V3Dview I I [P r1]] u0 : the same callback

◆ setPluginInstanceCbNetConnected()

setPluginInstanceCbNetConnected	(	inst	,
		cbfun
	)

Define the instance callback on network server connection.

Prototype: fun [PInstance fun [PInstance NetComm] u0] fun [PInstance NetComm] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm] u0 : the callback function called on network server connection
-	PInstance : the plugIT instance
-	NetComm : the network structure

Returns: fun [PInstance NetComm] u0 : the same callback

◆ setPluginInstanceCbNetClosed()

setPluginInstanceCbNetClosed	(	inst	,
		cbfun
	)

Define the instance callback on network server connection lost.

Prototype: fun [PInstance fun [PInstance NetComm] u0] fun [PInstance NetComm] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm] u0 : the callback function called on network server connection lost
-	PInstance : the plugIT instance
-	NetComm : the network structure

Returns: fun [PInstance NetComm] u0 : the same callback

◆ setPluginInstanceCbNetSConnected()

setPluginInstanceCbNetSConnected	(	inst	,
		cbfun
	)

Define the instance callback on network server secure connection.

Prototype: fun [PInstance fun [PInstance NetComm] u0] fun [PInstance NetComm] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm] u0 : the callback function called on network server secure connection
-	PInstance : the plugIT instance
-	NetComm : the network structure

Returns: fun [PInstance NetComm] u0 : the same callback

◆ setPluginInstanceCbNetSrvMessage()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm S S S] u0 : the callback function called on network incoming server message
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	S : command
-	S : message
-	S : parameters

Returns: fun [PInstance NetComm S S S] u0 : the same callback

◆ setPluginInstanceCbNetUserMessage()

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

Parameters

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

Returns: fun [PInstance NetComm NetUser S S S] u0 : the same callback

◆ setPluginInstanceCbNetUserPrivateMessage()

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

Parameters

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

Returns: fun [PInstance NetComm NetUser S S S] u0 : the same callback

◆ setPluginInstanceCbNetGetFile()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm NetUser S S S] u0 : the callback function called on network incoming user file
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	NetUser : the user structure who sent the file
-	S : command
-	S : file data
-	S : file name

Returns: fun [PInstance NetComm NetUser S S S] u0 : the same callback

◆ setPluginInstanceCbNetUserGetItem()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm NetUser S S] u0 : the callback function called on network user item value change
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	NetUser : the user structure
-	S : item name
-	S : item value

Returns: fun [PInstance NetComm NetUser S S] u0 : the same callback

◆ setPluginInstanceCbNetRoomGetItem()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm S S] u0 : the callback function called on network room item value change
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	S : item name
-	S : item value

Returns: fun [PInstance NetComm S S] u0 : the same callback

◆ setPluginInstanceCbNetNewUser()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm NetUser] u0 : the callback function called on network new user connected
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	NetUser : the new user structure

Returns: fun [PInstance NetComm NetUser] u0 : the same callback

◆ setPluginInstanceCbNetDelUser()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm NetUser] u0 : the callback function called on network user is disconnected
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	NetUser : the disconnected user structure

Returns: fun [PInstance NetComm NetUser] u0 : the same callback

◆ setPluginInstanceCbNetUserChangeLogin()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm NetUser S] u0 : the callback function called on network user change his login
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	NetUser : the user structure
-	S : the new user login

Returns: fun [PInstance NetComm NetUser S] u0 : the same callback

◆ setPluginInstanceCbNetNbUsers()

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

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm I] u0 : the callback function called on network number of users change
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	I : the new number of users

Returns: fun [PInstance NetComm I] u0 : the same callback

◆ setPluginInstanceCbNetRoomChanged()

setPluginInstanceCbNetRoomChanged	(	inst	,
		cbfun
	)

Define the instance callback on network room change.

Prototype: fun [PInstance fun [PInstance NetComm S] u0] fun [PInstance NetComm S] u0

Parameters

PInstance	: the plugIT instance
fun	[PInstance NetComm S] u0 : the callback function called on network room change
-	PInstance : the plugIT instance
-	NetComm : the network structure
-	S : the new room value

Returns: fun [PInstance NetComm S] u0 : the same callback

◆ getInstancePlugin()

getInstancePlugin ( inst )

Get the plugIT structure from an instance.

Prototype: fun [PInstance] Plug

Parameters

PInstance : the plugIT instance

Returns: Plug : the instance plugIT structure

◆ getPluginFile()

getPluginFile ( p )

Get a plugIT file name.

Prototype: fun [Plug] S

Parameters

Plug	: the plugIT structure

Returns: S : the file name

◆ getPluginDirectory()

getPluginDirectory ( p )

Get a plugIT directory.

Prototype: fun [Plug] S

Parameters

Plug	: the plugIT structure

Returns: S : the directory

◆ getPluginClass()

getPluginClass ( p )

Get a plugIT class.

Prototype: fun [Plug] S

Parameters

Plug	: the plugIT structure

Returns: S : the class

◆ getPluginParams()

getPluginParams ( p )

Get a plugIT general parameters.

Prototype: fun [Plug] [[S I] r1]

Parameters

Plug	: the plugIT structure

Returns: [[S I] r1] : the plugIT general parameters

◆ getPluginType()

getPluginType ( p )

Get a plugIT type.

Prototype: fun [Plug] I

Parameters

Plug	: the plugIT structure

Returns: I : the plugIT type

◆ setPluginType()

setPluginType	(	p	,
		x
	)

Set a plugIT type.

Prototype: fun [Plug I] I

Parameters

Plug	: the plugIT structure
I	: the new plugIT type

Returns: I : the new type

◆ getPluginTypeName()

getPluginTypeName ( p )

Get a plugIT type name.

Prototype: fun [Plug] S

Parameters

Plug	: the plugIT structure

Returns: S : the plugIT type name

◆ setPluginTypeName()

setPluginTypeName	(	p	,
		x
	)

Set a plugIT type name.

Prototype: fun [Plug S] S

Parameters

Plug	: the plugIT structure
S	: the new plugIT type name

Returns: S : the new type name

◆ getPluginPath()

getPluginPath ( p )

Get a plugIT path.

Prototype: fun [Plug] S

Parameters

Plug	: the plugIT structure

Returns: S : the plugIT path

◆ setPluginEditor()

setPluginEditor ( edtfun )

Define a plugIT editor function, this must be called in the plugIT client.

Prototype: fun [fun [EdWindow PInstance V3Dview] [fun [] [[S S] r1] fun [] I]] I

Parameters

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

Returns: 0

◆ PlugRegister()

PlugRegister	(	new	,
		close
	)

Define a plugIT new and close callback for instances.

Prototype: fun [fun [PInstance] I fun [PInstance] I]] I

Parameters

fun	[PInstance] I : the callback function on new instance
fun	[PInstance] I : the callback function on close instance

Returns: 0

◆ getPluginInstanceEvent()

getPluginInstanceEvent	(	inst	,
		event
	)

Get a plugIT instance event name.

Prototype: fun [PInstance S] S

Parameters

PInstance	: the plugIT instance
S	: the event name

Returns: S : the complete instance event name

◆ SendPluginEvent()

SendPluginEvent	(	inst	,
		event	,
		param	,
		reply
	)

Send an event to another plugITs.

Prototype: fun [PInstance S S S] I

Parameters

PInstance	: the plugIT instance
S	: event name
S	: event param
S	: event reply param

Returns: 0

◆ PluginRegisterAction()

PluginRegisterAction	(	inst	,
		action	,
		f
	)

Define the instance callback on an action call.

Prototype: fun [PInstance S fun [PInstance DMI S S S] u0] I

Parameters

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

Returns: 0

◆ PluginUnRegisterAction()

PluginUnRegisterAction	(	inst	,
		action
	)

Remove the instance callback on an action call.

Prototype: fun [PInstance S] I

Parameters

PInstance	: the plugIT instance
S	: the action name

Returns: 0

◆ dlgSelectPluginInstanceResource()

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

Parameters

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

Returns: 0

Variable Documentation

◆ addLogMessage

proto addLogMessage =fun [S] S

Add a log message in the OS3D log window.

Prototype: fun [S] S

Parameters

S	: the message to print in the log window

Returns: S : the same message

◆ addLogMessageMulti

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

Parameters

S	: the message prefix
[S	r1] : a list of messages to print in the log window

Returns: 0

Project

General

Profile

OpenSpace3D

Modules

Functions

Variables

Detailed Description

Function Documentation

◆ _DMSevent()

◆ getPluginInstanceUserActions()

◆ getPluginInstanceUserEvents()

◆ getPluginInstanceParam()

◆ getPluginInstanceGroupName()

◆ getPluginInstanceName()

◆ setPluginInstanceCbGeneric()

◆ setPluginInstanceCbAllPluginsLoaded()

◆ setPluginInstanceCbDel()

◆ setPluginInstanceCbPreRender()

◆ setPluginInstanceCbPostRender()

◆ setPluginInstanceEditorCbPreRender()

◆ setPluginInstanceEditorCbPostRender()

◆ setPluginInstanceCbScenePreRender()

◆ setPluginInstanceCbScenePreRender2()

◆ setPluginInstanceCbScenePreRenderPhysic()

◆ setPluginInstanceCbScenePostRender()

◆ setPluginInstanceCbClick()

◆ setPluginInstanceCbDbClick()

◆ setPluginInstanceCbUnClick()

◆ setPluginInstanceCbWheel()

◆ setPluginInstanceCbCursorMove()

◆ setPluginInstanceCbKeyDown()

◆ setPluginInstanceCbKeyUp()

◆ setPluginInstanceCbTouchPointAdd()

◆ setPluginInstanceCbTouchPointRemove()

◆ setPluginInstanceCbTouchPointUpdate()

◆ setPluginInstanceCbCameraChange()

◆ setPluginInstanceCbResizeView()

◆ setPluginInstanceCbFocusView()

◆ setPluginInstanceCbKillFocusView()

◆ setPluginInstanceCbDropFile()

◆ setPluginInstanceCbNetConnected()

◆ setPluginInstanceCbNetClosed()

◆ setPluginInstanceCbNetSConnected()

◆ setPluginInstanceCbNetSrvMessage()

◆ setPluginInstanceCbNetUserMessage()

◆ setPluginInstanceCbNetUserPrivateMessage()

◆ setPluginInstanceCbNetGetFile()

◆ setPluginInstanceCbNetUserGetItem()

◆ setPluginInstanceCbNetRoomGetItem()

◆ setPluginInstanceCbNetNewUser()

◆ setPluginInstanceCbNetDelUser()

◆ setPluginInstanceCbNetUserChangeLogin()

◆ setPluginInstanceCbNetNbUsers()

◆ setPluginInstanceCbNetRoomChanged()

◆ getInstancePlugin()

◆ getPluginFile()

◆ getPluginDirectory()

◆ getPluginClass()

◆ getPluginParams()

◆ getPluginType()

◆ setPluginType()

◆ getPluginTypeName()

◆ setPluginTypeName()

◆ getPluginPath()

◆ setPluginEditor()

◆ PlugRegister()

◆ getPluginInstanceEvent()

◆ SendPluginEvent()

◆ PluginRegisterAction()

◆ PluginUnRegisterAction()

◆ dlgSelectPluginInstanceResource()

Variable Documentation

◆ addLogMessage

◆ addLogMessageMulti