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

VrpnTrackerDevice Class Reference

The Panda interface to a VRPN tracker. More...

#include <vrpnTrackerDevice.h>

Inheritance diagram for VrpnTrackerDevice:

ClientTrackerDevice ClientDevice TypedReferenceCount TypedObject ReferenceCount List of all members.

Public Types

enum  DataType { DT_position, DT_velocity, DT_acceleration }

Public Member Functions

 VrpnTrackerDevice (VrpnClient *client, const string &device_name, int sensor, DataType data_type, VrpnTracker *vrpn_tracker)
virtual ~VrpnTrackerDevice ()
int get_sensor () const
 Returns the particular sensor index that this device wants to hear about from the VrpnTracker.

DataType get_data_type () const
 Returns the type of data this device represents from the VrpnTracker.

VrpnTracker * get_vrpn_tracker () const
 Returns a pointer to the particular VrpnTracker this device gets its data from.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
const TrackerData & get_data () const
 Returns the TrackerData that this device is reporting.

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 Attributes

TrackerData _data

Private Attributes

int _sensor
DataType _data_type
VrpnTracker * _vrpn_tracker

Static Private Attributes

TypeHandle _type_handle

Friends

class VrpnTracker

Detailed Description

The Panda interface to a VRPN tracker.

This object will be returned by VrpnClient::make_device(), for attaching to a TrackerNode.

It represents the data from just one particular sensor of a named VRPN tracker, and may reflect either the sensor's position, its velocity, or its acceleration.

This class does not need to be exported from the DLL.

Definition at line 57 of file vrpnTrackerDevice.h.

Member Enumeration Documentation

enum VrpnTrackerDevice::DataType
 

Enumeration values:
DT_position 
DT_velocity 
DT_acceleration 

Definition at line 59 of file vrpnTrackerDevice.h.

Referenced by VrpnClient::do_poll(), and get_sensor().

Constructor & Destructor Documentation

VrpnTrackerDevice::VrpnTrackerDevice (  VrpnClient *  client,
const string &  device_name,
int  sensor,
VrpnTrackerDevice::DataType  data_type,
VrpnTracker *  vrpn_tracker
) 
 

Definition at line 35 of file vrpnTrackerDevice.cxx.

VrpnTrackerDevice::~VrpnTrackerDevice (   )  [virtual]
 

Definition at line 53 of file vrpnTrackerDevice.cxx.

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.

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

Reimplemented from ClientTrackerDevice.

Definition at line 91 of file vrpnTrackerDevice.h.

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

Reimplemented from ClientTrackerDevice.

Definition at line 80 of file vrpnTrackerDevice.h.

Referenced by PT().

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 TrackerData & ClientTrackerDevice::get_data (   )  const [inline, inherited]
 

Returns the TrackerData that this device is reporting.

Definition at line 47 of file clientTrackerDevice.I.

VrpnTrackerDevice::DataType VrpnTrackerDevice::get_data_type (   )  const [inline]
 

Returns the type of data this device represents from the VrpnTracker.

This may be position, velocity, or acceleration.

Definition at line 51 of file vrpnTrackerDevice.I.

References _vrpn_tracker, and INLINE.

Referenced by VrpnTracker::vrpn_position_callback(), and VrpnTracker::vrpn_velocity_callback().

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 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().

int VrpnTrackerDevice::get_sensor (   )  const [inline]
 

Returns the particular sensor index that this device wants to hear about from the VrpnTracker.

Definition at line 34 of file vrpnTrackerDevice.I.

References _data_type, DataType, and INLINE.

Referenced by VrpnTracker::vrpn_position_callback(), and VrpnTracker::vrpn_velocity_callback().

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

Reimplemented from ClientTrackerDevice.

Definition at line 88 of file vrpnTrackerDevice.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.

VrpnTracker * VrpnTrackerDevice::get_vrpn_tracker (   )  const [inline]
 

Returns a pointer to the particular VrpnTracker this device gets its data from.

This pointer may be shared with other VrpnTrackerDevice objects (each representing a different portion of the tracker data).

Definition at line 72 of file vrpnTrackerDevice.I.

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

Reimplemented from ClientTrackerDevice.

Definition at line 83 of file vrpnTrackerDevice.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 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 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.

Friends And Related Function Documentation

friend class VrpnTracker [friend]
 

Definition at line 96 of file vrpnTrackerDevice.h.

Member Data Documentation

TrackerData ClientTrackerDevice::_data [protected, inherited]
 

Definition at line 49 of file clientTrackerDevice.h.

Referenced by ClientTrackerDevice::ClientTrackerDevice(), VrpnTracker::vrpn_position_callback(), and VrpnTracker::vrpn_velocity_callback().

DataType VrpnTrackerDevice::_data_type [private]
 

Definition at line 76 of file vrpnTrackerDevice.h.

Referenced by get_sensor().

int VrpnTrackerDevice::_sensor [private]
 

Definition at line 75 of file vrpnTrackerDevice.h.

TypeHandle VrpnTrackerDevice::_type_handle [static, private]
 

Reimplemented from ClientTrackerDevice.

Definition at line 25 of file vrpnTrackerDevice.cxx.

VrpnTracker* VrpnTrackerDevice::_vrpn_tracker [private]
 

Definition at line 77 of file vrpnTrackerDevice.h.

Referenced by get_data_type().

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:56:14 2003 for Panda by doxygen1.3