Panda3D
Classes | Public Member Functions | Static Public Member Functions | List of all 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:
ClientDevice TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase VrpnAnalogDevice

Public Member Functions

virtual TypeHandle force_init_type ()
 
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. More...
 
int get_num_controls () const
 Returns the number of analog controls known to the ClientAnalogDevice. More...
 
virtual TypeHandle get_type () const
 
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. More...
 
void set_control_state (int index, double state)
 Sets the state of the indicated analog index. More...
 
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. More...
 
- Public Member Functions inherited from ClientDevice
virtual ~ClientDevice ()
 We don't actually call disconnect() at the ClientDevice level destructor, because by the time we get here we're already partly destructed. More...
 
void acquire ()
 Grabs the mutex associated with this particular device. More...
 
void disconnect ()
 Disconnects the ClientDevice from its ClientBase object. More...
 
ClientBaseget_client () const
 Returns the ClientBase this device is associated with. More...
 
const string & get_device_name () const
 Returns the device name reported to the ClientBase. More...
 
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. More...
 
bool is_connected () const
 Returns true if the device is still connected to its ClientBase, false otherwise. More...
 
virtual void output (ostream &out) const
 
void poll ()
 Causes the connected ClientBase to poll all of its clients, if necessary. More...
 
void unlock ()
 Releases the mutex associated with this particular device. More...
 
- Public Member Functions inherited from TypedReferenceCount
 TypedReferenceCount (const TypedReferenceCount &copy)
 
void operator= (const TypedReferenceCount &copy)
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from ClientDevice
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
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. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

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 34 of file clientAnalogDevice.h.

Member Function Documentation

◆ get_control_state()

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 77 of file clientAnalogDevice.I.

References is_control_known().

Referenced by set_control_state(), and VrpnAnalog::unmark().

◆ get_num_controls()

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 47 of file clientAnalogDevice.I.

References set_control_state().

◆ is_control_known()

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 93 of file clientAnalogDevice.I.

Referenced by get_control_state().

◆ set_control_state()

void ClientAnalogDevice::set_control_state ( int  index,
double  state 
)
inline

Sets the state of the indicated analog index.

The caller should ensure that acquire() 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 61 of file clientAnalogDevice.I.

References get_control_state().

Referenced by get_num_controls(), and VrpnAnalog::unmark().

◆ write_controls()

void ClientAnalogDevice::write_controls ( ostream &  out,
int  indent_level 
) const

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

Definition at line 59 of file clientAnalogDevice.cxx.


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