vrpn 07.35
Virtual Reality Peripheral Network
 
Loading...
Searching...
No Matches
vrpn_3DConnexion_Traveler Class Reference

#include <vrpn_3DConnexion.h>

Inheritance diagram for vrpn_3DConnexion_Traveler:
Collaboration diagram for vrpn_3DConnexion_Traveler:

Public Member Functions

 vrpn_3DConnexion_Traveler (const char *name, vrpn_Connection *c=0)
 
virtual ~vrpn_3DConnexion_Traveler ()
 
- Public Member Functions inherited from vrpn_3DConnexion
 vrpn_3DConnexion (vrpn_HidAcceptor *filter, unsigned num_buttons, const char *name, vrpn_Connection *c=0, vrpn_uint16 vendor=0, vrpn_uint16 product=0)
 
virtual ~vrpn_3DConnexion ()
 
virtual void mainloop ()
 Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().
 
- Public Member Functions inherited from vrpn_Button_Filter
virtual void set_momentary (vrpn_int32 which_button)
 
virtual void set_toggle (vrpn_int32 which_button, vrpn_int32 current_state)
 
virtual void set_all_momentary (void)
 
virtual void set_all_toggle (vrpn_int32 default_state)
 
void set_alerts (vrpn_int32)
 
- Public Member Functions inherited from vrpn_Button
 vrpn_Button (const char *name, vrpn_Connection *c=NULL)
 
virtual ~vrpn_Button (void)
 
void print (void)
 
- Public Member Functions inherited from vrpn_BaseClass
 vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL)
 Names the device and assigns or opens connection, calls registration methods.
 
virtual ~vrpn_BaseClass ()
 
- Public Member Functions inherited from vrpn_BaseClassUnique
 vrpn_BaseClassUnique ()
 
virtual ~vrpn_BaseClassUnique ()
 Unregister all of the message handlers that were to be autodeleted.
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using.
 
- Public Member Functions inherited from vrpn_Analog
 vrpn_Analog (const char *name, vrpn_Connection *c=NULL)
 
void print (void)
 
vrpn_int32 getNumChannels (void) const
 

Additional Inherited Members

- Public Attributes inherited from vrpn_Button_Filter
vrpn_int32 buttonstate [vrpn_BUTTON_MAX_BUTTONS]
 
- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
- Protected Member Functions inherited from vrpn_3DConnexion
void on_data_received (size_t bytes, vrpn_uint8 *buffer)
 Derived class reimplements this callback.
 
virtual void decodePacket (size_t bytes, vrpn_uint8 *buffer)
 
void report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY)
 
void report (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY)
 
- Protected Member Functions inherited from vrpn_Button_Filter
 vrpn_Button_Filter (const char *, vrpn_Connection *c=NULL)
 
virtual vrpn_int32 encode_states_to (char *buf)
 Encode a message describing the state of all buttons.
 
virtual void report_changes (void)
 
- Protected Member Functions inherited from vrpn_Button
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
virtual void report_states (void)
 
virtual vrpn_int32 encode_to (char *buf, vrpn_int32 button, vrpn_int32 state)
 Encode a message describing the new state of a button.
 
- Protected Member Functions inherited from vrpn_BaseClass
virtual int init (void)
 Initialize things that the constructor can't. Returns 0 on success, -1 on failure.
 
virtual int register_senders (void)
 Register the sender for this device (by default, the name of the device). Return 0 on success, -1 on fail.
 
- Protected Member Functions inherited from vrpn_BaseClassUnique
int register_autodeleted_handler (vrpn_int32 type, vrpn_MESSAGEHANDLER handler, void *userdata, vrpn_int32 sender=vrpn_ANY_SENDER)
 Registers a handler with the connection, and remembers to delete at destruction.
 
int send_text_message (const char *msg, struct timeval timestamp, vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL, vrpn_uint32 level=0)
 Sends a NULL-terminated text message from the device d_sender_id.
 
SendTextMessageBoundCall send_text_message (vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL)
 Returns an object you can stream into to send a text message from the device like send_text_message(vrpn_TEXT_WARNING) << "Value of i is: " << i; This use requires including vrpn_SendTextMessageStreamProxy.h.
 
void server_mainloop (void)
 Handles functions that all servers should provide in their mainloop() (ping/pong, for example) Should be called by all servers in their mainloop()
 
void client_mainloop (void)
 Handles functions that all clients should provide in their mainloop() (warning of no server, for example) Should be called by all clients in their mainloop()
 
- Protected Member Functions inherited from vrpn_Analog
virtual int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
virtual vrpn_int32 encode_to (char *buf)
 
virtual void report_changes (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY, const struct timeval time=vrpn_ANALOG_NOW)
 Send a report only if something has changed (for servers) Optionally, tell what time to stamp the value with.
 
virtual void report (vrpn_uint32 class_of_service=vrpn_CONNECTION_LOW_LATENCY, const struct timeval time=vrpn_ANALOG_NOW)
 Send a report whether something has changed or not (for servers) Optionally, tell what time to stamp the value with.
 
- Protected Member Functions inherited from vrpn_HidInterface
void send_data (size_t bytes, const vrpn_uint8 *buffer)
 Call this to send data to the device.
 
