Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

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:


Public Member Functions
int	get_num_buttons () const
	Returns the number of buttons known to the ClientButtonDevice.
void	set_button_map (int index, ButtonHandle button)
	Associates the indicated ButtonHandle with the button of the indicated index number.
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.
void	set_button_state (int index, bool down)
	Sets the state of the indicated button index, where true indicates down, and false indicates up.
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.
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.
ButtonEventList *	get_button_events () const
	Returns the list of recently-generated ButtonEvents.
virtual void	output (ostream &out) const
virtual void	write (ostream &out, int indent_level=0) const
void	output_buttons (ostream &out) const
	Writes a one-line string of all of the current button states.
void	write_buttons (ostream &out, int indent_level) const
	Writes a multi-line description of the current button states.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
ClientBase *	get_client () const
	Returns the ClientBase this device is associated with.
TypeHandle	get_device_type () const
	Returns the type of device this is considered to be to the ClientBase: a ClientTrackerDevice, ClientAnalogDevice, or what have you.
const string &	get_device_name () const
	Returns the device name reported to the ClientBase.
bool	is_connected () const
	Returns true if the device is still connected to its ClientBase, false otherwise.
void	disconnect ()
	Disconnects the ClientDevice from its ClientBase object.
void	poll ()
	Causes the connected ClientBase to poll all of its clients, if necessary.
void	lock ()
	Grabs the mutex associated with this particular device.
void	unlock ()
	Releases the mutex associated with this particular device.
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Protected Types
typedef pvector< ButtonState >	Buttons
enum	State { S_unknown, S_up, S_down }
Protected Member Functions
	ClientButtonDevice (ClientBase *client, const string &device_name)
Protected Attributes
Buttons	_buttons
PointerTo< ButtonEventList >	_button_events
Private Member Functions
void	ensure_button_index (int index)
	Guarantees that there is a slot in the array for the indicated index number, by filling the array up to that index if necessary.
Static Private Attributes
TypeHandle	_type_handle
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 53 of file clientButtonDevice.h.

Member Typedef Documentation

typedef pvector<ButtonState> ClientButtonDevice::Buttons [protected]

Definition at line 93 of file clientButtonDevice.h.

Member Enumeration Documentation

enum ClientButtonDevice::State [protected]

Enumeration values:

S_unknown

S_up

S_down

Definition at line 79 of file clientButtonDevice.h.

Constructor & Destructor Documentation

ClientButtonDevice::ClientButtonDevice ( ClientBase * client,

const string & device_name

) [protected]

Definition at line 37 of file clientButtonDevice.cxx.
References _button_events, _buttons, ensure_button_index(), nassertv, ButtonHandle::none(), S_down, S_up, ButtonEvent::T_down, and ButtonEvent::T_up.

Member Function Documentation

void ClientDevice::disconnect ( ) [inherited]

Disconnects the ClientDevice from its ClientBase object.
The device will stop receiving updates.
Normally, you should not need to call this explicitly (and it is probably a mistake to do so); it will automatically be called when the ClientDevice object destructs.
The lock should *not* be held while this call is made; it will explicitly grab the lock itself.
Definition at line 103 of file clientDevice.cxx.

void ClientButtonDevice::ensure_button_index ( int index ) [private]

Guarantees that there is a slot in the array for the indicated index number, by filling the array up to that index if necessary.

Definition at line 86 of file clientButtonDevice.cxx.
Referenced by ClientButtonDevice(), and get_num_buttons().

virtual TypeHandle ClientButtonDevice::force_init_type ( void ) [inline, virtual]

Reimplemented from ClientDevice.
Reimplemented in VrpnButtonDevice.
Definition at line 110 of file clientButtonDevice.h.

ButtonEventList * ClientButtonDevice::get_button_events ( ) const [inline]

Returns the list of recently-generated ButtonEvents.
This must be periodically cleared, or the buttons will accumulate.
Definition at line 172 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 109 of file clientButtonDevice.I.
References _buttons, INLINE, and S_unknown.

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 130 of file clientButtonDevice.I.

TypeHandle ClientButtonDevice::get_class_type ( void ) [inline, static]

Reimplemented from ClientDevice.
Reimplemented in VrpnButtonDevice.
Definition at line 99 of file clientButtonDevice.h.

ClientBase * ClientDevice::get_client ( ) const [inline, inherited]

Returns the ClientBase this device is associated with.

Definition at line 34 of file clientDevice.I.
References ClientDevice::_is_connected, and INLINE.

const string & ClientDevice::get_device_name ( ) const [inline, inherited]

Returns the device name reported to the ClientBase.
This has some implementation-defined meaning to identify particular devices.
Definition at line 91 of file clientDevice.I.
References INLINE.
Referenced by ClientAnalogDevice::ensure_control_index().

TypeHandle ClientDevice::get_device_type ( ) const [inline, inherited]

