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

This class is just used as a convenient namespace for grouping all of these handy functions that return buttons which map to standard mouse buttons. More...

Public Member Functions

 __init__ ()
 
 __init__ (const MouseButton)
 

Static Public Member Functions

static ButtonHandle button (int button_number)
 Returns the ButtonHandle associated with the particular numbered mouse button (zero-based), if there is one, or ButtonHandle::none() if there is not. More...
 
static ButtonHandle five ()
 Returns the ButtonHandle associated with the fifth mouse button. More...
 
static ButtonHandle four ()
 Returns the ButtonHandle associated with the fourth mouse button. More...
 
static bool isMouseButton (ButtonHandle button)
 Returns true if the indicated ButtonHandle is a mouse button, false if it is some other kind of button. More...
 
static ButtonHandle one ()
 Returns the ButtonHandle associated with the first mouse button. More...
 
static ButtonHandle three ()
 Returns the ButtonHandle associated with the third mouse button. More...
 
static ButtonHandle two ()
 Returns the ButtonHandle associated with the second mouse button. More...
 
static ButtonHandle wheelDown ()
 Returns the ButtonHandle generated when the mouse wheel is rolled one notch downwards. More...
 
static ButtonHandle wheelLeft ()
 Returns the ButtonHandle generated when the mouse is scrolled to the left. More...
 
static ButtonHandle wheelRight ()
 Returns the ButtonHandle generated when the mouse is scrolled to the right. More...
 
static ButtonHandle wheelUp ()
 Returns the ButtonHandle generated when the mouse wheel is rolled one notch upwards. More...
 

Detailed Description

This class is just used as a convenient namespace for grouping all of these handy functions that return buttons which map to standard mouse buttons.

Member Function Documentation

◆ __init__() [1/2]

__init__ ( )

◆ __init__() [2/2]

__init__ ( const  MouseButton)

◆ button()

static ButtonHandle button ( int  button_number)
static

Returns the ButtonHandle associated with the particular numbered mouse button (zero-based), if there is one, or ButtonHandle::none() if there is not.

◆ five()

static ButtonHandle five ( )
static

Returns the ButtonHandle associated with the fifth mouse button.

◆ four()

static ButtonHandle four ( )
static

Returns the ButtonHandle associated with the fourth mouse button.

◆ isMouseButton()

static bool isMouseButton ( ButtonHandle  button)
static

Returns true if the indicated ButtonHandle is a mouse button, false if it is some other kind of button.

◆ one()

static ButtonHandle one ( )
static

Returns the ButtonHandle associated with the first mouse button.

◆ three()

static ButtonHandle three ( )
static

Returns the ButtonHandle associated with the third mouse button.

◆ two()

static ButtonHandle two ( )
static

Returns the ButtonHandle associated with the second mouse button.

◆ wheelDown()

static ButtonHandle wheelDown ( )
static

Returns the ButtonHandle generated when the mouse wheel is rolled one notch downwards.

◆ wheelLeft()

static ButtonHandle wheelLeft ( )
static

Returns the ButtonHandle generated when the mouse is scrolled to the left.

Usually, you'll only find the horizontal scroll on laptops.

◆ wheelRight()

static ButtonHandle wheelRight ( )
static

Returns the ButtonHandle generated when the mouse is scrolled to the right.

Usually, you'll only find the horizontal scroll on laptops.

◆ wheelUp()

static ButtonHandle wheelUp ( )
static

Returns the ButtonHandle generated when the mouse wheel is rolled one notch upwards.