void send_feature_report (size_t bytes, const vrpn_uint8 *buffer)
 Call this to send a feature report to the device - first byte must be Report ID (or 0x0 for devices without numbered reports)
 
int get_feature_report (size_t bytes, vrpn_uint8 *buffer)
 Call this to get a feature report from the device - first byte must be Report ID (or 0x0 for devices without numbered reports)
 
 vrpn_HidInterface (vrpn_HidAcceptor *acceptor, vrpn_uint16 vendor=0, vrpn_uint16 product=0, hid_device *device=NULL)
 Constructor If we already have a HID device from some other source, it can be passed and we'll take ownership: still need the acceptor for reconnect, we just won't do it right away.
 
 vrpn_HidInterface (vrpn_HidAcceptor *acceptor, hid_device *device)
 Simplified constructor that just takes an acceptor and an underlying HID device (both non-optional).
 
 vrpn_HidInterface (const char *device_path, vrpn_HidAcceptor *acceptor, vrpn_uint16 vendor=0, vrpn_uint16 product=0)
 Constructor If we already know the path to the device we want, we can pass it in and open it directly: still need the acceptor for reconnect enumeration, we just won't do it right away.
 
virtual ~vrpn_HidInterface ()
 
virtual bool connected () const
 Returns true iff the last device I/O succeeded.
 
virtual void update ()
 Polls the device buffers and causes on_data_received callbacks if appropriate You NEED to call this frequently to ensure the OS doesn't drop data.
 
virtual bool reconnect ()
 Tries to reconnect to an acceptable device. Call this if you suspect a hotplug event has occurred.
 
vrpn_uint16 vendor () const
 Returns USB vendor ID of connected device May not contain valid if an already-open device was provided to the constructor.
 
vrpn_uint16 product () const
 Returns USB product ID of connected device May not contain valid if an already-open device was provided to the constructor.
 
int interface_number () const
 Returns the USB interface number of connected device May not contain valid information on all platforms or if an already-open device was provided to the constructor.
 
- Static Protected Member Functions inherited from vrpn_Button_Filter
static int VRPN_CALLBACK handle_ping_message (void *userdata, vrpn_HANDLERPARAM p)
 
- Static Protected Member Functions inherited from vrpn_BaseClassUnique
static int encode_text_message_to_buffer (char *buf, vrpn_TEXT_SEVERITY severity, vrpn_uint32 level, const char *msg)
 Encodes the body of the text message into a buffer, preparing for sending.
 
static int decode_text_message_from_buffer (char *msg, vrpn_TEXT_SEVERITY *severity, vrpn_uint32 *level, const char *buf)
 Decodes the body of the text message from a buffer from the connection.
 
- Protected Attributes inherited from vrpn_3DConnexion
struct timeval _timestamp
 
vrpn_HidAcceptor_filter
 
- Protected Attributes inherited from vrpn_Button_Filter
int send_alerts
 
vrpn_int32 alert_message_id
 
- Protected Attributes inherited from vrpn_Button
unsigned char buttons [vrpn_BUTTON_MAX_BUTTONS]
 
unsigned char lastbuttons [vrpn_BUTTON_MAX_BUTTONS]
 
vrpn_int32 minrate [vrpn_BUTTON_MAX_BUTTONS]
 
vrpn_int32 num_buttons
 
struct timeval timestamp
 
vrpn_int32 change_message_id
 
vrpn_int32 states_message_id
 
vrpn_int32 admin_message_id
 
- Protected Attributes inherited from vrpn_BaseClassUnique
vrpn_Connectiond_connection
 Connection that this object talks to.
 
char * d_servicename
 Name of this device, not including the connection part.
 
vrpn_int32 d_sender_id
 Sender ID registered with the connection.
 
vrpn_int32 d_text_message_id
 ID for text messages.
 
vrpn_int32 d_ping_message_id
 Ask the server if they are there.
 
vrpn_int32 d_pong_message_id
 Server telling that it is there.
 
- Protected Attributes inherited from vrpn_Analog
vrpn_float64 channel [vrpn_CHANNEL_MAX]
 
vrpn_float64 last [vrpn_CHANNEL_MAX]
 
vrpn_int32 num_channel
 
struct timeval timestamp
 
vrpn_int32 channel_m_id
 
int status
 
- Protected Attributes inherited from vrpn_HidInterface
vrpn_HidAcceptorm_acceptor
 This is the HidAcceptor we use when reconnecting.
 
bool m_working
 
vrpn_uint16 m_vendor
 
vrpn_uint16 m_product
 
int m_interface
 
vrpn_uint16 m_vendor_sought
 What vendor we want.
 
vrpn_uint16 m_product_sought
 What product we want.
 

Detailed Description

Definition at line 98 of file vrpn_3DConnexion.h.

Constructor & Destructor Documentation

◆ vrpn_3DConnexion_Traveler()

vrpn_3DConnexion_Traveler::vrpn_3DConnexion_Traveler ( const char * name,
vrpn_Connection * c = 0 )

Definition at line 340 of file vrpn_3DConnexion.C.

References vrpn_3DConnexion::vrpn_3DConnexion().

Here is the call graph for this function:

◆ ~vrpn_3DConnexion_Traveler()

virtual vrpn_3DConnexion_Traveler::~vrpn_3DConnexion_Traveler ( )
inlinevirtual

Definition at line 101 of file vrpn_3DConnexion.h.


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