This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
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
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Plugins::VrpnButtonDevice 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 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 ( const char * 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

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

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

int getNumButtons ( ) const#

Returns the total number of buttons of the input device.

Return value

Total number of buttons of the input device.

int getButtonState ( int num ) const#

Returns the current state for a button with the specified index.

Arguments

  • int num - Button index.

Return value

Button state.

VrpnButtonDevice ( const char * name ) #

Constructor.

Arguments

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