clientDevice.cxx

Go to the documentation of this file.

/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file clientDevice.cxx
 * @author drose
 * @date 2001-01-25
 */

#include "clientDevice.h"
#include "clientBase.h"

#include "indent.h"

TypeHandle ClientDevice::_type_handle;

/**
 *
 */
ClientDevice::
ClientDevice(ClientBase *client, TypeHandle device_type,
             const std::string &device_name) :
  InputDevice(device_name, DeviceClass::unknown),
  _client(client),
  _device_type(device_type)
{
  // We have to explicitly ref the client pointer, since we can't use a
  // PT(ClientBase) for circular include reasons.
  _client->ref();
}

/**
 * We don't actually call disconnect() at the ClientDevice level destructor,
 * because by the time we get here we're already partly destructed.  Instead,
 * we should call disconnect() from each specific kind of derived class.
 */
ClientDevice::
~ClientDevice() {
  nassertv(!is_connected());

  // And now we explicitly unref the client pointer.
  unref_delete(_client);
}

/**
 * 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.
 */
void ClientDevice::
disconnect() {
  if (is_connected()) {
    bool disconnected =
      _client->disconnect_device(_device_type, get_name(), this);
    set_connected(false);
    nassertv(disconnected);
  }
}

/**
 * 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.
 */
void ClientDevice::
do_poll() {
  _client->poll();
}

/**
 *
 */
void ClientDevice::
output(std::ostream &out) const {
  out << get_type() << " " << get_name();
}

/**
 *
 */
void ClientDevice::
write(std::ostream &out, int indent_level) const {
  indent(out, indent_level) << *this << "\n";
}