Returns the type of device this is considered to be to the ClientBase: a ClientTrackerDevice, ClientAnalogDevice, or what have you.
This is not exactly the same thing as get_type(), because it does not return the exact type of the ClientDevice (e.g. it reports ClientTrackerDevice, not VrpnTrackerDevice).
Definition at line 74 of file clientDevice.I.
References INLINE.

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 57 of file clientButtonDevice.I.
References _buttons, ensure_button_index(), INLINE, and nassertv.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]

Returns the current reference count.

Definition at line 183 of file referenceCount.I.
Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle ClientButtonDevice::get_type ( void ) const [inline, virtual]

Reimplemented from ClientDevice.
Reimplemented in VrpnButtonDevice.
Definition at line 107 of file clientButtonDevice.h.

int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
Definition at line 71 of file typedObject.I.
References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

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

Reimplemented from ClientDevice.
Reimplemented in VrpnButtonDevice.
Definition at line 102 of file clientButtonDevice.h.

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 151 of file clientButtonDevice.I.

bool ClientDevice::is_connected ( ) const [inline, inherited]

Returns true if the device is still connected to its ClientBase, false otherwise.

Definition at line 49 of file clientDevice.I.
References ClientDevice::_device_type, and INLINE.

bool TypedObject::is_exact_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.
Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.
Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

void ClientDevice::lock ( ) [inline, inherited]

Grabs the mutex associated with this particular device.
The device will not update asynchronously while the mutex is held, allowing the user to copy the data out without fear of getting a partial update during the copy.
Definition at line 112 of file clientDevice.I.
Referenced by VrpnTracker::vrpn_position_callback(), VrpnTracker::vrpn_velocity_callback(), and ClientDevice::~ClientDevice().

void ClientButtonDevice::output ( ostream & out ) const [virtual]

Reimplemented from ClientDevice.
Definition at line 103 of file clientButtonDevice.cxx.
References _buttons, ClientButtonDevice::ButtonState::_state, and S_unknown.

void ClientButtonDevice::output_buttons ( ostream & out ) const

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

Definition at line 133 of file clientButtonDevice.cxx.
References _buttons, ClientButtonDevice::ButtonState::_handle, ClientButtonDevice::ButtonState::_state, indent(), ButtonHandle::none(), S_unknown, and S_up.

void ClientDevice::poll ( ) [inherited]

Causes the connected ClientBase to poll all of its clients, if necessary.
This will be a no-op if the client is running in forked mode, or if it has already polled everything this frame.
This should generally be called before accessing the data in this ClientDevice to ensure that it is fresh.
Definition at line 135 of file clientDevice.cxx.

int ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 225 of file referenceCount.I.
Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

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 88 of file clientButtonDevice.I.
References _buttons, INLINE, and S_down.

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 lock() is in effect while this call is made.
Definition at line 61 of file clientButtonDevice.cxx.
References _buttons, ButtonState, and nassertv.

void ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.
References INLINE.
Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

void ClientDevice::unlock ( ) [inline, inherited]

Releases the mutex associated with this particular device.
This should be called after all the data has been successfully copied out. See lock().
Definition at line 131 of file clientDevice.I.
Referenced by VrpnTracker::vrpn_position_callback(), VrpnTracker::vrpn_velocity_callback(), and ClientDevice::~ClientDevice().

int ReferenceCount::unref ( ) const [inline, inherited]

Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 293 of file referenceCount.I.
References INLINE.
Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

void ClientButtonDevice::write ( ostream & out,

int indent_level = 0

) const [virtual]

Reimplemented from ClientDevice.
Definition at line 117 of file clientButtonDevice.cxx.
References _buttons, and S_up.

void ClientButtonDevice::write_buttons ( ostream & out,

int indent_level

) const

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

Definition at line 168 of file clientButtonDevice.cxx.

Friends And Related Function Documentation

friend class ButtonState [friend]

Definition at line 114 of file clientButtonDevice.h.
Referenced by set_button_state().

Member Data Documentation

PointerTo< ButtonEventList > ClientButtonDevice::_button_events [protected]

Definition at line 96 of file clientButtonDevice.h.
Referenced by ClientButtonDevice().

Buttons ClientButtonDevice::_buttons [protected]

Definition at line 94 of file clientButtonDevice.h.
Referenced by ClientButtonDevice(), get_button_map(), get_num_buttons(), output(), output_buttons(), set_button_map(), set_button_state(), and write().

TypeHandle ClientButtonDevice::_type_handle [static, private]

Reimplemented from ClientDevice.
Reimplemented in VrpnButtonDevice.
Definition at line 27 of file clientButtonDevice.cxx.

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

panda/src/device/clientButtonDevice.h
panda/src/device/clientButtonDevice.cxx
panda/src/device/clientButtonDevice.I

Generated on Fri May 2 00:48:23 2003 for Panda by

1.3

ClientButtonDevice Class Reference

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes