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.

Methods:

Name	Description View: Sort by:
setAnalogCallback	Sets the world script callback function that receives data about input device sticks.
getAnalogCallback	Returns a name of the world script callback function that receives data about input device sticks.
getChannel	Returns data received by the analog stick with the given number.
getNumChannels	Returns the number of analog sticks that have received data.
update	Updates the internal state of the device and receives input data.
hasChanges	Returns a value indicating if there were any changes in analog values registered.
VrpnAnalogDevice	Constructor.

VrpnAnalogDevice Class

Members

void setAnalogCallback ( const char * name ) #

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

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

NoticeIf 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

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::VrpnAnalogDevice Class

In This Article:

See Also#

Methods:

VrpnAnalogDevice Class

Members

void setAnalogCallback ( const char * name ) #

Arguments

Examples

const char * getAnalogCallback ( ) #

Return value

double getChannel ( int channel ) #

Arguments

Return value

int getNumChannels ( ) #

Return value

void update ( ) #

bool hasChanges ( ) const#

Return value

VrpnAnalogDevice ( const char * name ) #

Arguments