Panda3D
|
Throws Panda Events for button down/up events generated within the data graph. More...
Public Member Functions | |
__init__ (str name) | |
addParameter (const EventParameter obj) | |
Adds the indicated parameter to the list of parameters that will be passed with each event generated by this ButtonThrower. More... | |
bool | addThrowButton (const ModifierButtons mods, const ButtonHandle button) |
Adds a new button to the set of buttons that the ButtonThrower explicitly processes. More... | |
clearThrowButtons () | |
Empties the set of buttons that were added via add_throw_button(). See add_throw_button(). More... | |
str | getButtonDownEvent () |
Returns the button_down_event that has been set on this ButtonThrower. See set_button_down_event(). More... | |
str | getButtonRepeatEvent () |
Returns the button_repeat_event that has been set on this ButtonThrower. See set_button_repeat_event(). More... | |
str | getButtonUpEvent () |
Returns the button_up_event that has been set on this ButtonThrower. See set_button_up_event(). More... | |
str | getCandidateEvent () |
Returns the candidate_event that has been set on this ButtonThrower. See set_candidate_event(). More... | |
str | getKeystrokeEvent () |
Returns the keystroke_event that has been set on this ButtonThrower. See set_keystroke_event(). More... | |
const ModifierButtons | getModifierButtons () |
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. More... | |
str | getMoveEvent () |
Returns the move_event that has been set on this ButtonThrower. See set_move_event(). More... | |
int | getNumParameters () |
Returns the number of parameters that have been added to the list of parameters to be passed with each event generated by this ButtonThrower. More... | |
EventParameter | getParameter (int n) |
Returns the nth parameter that has been added to the list of parameters passed with each event generated by this ButtonThrower. More... | |
list | getParameters () |
str | getPrefix () |
Returns the prefix that has been set on this ButtonThrower. See set_prefix(). More... | |
str | getRawButtonDownEvent () |
Returns the raw_button_down_event that has been set on this ButtonThrower. See set_raw_button_down_event(). More... | |
str | getRawButtonUpEvent () |
Returns the raw_button_up_event that has been set on this ButtonThrower. See set_raw_button_up_event(). More... | |
bool | getSpecificFlag () |
Returns the flag that indicates whether specific events should be generated. See set_specific_flag(). More... | |
bool | getThrowButtonsActive () |
Returns the flag that indicates whether the ButtonThrower will only process events for the explicitly named buttons or not. See set_throw_buttons_active(). More... | |
bool | getTimeFlag () |
Returns the flag that indicates whether the time of the button event should be passed as a parameter. More... | |
bool | hasThrowButton (const ButtonHandle button) |
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 add_throw_button(), regardless of what the first parameter was. More... | |
bool | hasThrowButton (const ModifierButtons mods, const ButtonHandle button) |
Returns true if the indicated button is on the set of buttons that will be processed by the ButtonThrower, false otherwise. See add_throw_button(). More... | |
bool | removeThrowButton (const ModifierButtons mods, const ButtonHandle button) |
Removes the indicated button from the set of buttons that the ButtonThrower explicitly processes. See add_throw_button(). More... | |
setButtonDownEvent (str button_down_event) | |
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. More... | |
setButtonRepeatEvent (str button_repeat_event) | |
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. More... | |
setButtonUpEvent (str button_up_event) | |
Specifies the generic event that is generated (if any) each time a key or button is released. See set_button_down_event(). More... | |
setCandidateEvent (str candidate_event) | |
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. More... | |
setKeystrokeEvent (str keystroke_event) | |
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 "$". More... | |
setModifierButtons (const ModifierButtons mods) | |
Changes 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, then the event name will be prepended with the names of the modifier buttons. More... | |
setMoveEvent (str move_event) | |
Specifies the event that is generated (if any) each time the mouse is moved within the window. More... | |
setPrefix (str prefix) | |
Sets the prefix which is prepended to all specific event names (that is, event names generated from the button name itself, as opposed to the generic event names like set_button_down_event) thrown by this object. More... | |
setRawButtonDownEvent (str raw_button_down_event) | |
Like set_button_down_event, but uses the raw, untransformed scan key from the operating system. This uses buttons that are independent of the user's selected keyboard layout. More... | |
setRawButtonUpEvent (str raw_button_up_event) | |
Specifies the generic event that is generated (if any) each time a key or button is released. See set_raw_button_down_event(). More... | |
setSpecificFlag (bool specific_flag) | |
Sets the flag that indicates whether specific events (events prefixed by set_prefix, and based on the event name) should be generated at all. This is true by default, but may be disabled if you are only interested in the generic events (for instance, events like set_button_down_event). More... | |
setThrowButtonsActive (bool flag) | |
Sets the flag that indicates whether the ButtonThrower will only process events for the explicitly named buttons or not. Normally this is false, meaning all buttons are processed; set it true to indicate that only some buttons should be processed. See add_throw_button(). More... | |
setTimeFlag (bool time_flag) | |
Sets the flag that indicates whether the time of the button event should be passed as a parameter or not. When this is true, an additional parameter is generated on each event (before all the parameters named by add_parameter) that consists of a single double value, and reflects the time the button was pressed or released, as a value from ClockObject::get_global_clock(). More... | |
![]() | |
__init__ (str name) | |
writeConnections (Ostream out) | |
Writes to the indicated ostream a list of all the connections currently showing between this DataNode and its parent(s). More... | |
writeInputs (Ostream out) | |
Writes to the indicated ostream a list of all the inputs this DataNode might expect to receive. More... | |
writeOutputs (Ostream out) | |
Writes to the indicated ostream a list of all the outputs this DataNode might generate. More... | |
![]() | |
PandaNode | __copy__ () |
object | __deepcopy__ (object memo) |
__init__ (str name) | |
addChild (PandaNode child_node, int sort, Thread current_thread) | |
Adds a new child to the node. The child is added in the relative position indicated by sort; if all children have the same sort index, the child is added at the end. More... | |
addStashed (PandaNode child_node, int sort, Thread current_thread) | |
Adds a new child to the node, directly as a stashed child. The child is not added in the normal sense, but will be revealed if unstash_child() is called on it later. More... | |
adjustDrawMask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask) | |
Adjusts the hide/show bits of this particular node. More... | |
Light | asLight () |
Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More... | |
clearAttrib (TypeHandle type) | |
Removes the render attribute of the given type from this node. This node, and the subgraph below, will now inherit the indicated render attribute from the nodes above this one. More... | |
clearAttrib (int slot) | |
Removes the render attribute of the given type from this node. This node, and the subgraph below, will now inherit the indicated render attribute from the nodes above this one. More... | |
clearBounds () | |
Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More... | |
clearEffect (TypeHandle type) | |
Removes the render effect of the given type from this node. More... | |
clearEffects (Thread current_thread) | |
Resets this node to have no render effects. More... | |
clearPythonTag (str key) | |
clearState (Thread current_thread) | |
Resets this node to leave the render state alone. Nodes at this level and below will once again inherit their render state unchanged from the nodes above this level. More... | |
clearTag (str key, Thread current_thread) | |
Removes the value defined for this key on this particular node. After a call to clear_tag(), has_tag() will return false for the indicated key. More... | |
clearTransform (Thread current_thread) | |
Resets the transform on this node to the identity transform. More... | |
clearUnexpectedChange (unsigned int flags) | |
Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. See set_unexpected_change(). More... | |
PandaNode | combineWith (PandaNode other) |
Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More... | |
int | compareTags (const PandaNode other) |
Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. If this returns 0, the tags are identical. If it returns other than 0, then the tags are different; and the nodes may be sorted into a consistent (but arbitrary) ordering based on this number. More... | |
copyAllProperties (PandaNode other) | |
Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. Typically this is used to prepare a node to replace another node in the scene graph (also see replace_node()). More... | |
copyChildren (PandaNode other, Thread current_thread) | |
Makes another instance of all the children of the other node, copying them to this node. More... | |
PandaNode | copySubgraph (Thread current_thread) |
Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. Some data may still be shared from the original (e.g. vertex index tables), but nothing that will impede normal use of the PandaNode. More... | |
copyTags (PandaNode other) | |
Copies all of the tags stored on the other node onto this node. If a particular tag exists on both nodes, the contents of this node's value is replaced by that of the other. More... | |
int | countNumDescendants () |
Returns the number of nodes at and below this level. More... | |
int | findChild (PandaNode node, Thread current_thread) |
Returns the index of the indicated child node, if it is a child, or -1 if it is not. More... | |
int | findParent (PandaNode node, Thread current_thread) |
Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More... | |
int | findStashed (PandaNode node, Thread current_thread) |
Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More... | |
const RenderAttrib | getAttrib (TypeHandle type) |
Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. This checks only what is set on this particular node level, and has nothing to do with what render attributes may be inherited from parent nodes. More... | |
const RenderAttrib | getAttrib (int slot) |
Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. This checks only what is set on this particular node level, and has nothing to do with what render attributes may be inherited from parent nodes. More... | |
const BoundingVolume | getBounds (Thread current_thread) |
Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes. More... | |
const BoundingVolume | getBounds (UpdateSeq seq, Thread current_thread) |
This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. When this sequence number changes, it indicates that the bounding volume might have changed, e.g. because some nested child's bounding volume has changed. More... | |
BoundingVolume::BoundsType | getBoundsType () |
Returns the bounding volume type set with set_bounds_type(). More... | |
PandaNode | getChild (int n, Thread current_thread) |
Returns the nth child node of this node. See get_num_children(). Also see get_children(), if your intention is to iterate through the complete list of children; get_children() is preferable in this case. More... | |
list | getChildren () |
int | getChildSort (int n, Thread current_thread) |
Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). See get_num_children(). More... | |
DrawMask | getDrawControlMask () |
Returns the set of bits in draw_show_mask that are considered meaningful. See adjust_draw_mask(). More... | |
DrawMask | getDrawShowMask () |
Returns the hide/show bits of this particular node. See adjust_draw_mask(). More... | |
const RenderEffect | getEffect (TypeHandle type) |
Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. More... | |
const RenderEffects | getEffects (Thread current_thread) |
Returns the complete RenderEffects that will be applied to this node. More... | |
int | getFancyBits (Thread current_thread) |
Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. If this returns 0, the node has nothing interesting about it. This is intended to speed traversal by quickly skipping past nodes that don't particularly affect the render state. More... | |
const BoundingVolume | getInternalBounds (Thread current_thread) |
Returns the node's internal bounding volume. This is the bounding volume around the node alone, without including children. If the user has called set_bounds(), it will be the specified bounding volume. More... | |
int | getInternalVertices (Thread current_thread) |
Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More... | |
CollideMask | getIntoCollideMask () |
Returns the "into" collide mask for this node. More... | |
CollideMask | getLegalCollideMask () |
Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. For most nodes, this is 0; it doesn't make sense to set a CollideMask for most kinds of nodes. More... | |
int | getNestedVertices (Thread current_thread) |
Returns the total number of vertices that will be rendered by this node and all of its descendents. More... | |
CollideMask | getNetCollideMask (Thread current_thread) |
Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More... | |
DrawMask | getNetDrawControlMask () |
Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More... | |
DrawMask | getNetDrawShowMask () |
Returns the union of all draw_show_mask values–of renderable nodes only–at this level and below. If any bit in this mask is 0, there is no reason to traverse below this node for a camera with the corresponding camera_mask. More... | |
int | getNumChildren (Thread current_thread) |
Returns the number of child nodes this node has. The order of the child nodes is meaningful and is based on the sort number that was passed to add_child(), and also on the order in which the nodes were added. More... | |
int | getNumParents (Thread current_thread) |
Returns the number of parent nodes this node has. If this number is greater than 1, the node has been multiply instanced. The order of the parent nodes is not meaningful and is not related to the order in which the node was instanced to them. More... | |
int | getNumStashed (Thread current_thread) |
Returns the number of stashed nodes this node has. These are former children of the node that have been moved to the special stashed list via stash_child(). More... | |
const RenderAttrib | getOffClipPlanes (Thread current_thread) |
Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below. More... | |
PandaNode | getParent (int n, Thread current_thread) |
Returns the nth parent node of this node. See get_num_parents(). Also see get_parents(), if your intention is to iterate through the complete list of parents; get_parents() is preferable in this case. More... | |
list | getParents () |
const TransformState | getPrevTransform (Thread current_thread) |
Returns the transform that has been set as this node's "previous" position. See set_prev_transform(). More... | |
object | getPythonTag (str key) |
object | getPythonTagKeys () |
getPythonTagKeys (VectorString keys) | |
PandaNode | getStashed (int n, Thread current_thread) |
Returns the nth stashed child of this node. See get_num_stashed(). Also see get_stashed(), if your intention is to iterate through the complete list of stashed children; get_stashed() is preferable in this case. More... | |
list | getStashed () |
int | getStashedSort (int n, Thread current_thread) |
Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). See get_num_stashed(). More... | |
const RenderState | getState (Thread current_thread) |
Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. This returns only the RenderState set on this particular node, and has nothing to do with state that might be inherited from above. More... | |
str | getTag (str key, Thread current_thread) |
Retrieves the user-defined value that was previously set on this node for the particular key, if any. If no value has been previously set, returns the empty string. More... | |
object | getTagKeys () |
getTagKeys (VectorString keys) | |
Fills the given vector up with the list of tags on this PandaNode. More... | |
const TransformState | getTransform (Thread current_thread) |
Returns the transform that has been set on this particular node. This is not the net transform from the root, but simply the transform on this particular node. More... | |
unsigned int | getUnexpectedChange (unsigned int flags) |
Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More specifically, this returns the particular set of bits (masked by the input parameter) that have been set on this node. See set_unexpected_change(). More... | |
bool | hasAttrib (TypeHandle type) |
Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More... | |
bool | hasAttrib (int slot) |
Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More... | |
bool | hasDirtyPrevTransform () |
Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0). In this case, the node will be visited by reset_prev_transform(). More... | |
bool | hasEffect (TypeHandle type) |
Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More... | |
bool | hasPythonTag (str key) |
bool | hasTag (str key, Thread current_thread) |
Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set. More... | |
bool | hasTags () |
Returns true if the node has any tags (or any Python tags) at all, false if it has none. More... | |
bool | isAmbientLight () |
Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More... | |
bool | isBoundsStale () |
Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More... | |
bool | isCollisionNode () |
A simple downcast check. Returns true if this kind of node happens to inherit from CollisionNode, false otherwise. More... | |
bool | isFinal (Thread current_thread) |
Returns the current state of the "final" flag. Initially, this flag is off (false), but it may be changed by an explicit call to set_final(). See set_final(). More... | |
bool | isGeomNode () |
A simple downcast check. Returns true if this kind of node happens to inherit from GeomNode, false otherwise. More... | |
bool | isLodNode () |
A simple downcast check. Returns true if this kind of node happens to inherit from LODNode, false otherwise. More... | |
bool | isOverallHidden () |
Returns true if the node has been hidden to all cameras by clearing its overall bit. More... | |
bool | isSceneRoot () |
Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More... | |
bool | isUnderSceneRoot () |
Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. If this is true, this node may potentially be traversed by the render traverser. Stashed nodes don't count for this purpose, but hidden nodes do. More... | |
listTags (Ostream out, str separator) | |
Writes a list of all the tag keys assigned to the node to the indicated stream. Writes one instance of the separator following each key (but does not write a terminal separator). The value associated with each key is not written. More... | |
ls (Ostream out, int indent_level) | |
Lists all the nodes at and below the current path hierarchically. More... | |
PandaNode | makeCopy () |
Returns a newly-allocated PandaNode that is a shallow copy of this one. It will be a different pointer, but its internal data may or may not be shared with that of the original PandaNode. No children will be copied. More... | |
markBoundsStale (Thread current_thread) | |
Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed. More... | |
markInternalBoundsStale (Thread current_thread) | |
Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested. More... | |
output (Ostream out) | |
prepareScene (GraphicsStateGuardianBase gsg, const RenderState node_state) | |
Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. It is not strictly necessary to call this, since the GSG will initialize itself when the scene is rendered, but this may take some of the overhead away from that process. More... | |
removeAllChildren (Thread current_thread) | |
Removes all the children from the node at once, including stashed children. More... | |
bool | removeChild (PandaNode child_node, Thread current_thread) |
Removes the indicated child from the node. Returns true if the child was removed, false if it was not already a child of the node. This will also successfully remove the child if it had been stashed. More... | |
removeChild (int child_index, Thread current_thread) | |
Removes the nth child from the node. More... | |
removeStashed (int child_index, Thread current_thread) | |
Removes the nth stashed child from the node. More... | |
bool | replaceChild (PandaNode orig_child, PandaNode new_child, Thread current_thread) |
Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. Returns true if the replacement is made, or false if the node is not a child or if there is some other problem. More... | |
replaceNode (PandaNode other) | |
Inserts this node into the scene graph in place of the other one, and removes the other node. All scene graph attributes (TransformState, RenderState, etc.) are copied to this node. More... | |
resetPrevTransform (Thread current_thread) | |
Resets the transform that represents this node's "previous" position to the same as the current transform. This is not the same thing as clearing it to identity. More... | |
setAttrib (const RenderAttrib attrib, int override) | |
Adds the indicated render attribute to the scene graph on this node. This attribute will now apply to this node and everything below. If there was already an attribute of the same type, it is replaced. More... | |
setBound (const BoundingVolume volume) | |
Deprecated. Use set_bounds() instead. More... | |
setBounds (const BoundingVolume volume) | |
Resets the bounding volume so that it is the indicated volume. When it is explicitly set, the bounding volume will no longer be automatically computed according to the contents of the node itself, for nodes like GeomNodes and TextNodes that contain substance (but the bounding volume will still be automatically expanded to include its children). More... | |
setBoundsType (BoundingVolume::BoundsType bounds_type) | |
Specifies the desired type of bounding volume that will be created for this node. This is normally BoundingVolume::BT_default, which means to set the type according to the config variable "bounds-type". More... | |
setEffect (const RenderEffect effect) | |
Adds the indicated render effect to the scene graph on this node. If there was already an effect of the same type, it is replaced. More... | |
setEffects (const RenderEffects effects, Thread current_thread) | |
Sets the complete RenderEffects that will be applied this node. This completely replaces whatever has been set on this node via repeated calls to set_attrib(). More... | |
setFinal (bool flag) | |
Sets the "final" flag on this PandaNode. If this is true, than no bounding volume need be tested below it; a positive intersection with this node's bounding volume is deemed to be a positive intersection with all geometry inside. More... | |
setIntoCollideMask (CollideMask mask) | |
Sets the "into" CollideMask. More... | |
setOverallHidden (bool overall_hidden) | |
Sets or clears the hidden flag. When the hidden flag is true, the node and all of its children are invisible to all cameras, regardless of the setting of any draw masks. Setting the hidden flag to false restores the previous visibility as established by the draw masks. More... | |
setPrevTransform (const TransformState transform, Thread current_thread) | |
Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More... | |
setPythonTag (str key, object value) | |
setState (const RenderState state, Thread current_thread) | |
Sets the complete RenderState that will be applied to all nodes at this level and below. (The actual state that will be applied to lower nodes is based on the composition of RenderStates from above this node as well). This completely replaces whatever has been set on this node via repeated calls to set_attrib(). More... | |
setTag (str key, str value, Thread current_thread) | |
Associates a user-defined value with a user-defined key which is stored on the node. This value has no meaning to Panda; but it is stored indefinitely on the node until it is requested again. More... | |
setTransform (const TransformState transform, Thread current_thread) | |
Sets the transform that will be applied to this node and below. This defines a new coordinate space at this point in the scene graph and below. More... | |
setUnexpectedChange (unsigned int flags) | |
Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. Once one of these bits has been set, if the property changes, an assertion failure will be raised, which is designed to assist the developer in identifying the troublesome code that modified the property unexpectedly. More... | |
bool | stashChild (PandaNode child_node, Thread current_thread) |
Stashes the indicated child node. This removes the child from the list of active children and puts it on a special list of stashed children. This child node no longer contributes to the bounding volume of the PandaNode, and is not visited in normal traversals. It is invisible and uncollidable. The child may later be restored by calling unstash_child(). More... | |
stashChild (int child_index, Thread current_thread) | |
Stashes the indicated child node. This removes the child from the list of active children and puts it on a special list of stashed children. This child node no longer contributes to the bounding volume of the PandaNode, and is not visited in normal traversals. It is invisible and uncollidable. The child may later be restored by calling unstash_child(). More... | |
stealChildren (PandaNode other, Thread current_thread) | |
Moves all the children from the other node onto this node. More... | |
bool | unstashChild (PandaNode child_node, Thread current_thread) |
Returns the indicated stashed node to normal child status. This removes the child from the list of stashed children and puts it on the normal list of active children. This child node once again contributes to the bounding volume of the PandaNode, and will be visited in normal traversals. It is visible and collidable. More... | |
unstashChild (int stashed_index, Thread current_thread) | |
Returns the indicated stashed node to normal child status. This removes the child from the list of stashed children and puts it on the normal list of active children. This child node once again contributes to the bounding volume of the PandaNode, and will be visited in normal traversals. It is visible and collidable. More... | |
write (Ostream out, int indent_level) | |
![]() | |
object | __reduce__ () |
object | __reduce_persist__ (object pickler) |
str | encodeToBamStream () |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure. More... | |
bool | encodeToBamStream (String data, BamWriter writer) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure. More... | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More... | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More... | |
![]() | |
TypeHandle | getType () |
Derived classes should override this function to return get_class_type(). More... | |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). 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... | |
![]() | |
int | getRefCount () |
Returns the current reference count. More... | |
ref () | |
Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. More... | |
bool | testRefCountIntegrity () |
Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More... | |
bool | testRefCountNonzero () |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More... | |
bool | unref () |
Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete(). More... | |
![]() | |
__init__ (const Namable copy) | |
__init__ (str initial_name) | |
clearName () | |
Resets the Namable's name to empty. More... | |
str | getName () |
bool | hasName () |
Returns true if the Namable has a nonempty name set, false if the name is empty. More... | |
Namable | operator= (const Namable other) |
output (Ostream out) | |
Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this. More... | |
setName (str name) | |
Static Public Member Functions | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static PandaNode | decodeFromBamStream (str data, BamReader reader) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More... | |
static DrawMask | getAllCameraMask () |
Returns a DrawMask that is appropriate for rendering to all cameras. More... | |
static TypeHandle | getClassType () |
static DrawMask | getOverallBit () |
Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More... | |
static | resetAllPrevTransform (Thread current_thread) |
Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More... | |
![]() | |
static TypedWritableReferenceCount | decodeFromBamStream (str data, BamReader reader) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More... | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
![]() | |
static TypeHandle | getClassType () |
Additional Inherited Members | |
![]() | |
enum | FancyBits { FB_transform = 1, FB_state = 2, FB_effects = 4, FB_tag = 16, FB_draw_mask = 32, FB_cull_callback = 64 } |
enum | UnexpectedChange { UC_parents = 1, UC_children = 2, UC_transform = 4, UC_state = 8, UC_draw_mask = 16 } |
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.
__init__ | ( | str | name | ) |
addParameter | ( | const EventParameter | obj | ) |
Adds the indicated parameter to the list of parameters that will be passed with each event generated by this ButtonThrower.
bool addThrowButton | ( | const ModifierButtons | mods, |
const ButtonHandle | button | ||
) |
Adds a new button to the set of buttons that the ButtonThrower explicitly processes.
If set_throw_buttons_active 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.
clearThrowButtons | ( | ) |
Empties the set of buttons that were added via add_throw_button(). See add_throw_button().
str getButtonDownEvent | ( | ) |
Returns the button_down_event that has been set on this ButtonThrower. See set_button_down_event().
str getButtonRepeatEvent | ( | ) |
Returns the button_repeat_event that has been set on this ButtonThrower. See set_button_repeat_event().
str getButtonUpEvent | ( | ) |
Returns the button_up_event that has been set on this ButtonThrower. See set_button_up_event().
str getCandidateEvent | ( | ) |
Returns the candidate_event that has been set on this ButtonThrower. See set_candidate_event().
|
static |
str getKeystrokeEvent | ( | ) |
Returns the keystroke_event that has been set on this ButtonThrower. See set_keystroke_event().
const ModifierButtons getModifierButtons | ( | ) |
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.
str getMoveEvent | ( | ) |
Returns the move_event that has been set on this ButtonThrower. See set_move_event().
int getNumParameters | ( | ) |
Returns the number of parameters that have been added to the list of parameters to be passed with each event generated by this ButtonThrower.
EventParameter getParameter | ( | int | n | ) |
Returns the nth parameter that has been added to the list of parameters passed with each event generated by this ButtonThrower.
list getParameters | ( | ) |
str getPrefix | ( | ) |
Returns the prefix that has been set on this ButtonThrower. See set_prefix().
str getRawButtonDownEvent | ( | ) |
Returns the raw_button_down_event that has been set on this ButtonThrower. See set_raw_button_down_event().
str getRawButtonUpEvent | ( | ) |
Returns the raw_button_up_event that has been set on this ButtonThrower. See set_raw_button_up_event().
bool getSpecificFlag | ( | ) |
Returns the flag that indicates whether specific events should be generated. See set_specific_flag().
bool getThrowButtonsActive | ( | ) |
Returns the flag that indicates whether the ButtonThrower will only process events for the explicitly named buttons or not. See set_throw_buttons_active().
bool getTimeFlag | ( | ) |
Returns the flag that indicates whether the time of the button event should be passed as a parameter.
bool hasThrowButton | ( | const ButtonHandle | button | ) |
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 add_throw_button(), regardless of what the first parameter was.
bool hasThrowButton | ( | const ModifierButtons | mods, |
const ButtonHandle | button | ||
) |
Returns true if the indicated button is on the set of buttons that will be processed by the ButtonThrower, false otherwise. See add_throw_button().
bool removeThrowButton | ( | const ModifierButtons | mods, |
const ButtonHandle | button | ||
) |
Removes the indicated button from the set of buttons that the ButtonThrower explicitly processes. See add_throw_button().
The return value is true if the button is removed, or false if it was not on the set.
setButtonDownEvent | ( | str | button_down_event | ) |
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 set_keystroke_event().
setButtonRepeatEvent | ( | str | button_repeat_event | ) |
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 set_keystroke_event().
setButtonUpEvent | ( | str | button_up_event | ) |
Specifies the generic event that is generated (if any) each time a key or button is released. See set_button_down_event().
setCandidateEvent | ( | str | candidate_event | ) |
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 | ( | str | keystroke_event | ) |
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 set_button_down_event().
setModifierButtons | ( | const ModifierButtons | mods | ) |
Changes 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, then the event name will be prepended with the names of the modifier buttons.
It is recommended that you change this setting by first calling get_modifier_buttons(), making adjustments, and passing the new value to set_modifier_buttons(). This way the current state of the modifier buttons will not be lost.
setMoveEvent | ( | str | move_event | ) |
Specifies the event that is generated (if any) each time the mouse is moved within the window.
setPrefix | ( | str | prefix | ) |
Sets the prefix which is prepended to all specific event names (that is, event names generated from the button name itself, as opposed to the generic event names like set_button_down_event) thrown by this object.
setRawButtonDownEvent | ( | str | raw_button_down_event | ) |
Like set_button_down_event, but uses the raw, untransformed scan key from the operating system. This uses buttons that are independent of the user's selected keyboard layout.
setRawButtonUpEvent | ( | str | raw_button_up_event | ) |
Specifies the generic event that is generated (if any) each time a key or button is released. See set_raw_button_down_event().
setSpecificFlag | ( | bool | specific_flag | ) |
Sets the flag that indicates whether specific events (events prefixed by set_prefix, and based on the event name) should be generated at all. This is true by default, but may be disabled if you are only interested in the generic events (for instance, events like set_button_down_event).
setThrowButtonsActive | ( | bool | flag | ) |
Sets the flag that indicates whether the ButtonThrower will only process events for the explicitly named buttons or not. Normally this is false, meaning all buttons are processed; set it true to indicate that only some buttons should be processed. See add_throw_button().
setTimeFlag | ( | bool | time_flag | ) |
Sets the flag that indicates whether the time of the button event should be passed as a parameter or not. When this is true, an additional parameter is generated on each event (before all the parameters named by add_parameter) that consists of a single double value, and reflects the time the button was pressed or released, as a value from ClockObject::get_global_clock().