historical/toontown-classic.git/panda/include/buttonNode.I
2024-01-16 11:20:27 -06:00

75 lines
2.3 KiB
Text

/**
* 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 buttonNode.I
* @author drose
* @date 2002-03-12
*/
/**
* Returns true if the ButtonNode is valid and connected to a server, false
* otherwise.
*/
INLINE bool ButtonNode::
is_valid() const {
return (_device != nullptr) && _device->is_connected();
}
/**
* Returns the number of buttons known to the ButtonNode. 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.
*/
INLINE int ButtonNode::
get_num_buttons() const {
return _device->get_num_buttons();
}
/**
* 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.
*/
INLINE void ButtonNode::
set_button_map(int index, ButtonHandle button) {
_device->map_button(index, button);
}
/**
* 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.
*/
INLINE ButtonHandle ButtonNode::
get_button_map(int index) const {
return _device->get_button_map(index);
}
/**
* 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.
*/
INLINE bool ButtonNode::
get_button_state(int index) const {
return _device->is_button_pressed(index);
}
/**
* Returns true if the state of the indicated button is known, or false if we
* have never heard anything about this particular button.
*/
INLINE bool ButtonNode::
is_button_known(int index) const {
return _device->is_button_known(index);
}