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

ClientDialDevice Class Reference

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

#include <clientDialDevice.h>

Inheritance diagram for ClientDialDevice:


Public Member Functions
int	get_num_dials () const
	Returns the number of dial dials known to the ClientDialDevice.
void	push_dial (int index, double offset)
	Marks that the dial has been offset by the indicated amount.
double	read_dial (int index)
	Returns the number of complete revolutions of the dial since the last time read_dial() was called.
bool	is_dial_known (int index) const
	Returns true if the state of the indicated dial dial is known, or false if we have never heard anything about this particular dial.
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.
virtual void	output (ostream &out) const
virtual void	write (ostream &out, int indent_level=0) const
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< DialState >	Dials
Protected Member Functions
	ClientDialDevice (ClientBase *client, const string &device_name)
Protected Attributes
Dials	_dials
Private Member Functions
void	ensure_dial_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

Detailed Description

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

The named device can contain any number of dials, numbered in sequence beginning at zero.

A dial is a rotating device that does not have stops--it can keep rotating any number of times. Therefore it does not have a specific position at any given time, unlike an AnalogDevice.

Definition at line 54 of file clientDialDevice.h.

Member Typedef Documentation

typedef pvector<DialState> ClientDialDevice::Dials [protected]

Definition at line 77 of file clientDialDevice.h.

Constructor & Destructor Documentation

ClientDialDevice::ClientDialDevice ( ClientBase * client,

const string & device_name

) [inline, protected]

Definition at line 44 of file clientDialDevice.I.
References _dials, and INLINE.

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 ClientDialDevice::ensure_dial_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 44 of file clientDialDevice.cxx.
Referenced by get_num_dials().

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

Reimplemented from ClientDevice.
Reimplemented in VrpnDialDevice.
Definition at line 93 of file clientDialDevice.h.

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

Reimplemented from ClientDevice.
Reimplemented in VrpnDialDevice.
Definition at line 82 of file clientDialDevice.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 ClientDialDevice::get_num_dials ( ) const [inline]

Returns the number of dial dials known to the ClientDialDevice.
This number may change as more dials are discovered.
Definition at line 62 of file clientDialDevice.I.
References _dials, ensure_dial_index(), 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 ClientDialDevice::get_type ( void ) const [inline, virtual]

Reimplemented from ClientDevice.
Reimplemented in VrpnDialDevice.
Definition at line 90 of file clientDialDevice.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 ClientDialDevice::init_type ( void ) [inline, static]

Reimplemented from ClientDevice.
Reimplemented in VrpnDialDevice.
Definition at line 85 of file clientDialDevice.h.

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 ClientDialDevice::is_dial_known ( int index ) const [inline]

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

Definition at line 130 of file clientDialDevice.I.

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 ClientDevice::output ( ostream & out ) const [virtual, inherited]

Reimplemented in ClientButtonDevice.
Definition at line 147 of file clientDevice.cxx.

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.

void ClientDialDevice::push_dial ( int index,

double offset

) [inline]

Marks that the dial has been offset by the indicated amount.
It is the user's responsibility to ensure that this call is protected within lock().
Definition at line 79 of file clientDialDevice.I.
References _dials, and INLINE.

double ClientDialDevice::read_dial ( int index ) [inline]

Returns the number of complete revolutions of the dial since the last time read_dial() was called.
This is a destructive operation; it is not possible to read the dial without resetting the counter.
It is the user's responsibility to ensure that this call is protected within lock().
Definition at line 107 of file clientDialDevice.I.

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 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 ClientDevice::write ( ostream & out,

int indent_level = 0

) const [virtual, inherited]

Reimplemented in ClientAnalogDevice, and ClientButtonDevice.
Definition at line 159 of file clientDevice.cxx.

Member Data Documentation

Dials ClientDialDevice::_dials [protected]

Definition at line 78 of file clientDialDevice.h.
Referenced by ClientDialDevice(), get_num_dials(), and push_dial().

TypeHandle ClientDialDevice::_type_handle [static, private]

Reimplemented from ClientDevice.
Reimplemented in VrpnDialDevice.
Definition at line 27 of file clientDialDevice.cxx.

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

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

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

1.3

ClientDialDevice Class Reference

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation