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

#include <vrpn_Button.h>

Inheritance diagram for vrpn_Button_Server:
Collaboration diagram for vrpn_Button_Server:

Public Member Functions

 vrpn_Button_Server (const char *name, vrpn_Connection *c, int numbuttons=1)
 
int number_of_buttons (void)
 Tells how many buttons there are (may be clipped to MAX_BUTTONS)
 
virtual void mainloop ()
 Called once each time through the server program's mainloop to handle various functions (like setting toggles, reporting changes, etc).
 
int set_button (int button, int new_value)
 Allows the server program to set current button states (to 0 or 1)
 
- 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)
 
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)
 
- 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 ()
 
virtual void mainloop ()=0
 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_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.
 

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
 
vrpn_MESSAGEHANDLER handler
 
vrpn_int32 sender
 
vrpn_int32 type
 
void * userdata
 
- 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_changes (void)
 
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.
 
virtual vrpn_int32 encode_states_to (char *buf)
 Encode a message describing the state of all buttons.
 
- 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.
 
virtual int register_types (void)=0
 Register the types of messages this device sends/receives. 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()
 
- 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_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.
 

Detailed Description

Definition at line 99 of file vrpn_Button.h.

Constructor & Destructor Documentation

◆ vrpn_Button_Server()

vrpn_Button_Server::vrpn_Button_Server ( const char *  name,
vrpn_Connection c,
int  numbuttons = 1 
)

Definition at line 457 of file vrpn_Button.C.

References vrpn_Button::num_buttons, and vrpn_BUTTON_MAX_BUTTONS.

Member Function Documentation

◆ mainloop()

void vrpn_Button_Server::mainloop ( void  )
virtual

Called once each time through the server program's mainloop to handle various functions (like setting toggles, reporting changes, etc).

Implements vrpn_BaseClass.

Reimplemented in vrpn_Event_Mouse.

Definition at line 471 of file vrpn_Button.C.

References vrpn_Button_Filter::report_changes(), and vrpn_BaseClassUnique::server_mainloop().

Referenced by vrpn_Tracker_Fastrak::get_report(), vrpn_Tracker_InterSense::get_report(), vrpn_Tracker_Isotrak::get_report(), vrpn_Tracker_Liberty::get_report(), and vrpn_Android_Server::mainloop().

Here is the call graph for this function:

◆ number_of_buttons()

int vrpn_Button_Server::number_of_buttons ( void  )

Tells how many buttons there are (may be clipped to MAX_BUTTONS)

Definition at line 469 of file vrpn_Button.C.

References vrpn_Button::num_buttons.

Referenced by vrpn_Tracker_Fastrak::get_report(), and vrpn_Tracker_InterSense::get_report().

◆ set_button()

int vrpn_Button_Server::set_button ( int  button,
int  new_value 
)

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