Panda3D
Public Member Functions
VrpnDial Class Reference

This is the actual interface to a particular VRPN dial device, and all of its numbered dials. More...

#include "vrpnDial.h"

List of all members.

Public Member Functions

 VrpnDial (const string &dial_name, vrpn_Connection *connection)
const string & get_dial_name () const
 Returns the name of the dial device that was used to create this VrpnDial.
bool is_empty () const
 Returns true if no VrpnDialDevices reference this VrpnDial, or false otherwise.
void mark (VrpnDialDevice *device)
 Adds the indicated VrpnDialDevice to the list of devices that are sharing this VrpnDial.
void output (ostream &out) const
void poll ()
 Polls the connected device.
void unmark (VrpnDialDevice *device)
 Removes the indicated VrpnDialDevice from the list of devices that are sharing this VrpnDial.
void write (ostream &out, int indent_level=0) const

Detailed Description

This is the actual interface to a particular VRPN dial device, and all of its numbered dials.

A pointer to this object is stored in the VrpnClient class for each differently-named VRPN dial device we connect to.

The VRPN callbacks go here, which in turn get vectored out to any VrpnDialDevice objects that register with this. When the last VrpnDialDevice object unregisters, the VrpnDial will be deleted by the VrpnClient.

This class does not need to be exported from the DLL.

Definition at line 42 of file vrpnDial.h.


Member Function Documentation

const string & VrpnDial::get_dial_name ( ) const [inline]

Returns the name of the dial device that was used to create this VrpnDial.

Definition at line 22 of file vrpnDial.I.

bool VrpnDial::is_empty ( ) const [inline]

Returns true if no VrpnDialDevices reference this VrpnDial, or false otherwise.

Definition at line 33 of file vrpnDial.I.

void VrpnDial::mark ( VrpnDialDevice device)

Adds the indicated VrpnDialDevice to the list of devices that are sharing this VrpnDial.

Definition at line 55 of file vrpnDial.cxx.

void VrpnDial::poll ( ) [inline]

Polls the connected device.

Normally you should not call this directly; this will be called by the VrpnClient.

Definition at line 45 of file vrpnDial.I.

Referenced by VrpnClient::do_poll().

void VrpnDial::unmark ( VrpnDialDevice device)

Removes the indicated VrpnDialDevice from the list of devices that are sharing this VrpnDial.

Definition at line 69 of file vrpnDial.cxx.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations