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
编程
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
应用程序接口
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
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

VrpnAnalogDevice Class

A class for the VRPN Plugin that allows receiving data about input devices sticks (for example, game-pad sticks).

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

VrpnAnalogDevice Class

Members


void setAnalogCallback ( string name ) #

Sets the world script callback function that receives data about input device sticks.
Notice
The callback function should be defined in the world script and receive 1 argument - an instance of the VrpnAnalogDevice class.
Source code (UnigineScript)
void callback_func(VrpnAnalogDevice device) {
    // function logic
}

Arguments

  • string name - Callback function name.

Examples

Source code (UnigineScript)
VrpnAnalogDevice vrpn_analog;

int init() {
	// create an instance of VrpnAnalogDevice
    vrpn_analog = new VrpnAnalogDevice("device_name@server_addr");
	// set a callback
    vrpn_analog.setAnalogCallback("analog_callback");
}

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

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

// a callback function
void analog_callback(VrpnAnalogDevice device) {
    forloop(int i = 0; device.getNumChannels()) {
        log.message("Device analog channel %d: %lf\n",i,device.getChannel(i));
    }
}

string getAnalogCallback ( ) #

Returns a name of the world script callback function that receives data about input device sticks. The callback function should be defined in the world script and receive 1 argument - an instance of the VrpnAnalogDevice class.
Source code (UnigineScript)
void callback_func(VrpnAnalogDevice device) {
    // function logic
}

Return value

Callback function name.

double getChannel ( int channel ) #

Returns data received by the analog stick with the given number.
Notice
If the given stick haven't received data, the engine assertion will occur.

Arguments

  • int channel - Analog stick number in range [0;number_of_sticks - 1].

Return value

Returns data received by the analog stick with the given number.

int getNumChannels ( ) #

Returns the number of analog sticks that have received data.

Return value

The number of analog sticks that have received data. If no sticks have received data, 0 will be returned.

void update ( ) #

Updates the internal state of the device and receives input data.
Notice
This function should be called each frame.

VrpnAnalogDevice ( string name ) #

Constructor.

Arguments

  • string name - Path to the device in the format device_name@server_address.
Last update: 2019-08-16
Build: ()