This page has been translated automatically.
Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Extending Editor Functionality
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World Nodes
Звуковые объекты
Объекты поиска пути
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
C#
UnigineScript
Унифицированный язык шейдеров UUSL
Плагины
File Formats
Rebuilding the Engine Tools
GUI
Двойная точность координат
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
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Material Nodes Library
Art Samples
Tutorials

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/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.

VrpnAnalogDevice ( const char * name ) #

Constructor.

Arguments

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