This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
基础
专业(SIM)
UnigineEditor
界面概述
资源工作流程
版本控制
设置和首选项
项目开发
调整节点参数
Setting Up Materials
设置属性
照明
Sandworm
使用编辑器工具执行特定任务
如何擴展編輯器功能
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
使用范例
C++
C#
UnigineScript
统一的Unigine着色器语言 UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
材质和着色器
Rebuilding the Engine Tools
GUI
双精度坐标
应用程序接口
Animations-Related Classes
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
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
创建内容
内容优化
材质
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

Unigine::Plugins::VrpnAnalogDevice Class

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.
Header: #include <plugins/Unigine/VrpnClient/UnigineVrpnClient.h>

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 ( const char * 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

  • const char * 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));
    }
}

const char * 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.

bool hasChanges ( ) const#

Returns a value indicating if there were any changes in analog values registered.

Return value

true if there were any changes in analog values registered otherwise, false.

VrpnAnalogDevice ( const char * name ) #

Constructor.

Arguments

  • const char * name - Path to the device in the format device_name@server_address.
Last update: 2024-04-19
Build: ()