VrpnButtonDevice Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Warning

The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.

A class for the VRPN Plugin that allows receiving data about states of input device buttons.

Methods:

Name	Description View: Sort by:
setButtonCallback	Sets the world script callback function that receives data about input device buttons.
getButtonCallback	Returns a name of the world script callback function that receives data about input device buttons.
update	Updates the internal state of the device and receives input data.
VrpnButtonDevice	Constructor.

VrpnButtonDevice Class

Members

void setButtonCallback ( string name ) #

Sets the world script callback function that receives data about input device buttons.

NoticeThe callback function should be defined in the world script and receive 2 arguments - a button number and state.
						Source code (UnigineScript)void callback_func(int button,int state) {
    // function logic
}

Arguments

string name - Callback function name.

Examples

Source code (UnigineScript)

VrpnButtonDevice vrpn_button;

int init() {
	// create an instance of VrpnButtonDevice
    vrpn_button = new VrpnButtonDevice("device_name@server_addr");
	// set a callback
    vrpn_button.setButtonCallback("button_callback");
    return 1;
}

int shutdown() {
    delete vrpn_button;
    return 1;
}

int update() {
    vrpn_button.update();
    return 1;
}

// a callback function
void button_callback(int button,int state) {
    log.message("Device button %d: %d\n",button,state);
}

string getButtonCallback ( ) #

Returns a name of the world script callback function that receives data about input device buttons. The callback function should be defined in the world script and receive 2 arguments - a button number and state.

Source code (UnigineScript)

void callback_func(int button,int state) {
    // function logic
}

Return value

Callback function name.

void update ( ) #

Updates the internal state of the device and receives input data.

Notice

This function should be called each frame.

VrpnButtonDevice ( string name ) #

Constructor.

Arguments

string name - Path to the device in the format device_name@server_address.

Last update: 2021-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

VrpnButtonDevice Class

See Also#

Methods:

VrpnButtonDevice Class

Members

void setButtonCallback ( string name ) #

Arguments

Examples

string getButtonCallback ( ) #

Return value

void update ( ) #

VrpnButtonDevice ( string name ) #

Arguments