Panda3D
Public Member Functions | Static Public Member Functions | List of all members
ButtonMap Class Reference

This class represents a map containing all of the buttons of a (keyboard) device, though it can also be used as a generic mapping between ButtonHandles. More...

Inheritance diagram for ButtonMap:
TypedReferenceCount TypedObject ReferenceCount

Public Member Functions

 __init__ ()
 
 __init__ (const ButtonMap)
 
ButtonHandle getMappedButton (ButtonHandle raw)
 Returns the button that the given button is mapped to, or ButtonHandle::none() if this map does not specify a mapped button for the given raw button. More...
 
ButtonHandle getMappedButton (int i)
 Returns the nth mapped button, meaning the button that the nth raw button is mapped to. More...
 
ButtonHandle getMappedButton (str raw_name)
 Returns the button that the given button is mapped to, or ButtonHandle::none() if this map does not specify a mapped button for the given raw button. More...
 
str getMappedButtonLabel (ButtonHandle raw)
 If the button map specifies a special name for the button (eg. More...
 
str getMappedButtonLabel (int i)
 Returns the label associated with the nth mapped button, meaning the button that the nth raw button is mapped to. More...
 
str getMappedButtonLabel (str raw_name)
 If the button map specifies a special name for the button (eg. More...
 
int getNumButtons ()
 Returns the number of buttons that this button mapping specifies. More...
 
ButtonHandle getRawButton (int i)
 Returns the underlying raw button associated with the nth button. More...
 
 output (Ostream out)
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

This class represents a map containing all of the buttons of a (keyboard) device, though it can also be used as a generic mapping between ButtonHandles.

It maps an underlying 'raw' button to a 'virtual' button, which may optionally be associated with an appropriate platform-specific name for the button.

Member Function Documentation

◆ __init__() [1/2]

__init__ ( )

◆ __init__() [2/2]

__init__ ( const  ButtonMap)

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getMappedButton() [1/3]

ButtonHandle getMappedButton ( ButtonHandle  raw)

Returns the button that the given button is mapped to, or ButtonHandle::none() if this map does not specify a mapped button for the given raw button.

◆ getMappedButton() [2/3]

ButtonHandle getMappedButton ( int  i)

Returns the nth mapped button, meaning the button that the nth raw button is mapped to.

◆ getMappedButton() [3/3]

ButtonHandle getMappedButton ( str  raw_name)

Returns the button that the given button is mapped to, or ButtonHandle::none() if this map does not specify a mapped button for the given raw button.

◆ getMappedButtonLabel() [1/3]

str getMappedButtonLabel ( ButtonHandle  raw)

If the button map specifies a special name for the button (eg.

if the operating system or keyboard device has a localized name describing the key), returns it, or the empty string otherwise.

Note that this is not the same as get_mapped_button().get_name(), which returns the name of the Panda event associated with the button.

◆ getMappedButtonLabel() [2/3]

str getMappedButtonLabel ( int  i)

Returns the label associated with the nth mapped button, meaning the button that the nth raw button is mapped to.

◆ getMappedButtonLabel() [3/3]

str getMappedButtonLabel ( str  raw_name)

If the button map specifies a special name for the button (eg.

if the operating system or keyboard device has a localized name describing the key), returns it, or the empty string otherwise.

Note that this is not the same as get_mapped_button().get_name(), which returns the name of the Panda event associated with the button.

◆ getNumButtons()

int getNumButtons ( )

Returns the number of buttons that this button mapping specifies.

◆ getRawButton()

ButtonHandle getRawButton ( int  i)

Returns the underlying raw button associated with the nth button.

◆ output()

output ( Ostream  out)

◆ write()

write ( Ostream  out,
int  indent_level 
)