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

ClientAnalogDevice Class Reference

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

#include <clientAnalogDevice.h>

Inheritance diagram for ClientAnalogDevice:


Public Member Functions
int	get_num_controls () const
	Returns the number of analog controls known to the ClientAnalogDevice.
void	set_control_state (int index, double state)
	Sets the state of the indicated analog index.
double	get_control_state (int index) const
	Returns the current position of indicated analog control (identified by its index number), or 0.0 if the control is unknown.
bool	is_control_known (int index) const
	Returns true if the state of the indicated analog control is known, or false if we have never heard anything about this particular control.
virtual void	write (ostream &out, int indent_level=0) const
void	write_controls (ostream &out, int indent_level) const
	Writes a multi-line description of the current analog control 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.
virtual void	output (ostream &out) 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< AnalogState >	Controls
Protected Member Functions
	ClientAnalogDevice (ClientBase *client, const string &device_name)
Protected Attributes
Controls	_controls
Private Member Functions
void	ensure_control_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 AnalogNode, that records the data from a single named analog device.

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

Each analog control returns a value ranging from -1 to 1, reflecting the current position of the control within its total range of motion.

Definition at line 52 of file clientAnalogDevice.h.

Member Typedef Documentation

typedef pvector<AnalogState> ClientAnalogDevice::Controls [protected]

Definition at line 78 of file clientAnalogDevice.h.

Constructor & Destructor Documentation

ClientAnalogDevice::ClientAnalogDevice ( ClientBase * client,

const string & device_name

) [inline, protected]

Definition at line 45 of file clientAnalogDevice.I.
References _controls, 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 ClientAnalogDevice::ensure_control_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 clientAnalogDevice.cxx.
References ClientDevice::get_device_name(), get_type(), indent(), and write_controls().
Referenced by get_num_controls().

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

Reimplemented from ClientDevice.
Reimplemented in VrpnAnalogDevice.
Definition at line 94 of file clientAnalogDevice.h.

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

Reimplemented from ClientDevice.
Reimplemented in VrpnAnalogDevice.
Definition at line 83 of file clientAnalogDevice.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.

double ClientAnalogDevice::get_control_state ( int index ) const [inline]

Returns the current position of indicated analog control (identified by its index number), or 0.0 if the control is unknown.
The normal range of a single control is -1.0 to 1.0.
Definition at line 106 of file clientAnalogDevice.I.

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 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 ClientAnalogDevice::get_num_controls ( ) const [inline]

Returns the number of analog controls known to the ClientAnalogDevice.
This number may change as more controls are discovered.
Definition at line 63 of file clientAnalogDevice.I.
References _controls, ensure_control_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 ClientAnalogDevice::get_type ( void ) const [inline, virtual]

Reimplemented from ClientDevice.
Reimplemented in VrpnAnalogDevice.
Definition at line 91 of file clientAnalogDevice.h.
Referenced by ensure_control_index().

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 ClientAnalogDevice::init_type ( void ) [inline, static]

Reimplemented from ClientDevice.
Reimplemented in VrpnAnalogDevice.
Definition at line 86 of file clientAnalogDevice.h.
Referenced by ConfigureFn().

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

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

Definition at line 127 of file clientAnalogDevice.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.

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 ClientAnalogDevice::set_control_state ( int index,

double state

) [inline]

Sets the state of the indicated analog index.
The caller should ensure that lock() is in effect while this call is made. This should be a number in the range -1.0 to 1.0, representing the current position of the control within its total range of movement.
Definition at line 84 of file clientAnalogDevice.I.

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

int indent_level = 0

) const [virtual]

Reimplemented from ClientDevice.
Definition at line 61 of file clientAnalogDevice.cxx.
References _controls, ClientAnalogDevice::AnalogState::_known, ClientAnalogDevice::AnalogState::_state, and indent().

void ClientAnalogDevice::write_controls ( ostream & out,

int indent_level

) const

Writes a multi-line description of the current analog control states.

Definition at line 77 of file clientAnalogDevice.cxx.
Referenced by ensure_control_index().

Member Data Documentation

Controls ClientAnalogDevice::_controls [protected]

Definition at line 79 of file clientAnalogDevice.h.
Referenced by ClientAnalogDevice(), get_num_controls(), and write().

TypeHandle ClientAnalogDevice::_type_handle [static, private]

Reimplemented from ClientDevice.
Reimplemented in VrpnAnalogDevice.
Definition at line 27 of file clientAnalogDevice.cxx.

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

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

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

1.3

ClientAnalogDevice 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