Panda3D
Classes | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
ClientButtonDevice Class Reference

A device, attached to the ClientBase by a ButtonNode, that records the data from a single named button device. More...

#include "clientButtonDevice.h"

Inheritance diagram for ClientButtonDevice:
ClientDevice TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase VrpnButtonDevice

List of all members.

Classes

class  ButtonState

Public Member Functions

virtual TypeHandle force_init_type ()
ButtonEventListget_button_events () const
 Returns the list of recently-generated ButtonEvents.
ButtonHandle get_button_map (int index) const
 Returns the ButtonHandle that was previously associated with the given index number by a call to set_button_map(), or ButtonHandle::none() if no button was associated.
bool get_button_state (int index) const
 Returns true if the indicated button (identified by its index number) is currently known to be down, or false if it is up or unknown.
int get_num_buttons () const
 Returns the number of buttons known to the ClientButtonDevice.
virtual TypeHandle get_type () const
bool is_button_known (int index) const
 Returns true if the state of the indicated button is known, or false if we have never heard anything about this particular button.
virtual void output (ostream &out) const
void output_buttons (ostream &out) const
 Writes a one-line string of all of the current button states.
void set_button_map (int index, ButtonHandle button)
 Associates the indicated ButtonHandle with the button of the indicated index number.
void set_button_state (int index, bool down)
 Sets the state of the indicated button index, where true indicates down, and false indicates up.
virtual void write (ostream &out, int indent_level=0) const
void write_buttons (ostream &out, int indent_level) const
 Writes a multi-line description of the current button states.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Protected Types

typedef pvector< ButtonStateButtons
enum  State { S_unknown, S_up, S_down }

Protected Member Functions

 ClientButtonDevice (ClientBase *client, const string &device_name)
 PT (ButtonEventList) _button_events

Protected Attributes

Buttons _buttons

Friends

class ButtonState

Detailed Description

A device, attached to the ClientBase by a ButtonNode, that records the data from a single named button device.

The named device can contain any number of up/down style buttons, numbered in sequence beginning at zero; these are mapped by this class to a sequence of ButtonHandles specified by the user.

Definition at line 37 of file clientButtonDevice.h.


Member Function Documentation

Returns the list of recently-generated ButtonEvents.

This must be periodically cleared, or the buttons will accumulate.

Definition at line 122 of file clientButtonDevice.I.

ButtonHandle ClientButtonDevice::get_button_map ( int  index) const [inline]

Returns the ButtonHandle that was previously associated with the given index number by a call to set_button_map(), or ButtonHandle::none() if no button was associated.

Definition at line 74 of file clientButtonDevice.I.

References ButtonHandle::none().

bool ClientButtonDevice::get_button_state ( int  index) const [inline]

Returns true if the indicated button (identified by its index number) is currently known to be down, or false if it is up or unknown.

Definition at line 90 of file clientButtonDevice.I.

int ClientButtonDevice::get_num_buttons ( ) const [inline]

Returns the number of buttons known to the ClientButtonDevice.

This includes those buttons whose state has been seen, as well as buttons that have been associated with a ButtonHandle even if their state is unknown. This number may change as more buttons are discovered.

Definition at line 40 of file clientButtonDevice.I.

static void ClientButtonDevice::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from ClientDevice.

Reimplemented in VrpnButtonDevice.

Definition at line 86 of file clientButtonDevice.h.

References ClientDevice::init_type().

bool ClientButtonDevice::is_button_known ( int  index) const [inline]

Returns true if the state of the indicated button is known, or false if we have never heard anything about this particular button.

Definition at line 106 of file clientButtonDevice.I.

void ClientButtonDevice::output_buttons ( ostream &  out) const

Writes a one-line string of all of the current button states.

Definition at line 104 of file clientButtonDevice.cxx.

void ClientButtonDevice::set_button_map ( int  index,
ButtonHandle  button 
) [inline]

Associates the indicated ButtonHandle with the button of the indicated index number.

When the given button index changes state, a corresponding ButtonEvent will be generated with the given ButtonHandle. Pass ButtonHandle::none() to turn off any association.

It is not necessary to call this if you simply want to query the state of the various buttons by index number; this is only necessary in order to generate ButtonEvents when the buttons change state.

Definition at line 59 of file clientButtonDevice.I.

void ClientButtonDevice::set_button_state ( int  index,
bool  down 
)

Sets the state of the indicated button index, where true indicates down, and false indicates up.

This may generate a ButtonEvent if the button has an associated ButtonHandle. The caller should ensure that acquire() is in effect while this call is made.

Definition at line 45 of file clientButtonDevice.cxx.

References ButtonHandle::none().

void ClientButtonDevice::write_buttons ( ostream &  out,
int  indent_level 
) const

Writes a multi-line description of the current button states.

Definition at line 135 of file clientButtonDevice.cxx.

References ButtonHandle::none().


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