This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

VrpnButtonDevice Class

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

See Also#

  • Article on VRPN Plugin
  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/plugins/ folder:
    • vrpn_client_00
    • vrpn_client_01

VrpnButtonDevice Class

Members


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

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: 2019-08-16
Build: ()