Scol functions definition

Functions
int	_CRvrpnDevice (mmachine m)
	_CRvrpnDevice : This function create a VRPN object
int	_DSvrpnDevice (mmachine m)
	_DSvrpnDevice : Destroy VRPN object
int	_CBvrpnAnalogData (mmachine m)
	_CBvrpnAnalogData : This function sets the callback called when a VRPN Analog data is received
int	_CBvrpnButtonData (mmachine m)
	_CBvrpnButtonData : This function sets the callback called when a VRPN Button data is received
int	_CBvrpnButtonState (mmachine m)
	_CBvrpnButtonState : This function sets the callback called when a VRPN Button data is received
int	_CBvrpnTrackerData (mmachine m)
	_CBvrpnTrackerData : This function sets the callback called when a VRPN traker position data is received
int	_CBvrpnTrackerVelocityData (mmachine m)
	_CBvrpnTrackerVelocityData : This function sets the callback called when a VRPN traker velocity data is received
int	_CBvrpnTrackerAccelData (mmachine m)
	_CBvrpnTrackerAccelData : This function sets the callback called when a VRPN traker acceleration data is received
int	_CBvrpnTextData (mmachine m)
	_CBvrpnTextData : This function sets the callback called when a VRPN text data is received

Detailed Description

Scol functions definition

Function Documentation

_CBvrpnAnalogData()

int _CBvrpnAnalogData

(

mmachine

m

)

_CBvrpnAnalogData : This function sets the callback called when a VRPN Analog data is received

Prototype: fun [ObjVRPN fun [ObjVRPN u0 [F r1]] u1 u0] ObjVRPN

Parameters

ObjVRPN	: VRPN object to apply the callback
fun	[ObjVRPN u0 [F r1]] u1 : The callback to call when the event occurs. [F r1] : the list of the analogic data
u0	: User parameter

Returns

ObjVRPN : The same object

Definition at line 209 of file scolplugin.cpp.

_CBvrpnButtonData()

int _CBvrpnButtonData

(

mmachine

m

)

_CBvrpnButtonData : This function sets the callback called when a VRPN Button data is received

Prototype: fun [ObjVRPN fun [ObjVRPN u0 [I r1]] u1 u0] ObjVRPN

Parameters

ObjVRPN	: VRPN object to apply the callback
fun	[ObjVRPN u0 [I r1]] u1 : The callback to call when the event occurs. [I r1] : the list of the buttons state
u0	: User parameter

Returns

ObjVRPN : The same object

Definition at line 280 of file scolplugin.cpp.

_CBvrpnButtonState()

int _CBvrpnButtonState

(

mmachine

m

)

_CBvrpnButtonState : This function sets the callback called when a VRPN Button data is received

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

Parameters

ObjVRPN	: VRPN object to apply the callback
fun	[ObjVRPN u0 I I] u1 : The callback to call when the event occurs. I : the button id I : the new button state
u0	: User parameter

Returns

ObjVRPN : The same object

Definition at line 352 of file scolplugin.cpp.

_CBvrpnTextData()

int _CBvrpnTextData

(

mmachine

m

)

_CBvrpnTextData : This function sets the callback called when a VRPN text data is received

Prototype: fun [ObjVRPN fun [ObjVRPN u0 S] u1 u0] ObjVRPN

Parameters

ObjVRPN	: VRPN object to apply the callback
fun	[ObjVRPN u0 S] u1 : The callback to call when the event occurs. S : the text message
u0	: User parameter

Returns

ObjVRPN : The same object

Definition at line 633 of file scolplugin.cpp.

_CBvrpnTrackerAccelData()

int _CBvrpnTrackerAccelData

(

mmachine

m

)

_CBvrpnTrackerAccelData : This function sets the callback called when a VRPN traker acceleration data is received

Prototype: fun [ObjVRPN fun [ObjVRPN u0 I [F F F] [F F F F]] u1 u0] ObjVRPN

Parameters

ObjVRPN	: VRPN object to apply the callback
fun	[ObjVRPN u0 I [F F F] [F F F F]] u1 : The callback to call when the event occurs. I : the sensor id [F F F] : the tracker acceleration [F F F F] : the tracker angular acceleration
u0	: User parameter

Returns

ObjVRPN : The same object

Definition at line 560 of file scolplugin.cpp.

_CBvrpnTrackerData()

int _CBvrpnTrackerData

(

mmachine

m

)

_CBvrpnTrackerData : This function sets the callback called when a VRPN traker position data is received

Prototype: fun [ObjVRPN fun [ObjVRPN u0 I [F F F] [F F F F]] u1 u0] ObjVRPN

Parameters

ObjVRPN	: VRPN object to apply the callback
fun	[ObjVRPN u0 I [F F F] [F F F F]] u1 : The callback to call when the event occurs. I : the sensor id [F F F] : the tracker position [F F F F] : the tracker orientation
u0	: User parameter

Returns

ObjVRPN : The same object

Definition at line 410 of file scolplugin.cpp.

_CBvrpnTrackerVelocityData()

int _CBvrpnTrackerVelocityData

(

mmachine

m

)

_CBvrpnTrackerVelocityData : This function sets the callback called when a VRPN traker velocity data is received

Prototype: fun [ObjVRPN fun [ObjVRPN u0 I [F F F] [F F F F]] u1 u0] ObjVRPN

Parameters

ObjVRPN	: VRPN object to apply the callback
fun	[ObjVRPN u0 I [F F F] [F F F F]] u1 : The callback to call when the event occurs. I : the sensor id [F F F] : the tracker velocity [F F F F] : the tracker angular velocity
u0	: User parameter

Returns

ObjVRPN : The same object

Definition at line 485 of file scolplugin.cpp.

_CRvrpnDevice()

int _CRvrpnDevice

(

mmachine

m

)

_CRvrpnDevice : This function create a VRPN object

Prototype: fun [Chn S S] ObjVRPN

Parameters

Chn	: channel
S	: host name or ip address
S	: device name

Returns

ObjVRPN : the VRPN object if success, NIL otherwise

Definition at line 113 of file scolplugin.cpp.

_DSvrpnDevice()

int _DSvrpnDevice

(

mmachine

m

)

_DSvrpnDevice : Destroy VRPN object

fun [ObjVRPN] I

Parameters

ObjVRPN

: VRPN Object to destroy

Returns

I : 0 if success, NIL otherwise

Definition at line 174 of file scolplugin.cpp.