Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Core Library
Containers
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes

VrpnButtonDevice Class

A class for the VRPN plugin add-on that allows receiving data about states of input device buttons.

See Also

VrpnButtonDevice Class

Members


VrpnButtonDevice (string name)

Constructor.

Arguments

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

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 setButtonCallback (string name)

Sets the world script callback function that receives data about input device buttons.
Notice
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
}

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);
}

void update ()

Updates the internal state of the device and receives input data.
Notice
This function should be called each frame.
Last update: 2017-07-03