Panda3D
Loading...
Searching...
No Matches
Public Member Functions | List of all members
VrpnDial Class Reference

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

#include "vrpnDial.h"

Public Member Functions

 VrpnDial (const std::string &dial_name, vrpn_Connection *connection)
 
const std::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 (std::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 (std::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 37 of file vrpnDial.h.

Constructor & Destructor Documentation

◆ VrpnDial()

VrpnDial::VrpnDial ( const std::string & dial_name,
vrpn_Connection * connection )

Definition at line 26 of file vrpnDial.cxx.

◆ ~VrpnDial()

VrpnDial::~VrpnDial ( )

Definition at line 38 of file vrpnDial.cxx.

Member Function Documentation

◆ get_dial_name()

const std::string & VrpnDial::get_dial_name ( ) const
inline

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

Definition at line 17 of file vrpnDial.I.

◆ is_empty()

bool VrpnDial::is_empty ( ) const
inline

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

Definition at line 26 of file vrpnDial.I.

◆ mark()

void VrpnDial::mark ( VrpnDialDevice * device)

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

Definition at line 47 of file vrpnDial.cxx.

◆ output()

void VrpnDial::output ( std::ostream & out) const

Definition at line 85 of file vrpnDial.cxx.

◆ poll()

void VrpnDial::poll ( )

Polls the connected device.

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

Definition at line 77 of file vrpnDial.cxx.

◆ unmark()

void VrpnDial::unmark ( VrpnDialDevice * device)

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

Definition at line 59 of file vrpnDial.cxx.

◆ write()

void VrpnDial::write ( std::ostream & out,
int indent_level = 0 ) const

Definition at line 93 of file vrpnDial.cxx.


The documentation for this class was generated from the following files: