ButtonThrower

from panda3d.core import ButtonThrower

class ButtonThrower

Bases:

Bases: DataNode

Throws Panda Events for button down/up events generated within the data graph.

This is a DataNode which is intended to be parented to the data graph below a device which is generating a sequence of button events, like a MouseAndKeyboard device. It simply takes each button it finds and throws a corresponding event based on the button name via the throw_event() call.

Inheritance diagram

__init__(param0: ButtonThrower)

__init__(name: str)

addParameter(obj: EventParameter): Adds the indicated parameter to the list of parameters that will be passed with each event generated by this ButtonThrower.

addThrowButton(mods: ModifierButtons, button: ButtonHandle) → bool

Adds a new button to the set of buttons that the ButtonThrower explicitly processes.

If setThrowButtonsActive() is false (which is the default), the ButtonThrower will process all buttons. Otherwise, the ButtonThrower will only process events for the button(s) explicitly named by this function; buttons not on the list will be ignored by this object and passed on downstream to the child node(s) in the data graph. A button that is on the list will be processed by the ButtonThrower and not passed on to the child node(s).

The return value is true if the button is added, or false if it was already in the set.

property button_down_event → string

Getter

Returns the button_down_event that has been set on this ButtonThrower. See setButtonDownEvent().

Setter

Specifies the generic event that is generated (if any) each time a key or button is depressed. Unlike the specific events that are unique to each key, this same event name is used for all button events, and the name of the button pressed (possibly with modifier prefixes) will be sent as a parameter.

If this string is empty, no event is generated. It is possible to generate both generic events and specific events for the same button.

See also setKeystrokeEvent().

property button_repeat_event → string

Getter

Returns the button_repeat_event that has been set on this ButtonThrower. See setButtonRepeatEvent().

Setter

Specifies the generic event that is generated (if any) repeatedly while a key or button is held down. Unlike the specific events that are unique to each key, this same event name is used for all button events, and the name of the button pressed (possibly with modifier prefixes) will be sent as a parameter.

If this string is empty, no event is generated. It is possible to generate both generic events and specific events for the same button.

See also setKeystrokeEvent().

property button_up_event → string

Getter: Returns the button_up_event that has been set on this ButtonThrower. See setButtonUpEvent().
Setter: Specifies the generic event that is generated (if any) each time a key or button is released. See setButtonDownEvent().

property candidate_event → string

Getter

Returns the candidate_event that has been set on this ButtonThrower. See setCandidateEvent().

Setter

Specifies the event that is generated (if any) for each IME candidate string event received. Events of this nature are received only when the user is entering data using a Microsoft Input Method Editor, typically used for Asian languages such as Japanese or Korean.

If you are designing a typing user interface, you should track this event to support the use of the IME. In response to this event, you should display the candidate string in the entry box, with the appropriate sections highlighted, so the user can scroll through the available choices.

This event is generated with four parameters, in order: the candidate string, the character at which to start the highlight, the character at which to end the highlight, and the current cursor position.

clearThrowButtons(): Empties the set of buttons that were added via addThrowButton(). See addThrowButton().

getButtonDownEvent() → str: Returns the button_down_event that has been set on this ButtonThrower. See setButtonDownEvent().

getButtonRepeatEvent() → str: Returns the button_repeat_event that has been set on this ButtonThrower. See setButtonRepeatEvent().

getButtonUpEvent() → str: Returns the button_up_event that has been set on this ButtonThrower. See setButtonUpEvent().

getCandidateEvent() → str: Returns the candidate_event that has been set on this ButtonThrower. See setCandidateEvent().

static getClassType() → TypeHandle

getKeystrokeEvent() → str: Returns the keystroke_event that has been set on this ButtonThrower. See setKeystrokeEvent().

getModifierButtons() → ModifierButtons: Returns the set of ModifierButtons that the ButtonThrower will consider important enough to prepend the event name with. Normally, this set will be empty, and the ButtonThrower will therefore ignore all ModifierButtons attached to the key events, but if one or more buttons have been added to this set, and those modifier buttons are set on the button event, then the event name will be prepended with the names of the modifier buttons.

getMoveEvent() → str: Returns the move_event that has been set on this ButtonThrower. See setMoveEvent().

getNumParameters() → int: Returns the number of parameters that have been added to the list of parameters to be passed with each event generated by this ButtonThrower.

getParameter(n: int) → EventParameter: Returns the nth parameter that has been added to the list of parameters passed with each event generated by this ButtonThrower.

getParameters() → list

getPrefix() → str: Returns the prefix that has been set on this ButtonThrower. See setPrefix().

getRawButtonDownEvent() → str: Returns the raw_button_down_event that has been set on this ButtonThrower. See setRawButtonDownEvent().

getRawButtonUpEvent() → str: Returns the raw_button_up_event that has been set on this ButtonThrower. See setRawButtonUpEvent().

getSpecificFlag() → bool: Returns the flag that indicates whether specific events should be generated. See setSpecificFlag().

getThrowButtonsActive() → bool: Returns the flag that indicates whether the ButtonThrower will only process events for the explicitly named buttons or not. See setThrowButtonsActive().

getTimeFlag() → bool: Returns the flag that indicates whether the time of the button event should be passed as a parameter.

hasThrowButton(button: ButtonHandle) → bool: Returns true if the indicated button, in conjunction with any nonspecified modifier buttons, is on the set of buttons that will be processed by the ButtonThrower. That is to say, returns true if this button was ever passed as the second parameter addThrowButton(), regardless of what the first parameter was.

hasThrowButton(mods: ModifierButtons, button: ButtonHandle) → bool: Returns true if the indicated button is on the set of buttons that will be processed by the ButtonThrower, false otherwise. See addThrowButton().

property keystroke_event → string

Getter

Returns the keystroke_event that has been set on this ButtonThrower. See setKeystrokeEvent().

Setter

Specifies the event that is generated (if any) for each keystroke that is received. A keystroke is different than a button event: it represents the semantic meaning of the sequence of keys that have been pressed. For instance, pressing shift and 4 together will generate the button event “shift-4”, but it will generate the keystroke “$”.

If a key is held down, keyrepeat will cause the same keystroke event to be generated repeatedly. This is different from the corresponding down event, which will only be generated once, followed by a number of button repeat events.

This event is generated with a single wstring parameter, which is a one- character string that contains the keystroke generated. If this event string is empty, no event is generated.

See also setKeystrokeEvent().

setButtonRepeatEvent(button_repeat_event: str)

Specifies the generic event that is generated (if any) repeatedly while a key or button is held down. Unlike the specific events that are unique to each key, this same event name is used for all button events, and the name of the button pressed (possibly with modifier prefixes) will be sent as a parameter.

If this string is empty, no event is generated. It is possible to generate both generic events and specific events for the same button.

See also setKeystrokeEvent().

setButtonUpEvent(button_up_event: str): Specifies the generic event that is generated (if any) each time a key or button is released. See setButtonDownEvent().

setCandidateEvent(candidate_event: str)

Specifies the event that is generated (if any) for each IME candidate string event received. Events of this nature are received only when the user is entering data using a Microsoft Input Method Editor, typically used for Asian languages such as Japanese or Korean.

If you are designing a typing user interface, you should track this event to support the use of the IME. In response to this event, you should display the candidate string in the entry box, with the appropriate sections highlighted, so the user can scroll through the available choices.

This event is generated with four parameters, in order: the candidate string, the character at which to start the highlight, the character at which to end the highlight, and the current cursor position.

setKeystrokeEvent(keystroke_event: str)

Specifies the event that is generated (if any) for each keystroke that is received. A keystroke is different than a button event: it represents the semantic meaning of the sequence of keys that have been pressed. For instance, pressing shift and 4 together will generate the button event “shift-4”, but it will generate the keystroke “$”.

If a key is held down, keyrepeat will cause the same keystroke event to be generated repeatedly. This is different from the corresponding down event, which will only be generated once, followed by a number of button repeat events.

This event is generated with a single wstring parameter, which is a one- character string that contains the keystroke generated. If this event string is empty, no event is generated.