Panda3D
Public Member Functions | Static Public Member Functions

ClientBase Class Reference

An abstract base class for a family of client device interfaces--including trackers, buttons, dials, and other analog inputs. More...

Inheritance diagram for ClientBase:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase VrpnClient

List of all members.

Public Member Functions

bool forkAsynchronousThread (double poll_time)
 Forks a separate thread to do all the polling of connected devices.
CoordinateSystem getCoordinateSystem ()
 Returns the coordinate system that all devices associated with this client will operate in.
double getLastPollTime ()
 Returns the time (according to the global ClockObject's get_real_time() method) of the last device poll.
int getRefCount ()
 Returns the current reference count.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isForked ()
 Returns true if the ClientBase has been forked (and, therefore, poll() does not need to be called), false otherwise.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
bool poll ()
 Initiates a poll of the client devices, if we are not forked and if we have not already polled this frame.
 ref ()
 Explicitly increments the reference count.
 setCoordinateSystem (CoordinateSystem cs)
 Specifies the coordinate system that all devices associated with this client will operate in.
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unref ()
 Explicitly decrements the reference count.

Static Public Member Functions

static TypeHandle getClassType ()

Detailed Description

An abstract base class for a family of client device interfaces--including trackers, buttons, dials, and other analog inputs.

This provides a common interface to connect to such devices and extract their data; it is used by TrackerNode etc. to put these devices in the data graph.


Member Function Documentation

bool forkAsynchronousThread ( double  poll_time)

Forks a separate thread to do all the polling of connected devices.

The forked thread will poll after every poll_time seconds has elapsed. Returns true if the fork was successful, or false otherwise (for instance, because we were already forked, or because asynchronous threads are disabled).

static TypeHandle getClassType ( ) [static]

Reimplemented from TypedReferenceCount.

Reimplemented in VrpnClient.

CoordinateSystem getCoordinateSystem ( )

Returns the coordinate system that all devices associated with this client will operate in.

Normally, this is CS_default.

double getLastPollTime ( )

Returns the time (according to the global ClockObject's get_real_time() method) of the last device poll.

int getRefCount ( ) [inherited]

Returns the current reference count.

TypeHandle getType ( ) [inherited]

Reimplemented in AnimChannelBase.

int getTypeIndex ( ) [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().

bool isExactType ( TypeHandle  handle) [inherited]

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

bool isForked ( )

Returns true if the ClientBase has been forked (and, therefore, poll() does not need to be called), false otherwise.

bool isOfType ( TypeHandle  handle) [inherited]

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

bool poll ( )

Initiates a poll of the client devices, if we are not forked and if we have not already polled this frame.

Returns true if the poll occurred, or false if it did not.

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

setCoordinateSystem ( CoordinateSystem  cs)

Specifies the coordinate system that all devices associated with this client will operate in.

Normally, this is CS_default.

bool testRefCountIntegrity ( ) [inherited]

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

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

bool testRefCountNonzero ( ) [inherited]

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

Returns true if ok, false otherwise.

bool unref ( ) [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.) 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 true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties