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.

Methods:

Name	Description View: Sort by:
setButtonCallback	Sets the world script callback function that receives data about input device buttons.
getButtonCallback	Returns a name of the world script callback function that receives data about input device buttons.
update	Updates the internal state of the device and receives input data.
getNumButtons	Returns the total number of buttons of the input device.
getButtonState	Returns the current state for a button with the specified index.
VrpnButtonDevice	Constructor.

VrpnButtonDevice Class

Members

void setButtonCallback ( const char * name ) #

Sets the world script callback function that receives data about input device buttons.

NoticeThe 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

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine::Plugins::VrpnButtonDevice Class

In This Article:

See Also#

Methods:

VrpnButtonDevice Class

Members

void setButtonCallback ( const char * name ) #

Arguments

Examples

const char * getButtonCallback ( ) #

Return value

void update ( ) #

int getNumButtons ( ) const#

Return value

int getButtonState ( int num ) const#

Arguments

Return value

VrpnButtonDevice ( const char * name ) #

Arguments