Panda3D
Classes | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends

ClientButtonDevice Class Reference

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

#include "clientButtonDevice.h"

Inheritance diagram for ClientButtonDevice:
ClientDevice TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase VrpnButtonDevice

List of all members.

Classes

class  ButtonState

Public Member Functions

void acquire ()
 Grabs the mutex associated with this particular device.
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
void disconnect ()
 Disconnects the ClientDevice from its ClientBase object.
virtual TypeHandle force_init_type ()
int get_best_parent_from_Set (const std::set< int > &) const
ButtonEventListget_button_events () const
 Returns the list of recently-generated ButtonEvents.
ButtonHandle get_button_map (int index) const
 Returns the ButtonHandle that was previously associated with the given index number by a call to set_button_map(), or ButtonHandle::none() if no button was associated.
bool get_button_state (int index) const
 Returns true if the indicated button (identified by its index number) is currently known to be down, or false if it is up or unknown.
ClientBaseget_client () const
 Returns the ClientBase this device is associated with.
const string & get_device_name () const
 Returns the device name reported to the ClientBase.
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.
int get_num_buttons () const
 Returns the number of buttons known to the ClientButtonDevice.
int get_ref_count () const
 Returns the current reference count.
virtual TypeHandle get_type () const
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
bool is_button_known (int index) const
 Returns true if the state of the indicated button is known, or false if we have never heard anything about this particular button.
bool is_connected () const
 Returns true if the device is still connected to its ClientBase, false otherwise.
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
virtual void output (ostream &out) const
void output_buttons (ostream &out) const
 Writes a one-line string of all of the current button states.
void poll ()
 Causes the connected ClientBase to poll all of its clients, if necessary.
void ref () const
 Explicitly increments the reference count.
void set_button_map (int index, ButtonHandle button)
 Associates the indicated ButtonHandle with the button of the indicated index number.
void set_button_state (int index, bool down)
 Sets the state of the indicated button index, where true indicates down, and false indicates up.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
void unlock ()
 Releases the mutex associated with this particular device.
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.
virtual void write (ostream &out, int indent_level=0) const
void write_buttons (ostream &out, int indent_level) const
 Writes a multi-line description of the current button states.

Static Public Member Functions

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.

Protected Types

typedef pvector< ButtonStateButtons
enum  State { S_unknown, S_up, S_down }

Protected Member Functions

 ClientButtonDevice (ClientBase *client, const string &device_name)
bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.
 PT (ButtonEventList) _button_events

Protected Attributes

Buttons _buttons

Friends

class ButtonState

Detailed Description

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

The named device can contain any number of up/down style buttons, numbered in sequence beginning at zero; these are mapped by this class to a sequence of ButtonHandles specified by the user.

Definition at line 37 of file clientButtonDevice.h.


Member Function Documentation

void ClientDevice::acquire ( ) [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 76 of file clientDevice.I.

Referenced by ClientDevice::disconnect().

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 110 of file typedObject.I.

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 74 of file clientDevice.cxx.

References ClientDevice::acquire(), ClientBase::disconnect_device(), and ClientDevice::unlock().

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, 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.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

ButtonEventList * ClientButtonDevice::get_button_events ( ) const [inline]

Returns the list of recently-generated ButtonEvents.

This must be periodically cleared, or the buttons will accumulate.

Definition at line 122 of file clientButtonDevice.I.

ButtonHandle ClientButtonDevice::get_button_map ( int  index) const [inline]

Returns the ButtonHandle that was previously associated with the given index number by a call to set_button_map(), or ButtonHandle::none() if no button was associated.

Definition at line 74 of file clientButtonDevice.I.

References ButtonHandle::none().

bool ClientButtonDevice::get_button_state ( int  index) const [inline]

Returns true if the indicated button (identified by its index number) is currently known to be down, or false if it is up or unknown.

Definition at line 90 of file clientButtonDevice.I.

ClientBase * ClientDevice::get_client ( ) const [inline, inherited]

Returns the ClientBase this device is associated with.

Definition at line 23 of file clientDevice.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 62 of file clientDevice.I.

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 50 of file clientDevice.I.

int ClientButtonDevice::get_num_buttons ( ) const [inline]

Returns the number of buttons known to the ClientButtonDevice.

This includes those buttons whose state has been seen, as well as buttons that have been associated with a ButtonHandle even if their state is unknown. This number may change as more buttons are discovered.

Definition at line 40 of file clientButtonDevice.I.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
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 52 of file typedObject.I.

References TypeHandle::get_index().

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

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

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from ClientDevice.

Reimplemented in VrpnButtonDevice.

Definition at line 86 of file clientButtonDevice.h.

References ClientDevice::init_type().

bool ClientButtonDevice::is_button_known ( int  index) const [inline]

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

Definition at line 106 of file clientButtonDevice.I.

bool ClientDevice::is_connected ( ) const [inline, inherited]

Returns true if the device is still connected to its ClientBase, false otherwise.

Definition at line 34 of file clientDevice.I.

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
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 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void ClientButtonDevice::output_buttons ( ostream &  out) const

Writes a one-line string of all of the current button states.

Definition at line 104 of file clientButtonDevice.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 97 of file clientDevice.cxx.

References ClientBase::poll().

void 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.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void ClientButtonDevice::set_button_map ( int  index,
ButtonHandle  button 
) [inline]

Associates the indicated ButtonHandle with the button of the indicated index number.

When the given button index changes state, a corresponding ButtonEvent will be generated with the given ButtonHandle. Pass ButtonHandle::none() to turn off any association.

It is not necessary to call this if you simply want to query the state of the various buttons by index number; this is only necessary in order to generate ButtonEvents when the buttons change state.

Definition at line 59 of file clientButtonDevice.I.

void ClientButtonDevice::set_button_state ( int  index,
bool  down 
)

Sets the state of the indicated button index, where true indicates down, and false indicates up.

This may generate a ButtonEvent if the button has an associated ButtonHandle. The caller should ensure that acquire() is in effect while this call is made.

Definition at line 45 of file clientButtonDevice.cxx.

References ButtonHandle::none().

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

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

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

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

Definition at line 90 of file clientDevice.I.

Referenced by ClientDevice::disconnect().

bool ReferenceCount::unref ( ) const [inline, virtual, 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, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().

void ClientButtonDevice::write_buttons ( ostream &  out,
int  indent_level 
) const

Writes a multi-line description of the current button states.

Definition at line 135 of file clientButtonDevice.cxx.

References ButtonHandle::none().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations