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

This is the base class for all the various kinds of gui widget objects. More...

Inheritance diagram for PGItem:
PandaNode TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject PGButton PGEntry PGSliderBar PGVirtualFrame PGWaitBar PGScrollFrame

Public Member Functions

 __init__ (str name)
 
 clearFrame ()
 Removes the bounding rectangle from the item. More...
 
 clearSound (str event)
 Removes the sound associated with the indicated event. More...
 
 clearStateDef (int state)
 Resets the NodePath assigned to the indicated state to its initial default, with only a frame representation if appropriate. More...
 
bool getActive ()
 Returns whether the PGItem is currently active for mouse events. More...
 
bool getBackgroundFocus ()
 Returns whether background_focus is currently enabled. More...
 
str getEnterEvent ()
 Returns the event name that will be thrown when the item is active and the mouse enters its frame, but not any nested frames. More...
 
str getExitEvent ()
 Returns the event name that will be thrown when the item is active and the mouse exits its frame, or enters a nested frame. More...
 
bool getFocus ()
 Returns whether the PGItem currently has focus for keyboard events. More...
 
str getFocusInEvent ()
 Returns the event name that will be thrown when the item gets the keyboard focus. More...
 
str getFocusOutEvent ()
 Returns the event name that will be thrown when the item loses the keyboard focus. More...
 
const LVecBase4 getFrame ()
 Returns the bounding rectangle of the item. More...
 
LMatrix4 getFrameInvXform ()
 Returns the inverse of the frame transform matrix. More...
 
PGFrameStyle getFrameStyle (int state)
 Returns the kind of frame that will be drawn behind the item when it is in the indicated state. More...
 
str getId ()
 Returns the unique ID assigned to this PGItem. More...
 
str getKeystrokeEvent ()
 Returns the event name that will be thrown when the item is active and any key is pressed by the user. More...
 
int getNumStateDefs ()
 Returns one more than the highest-numbered state def that was ever assigned to the PGItem. More...
 
str getPressEvent (const ButtonHandle button)
 Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is depressed while the mouse is within the frame. More...
 
str getReleaseEvent (const ButtonHandle button)
 Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button, formerly clicked down is within the frame, is released. More...
 
str getRepeatEvent (const ButtonHandle button)
 Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is continuously held down while the mouse is within the frame. More...
 
AudioSound getSound (str event)
 Returns the sound associated with the indicated event, or NULL if there is no associated sound. More...
 
int getState ()
 Returns the "state" of this particular PGItem. More...
 
NodePath getStateDef (int state)
 Returns the Node that is the root of the subgraph that will be drawn when the PGItem is in the indicated state. More...
 
list getStateDefs ()
 
int getSuppressFlags ()
 This is just an interface to get the suppress flags on the underlying MouseWatcherRegion. More...
 
str getWithinEvent ()
 Returns the event name that will be thrown when the item is active and the mouse moves within the boundaries of the frame. More...
 
str getWithoutEvent ()
 Returns the event name that will be thrown when the item is active and the mouse moves completely outside the boundaries of the frame. More...
 
bool hasFrame ()
 Returns true if the item has a bounding rectangle; see set_frame(). More...
 
bool hasSound (str event)
 Returns true if there is a sound associated with the indicated event, or false otherwise. More...
 
bool hasStateDef (int state)
 Returns true if get_state_def() has ever been called for the indicated state (thus defining a render subgraph for this state index), false otherwise. More...
 
NodePath instanceToStateDef (int state, const NodePath path)
 Parents an instance of the bottom node of the indicated NodePath to the indicated state index. More...
 
 setActive (bool active)
 Sets whether the PGItem is active for mouse watching. More...
 
 setBackgroundFocus (bool focus)
 Sets the background_focus flag for this item. More...
 
 setFocus (bool focus)
 Sets whether the PGItem currently has keyboard focus. More...
 
 setFrame (const LVecBase4 frame)
 Sets the bounding rectangle of the item, in local coordinates. More...
 
 setFrame (float left, float right, float bottom, float top)
 Sets the bounding rectangle of the item, in local coordinates. More...
 
 setFrameStyle (int state, const PGFrameStyle style)
 Changes the kind of frame that will be drawn behind the item when it is in the indicated state. More...
 
 setId (str id)
 Set the unique ID assigned to this PGItem. More...
 
 setName (str name)
 
 setSound (str event, AudioSound sound)
 Sets the sound that will be played whenever the indicated event occurs. More...
 
 setState (int state)
 Sets the "state" of this particular PGItem. More...
 
 setSuppressFlags (int suppress_flags)
 This is just an interface to set the suppress flags on the underlying MouseWatcherRegion. More...
 
- Public Member Functions inherited from PandaNode
PandaNode __copy__ ()
 
object __deepcopy__ (object memo)
 
 __init__ (str name)
 
int __traverse__ (Visitproc visit, void arg)
 
 addChild (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node. More...
 
 addStashed (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node, directly as a stashed child. 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. More...
 
 clearAttrib (int slot)
 Removes the render attribute of the given type from this node. 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 (object key)
 
 clearState (Thread current_thread)
 Resets this node to leave the render state alone. More...
 
 clearTag (str key, Thread current_thread)
 Removes the value defined for this key on this particular node. 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. 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. More...
 
 copyAllProperties (PandaNode other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. 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. More...
 
 copyTags (PandaNode other)
 Copies all of the tags stored on the other node onto this node. 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. 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. 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. 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. 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()). More...
 
DrawMask getDrawControlMask ()
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask getDrawShowMask ()
 Returns the hide/show bits of this particular node. 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. More...
 
const BoundingVolume getInternalBounds (Thread current_thread)
 Returns the node's internal 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. 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. More...
 
int getNumChildren (Thread current_thread)
 Returns the number of child nodes this node has. More...
 
int getNumParents (Thread current_thread)
 Returns the number of parent nodes this node has. More...
 
int getNumStashed (Thread current_thread)
 Returns the number of stashed nodes this node has. 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. More...
 
list getParents ()
 
const TransformState getPrevTransform (Thread current_thread)
 Returns the transform that has been set as this node's "previous" position. More...
 
object getPythonTag (object key)
 
object getPythonTagKeys ()
 
object getPythonTags ()
 
PandaNode::Stashed getStashed (Thread current_thread)
 Returns an object that can be used to walk through the list of children of the node. More...
 
PandaNode getStashed (int n, Thread current_thread)
 Returns the nth stashed child of this node. 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()). 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. 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. More...
 
object getTagKeys ()
 
const TransformState getTransform (Thread current_thread)
 Returns the transform that has been set 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...
 
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). 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 (object 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. More...
 
bool isFinal (Thread current_thread)
 Returns the current state of the "final" flag. More...
 
bool isGeomNode ()
 A simple downcast check. More...
 
bool isLodNode ()
 A simple downcast check. 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. More...
 
 listTags (Ostream out, str separator)
 Writes a list of all the tag keys assigned to the node to the indicated stream. 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. 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. 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. 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. More...
 
 replaceNode (PandaNode other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
 resetPrevTransform (Thread current_thread)
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
 setAttrib (const RenderAttrib attrib, int override)
 Adds the indicated render attribute to the scene graph on this node. More...
 
 setBound (const BoundingVolume volume)
 Deprecated. More...
 
 setBounds (const BoundingVolume volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
 setBoundsType (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
 setEffect (const RenderEffect effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
 setEffects (const RenderEffects effects, Thread current_thread)
 Sets the complete RenderEffects that will be applied this node. More...
 
 setFinal (bool flag)
 Sets the "final" flag on this PandaNode. More...
 
 setIntoCollideMask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
 setOverallHidden (bool overall_hidden)
 Sets or clears the hidden flag. 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 (object 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. 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. More...
 
 setTransform (const TransformState transform, Thread current_thread)
 Sets the transform that will be applied to this node 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. More...
 
bool stashChild (PandaNode child_node, Thread current_thread)
 Stashes the indicated child node. More...
 
 stashChild (int child_index, Thread current_thread)
 Stashes the indicated child node. 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. More...
 
 unstashChild (int stashed_index, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- 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...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __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...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
static str getEnterPrefix ()
 Returns the prefix that is used to define the enter event for all PGItems. More...
 
static str getExitPrefix ()
 Returns the prefix that is used to define the exit event for all PGItems. More...
 
static str getFocusInPrefix ()
 Returns the prefix that is used to define the focus_in event for all PGItems. More...
 
static PGItem getFocusItem ()
 Returns the one PGItem in the world that currently has keyboard focus, if any, or NULL if no item has keyboard focus. More...
 
static str getFocusOutPrefix ()
 Returns the prefix that is used to define the focus_out event for all PGItems. More...
 
static str getKeystrokePrefix ()
 Returns the prefix that is used to define the keystroke event for all PGItems. More...
 
static str getPressPrefix ()
 Returns the prefix that is used to define the press event for all PGItems. More...
 
static str getReleasePrefix ()
 Returns the prefix that is used to define the release event for all PGItems. More...
 
static str getRepeatPrefix ()
 Returns the prefix that is used to define the repeat event for all PGItems. More...
 
static TextNode getTextNode ()
 Returns the TextNode object that will be used by all PGItems to generate default labels given a string. More...
 
static str getWithinPrefix ()
 Returns the prefix that is used to define the within event for all PGItems. More...
 
static str getWithoutPrefix ()
 Returns the prefix that is used to define the without event for all PGItems. More...
 
static setTextNode (TextNode node)
 Changes the TextNode object that will be used by all PGItems to generate default labels given a string. More...
 
- Static Public Member Functions inherited from PandaNode
static PandaNode decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. 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 Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Types inherited from PandaNode
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
}
 
- Public Attributes inherited from PandaNode
DrawMask all_camera_mask
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
bool bounds_stale
 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...
 
BoundingVolume::BoundsType bounds_type
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode::Children children
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask draw_control_mask
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask draw_show_mask
 Returns the hide/show bits of this particular node. More...
 
ConstPointerToRenderEffects effects
 Returns the complete RenderEffects that will be applied to this node. More...
 
bool final
 Returns the current state of the "final" flag. More...
 
ConstPointerToBoundingVolume internal_bounds
 Returns the node's internal bounding volume. More...
 
int internal_vertices
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask into_collide_mask
 Returns the "into" collide mask for this node. More...
 
CollideMask legal_collide_mask
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int nested_vertices
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
DrawMask overall_bit
 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...
 
bool overall_hidden
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
PandaNode::Parents parents
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
ConstPointerToTransformState prev_transform
 Returns the transform that has been set as this node's "previous" position. More...
 
object python_tags
 
PandaNode::Stashed stashed
 Returns the nth stashed child of this node. More...
 
ConstPointerToRenderState state
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
String tags []
 
ConstPointerToTransformState transform
 Returns the transform that has been set on this particular node. More...
 
- 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...
 
- Public Attributes inherited from Namable
const String name
 

Detailed Description

This is the base class for all the various kinds of gui widget objects.

It is a Node which corresponds to a rectangular region on the screen, and it may have any number of "state" subgraphs, one of which is rendered at any given time according to its current state.

The PGItem node must be parented to the scene graph somewhere beneath a PGTop node in order for this behavior to work.

Member Function Documentation

◆ __init__()

__init__ ( str  name)

◆ clearFrame()

clearFrame ( )

Removes the bounding rectangle from the item.

It will no longer be possible to position the mouse within the item; see set_frame().

◆ clearSound()

clearSound ( str  event)

Removes the sound associated with the indicated event.

◆ clearStateDef()

clearStateDef ( int  state)

Resets the NodePath assigned to the indicated state to its initial default, with only a frame representation if appropriate.

◆ getActive()

bool getActive ( )

Returns whether the PGItem is currently active for mouse events.

See set_active().

◆ getBackgroundFocus()

bool getBackgroundFocus ( )

Returns whether background_focus is currently enabled.

See set_background_focus().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getEnterEvent()

str getEnterEvent ( )

Returns the event name that will be thrown when the item is active and the mouse enters its frame, but not any nested frames.

◆ getEnterPrefix()

static str getEnterPrefix ( )
static

Returns the prefix that is used to define the enter event for all PGItems.

The enter event is the concatenation of this string followed by get_id().

◆ getExitEvent()

str getExitEvent ( )

Returns the event name that will be thrown when the item is active and the mouse exits its frame, or enters a nested frame.

◆ getExitPrefix()

static str getExitPrefix ( )
static

Returns the prefix that is used to define the exit event for all PGItems.

The exit event is the concatenation of this string followed by get_id().

◆ getFocus()

bool getFocus ( )

Returns whether the PGItem currently has focus for keyboard events.

See set_focus().

◆ getFocusInEvent()

str getFocusInEvent ( )

Returns the event name that will be thrown when the item gets the keyboard focus.

◆ getFocusInPrefix()

static str getFocusInPrefix ( )
static

Returns the prefix that is used to define the focus_in event for all PGItems.

The focus_in event is the concatenation of this string followed by get_id().

Unlike most item events, this event is thrown with no parameters.

◆ getFocusItem()

static PGItem getFocusItem ( )
static

Returns the one PGItem in the world that currently has keyboard focus, if any, or NULL if no item has keyboard focus.

Use PGItem::set_focus() to activate or deactivate keyboard focus on a particular item.

◆ getFocusOutEvent()

str getFocusOutEvent ( )

Returns the event name that will be thrown when the item loses the keyboard focus.

◆ getFocusOutPrefix()

static str getFocusOutPrefix ( )
static

Returns the prefix that is used to define the focus_out event for all PGItems.

The focus_out event is the concatenation of this string followed by get_id().

Unlike most item events, this event is thrown with no parameters.

◆ getFrame()

const LVecBase4 getFrame ( )

Returns the bounding rectangle of the item.

See set_frame(). It is an error to call this if has_frame() returns false.

◆ getFrameInvXform()

LMatrix4 getFrameInvXform ( )

Returns the inverse of the frame transform matrix.

◆ getFrameStyle()

PGFrameStyle getFrameStyle ( int  state)

Returns the kind of frame that will be drawn behind the item when it is in the indicated state.

◆ getId()

str getId ( )

Returns the unique ID assigned to this PGItem.

This will be assigned to the region created with the MouseWatcher, and will thus be used to generate event names.

◆ getKeystrokeEvent()

str getKeystrokeEvent ( )

Returns the event name that will be thrown when the item is active and any key is pressed by the user.

◆ getKeystrokePrefix()

static str getKeystrokePrefix ( )
static

Returns the prefix that is used to define the keystroke event for all PGItems.

The keystroke event is the concatenation of this string followed by a hyphen and get_id().

◆ getNumStateDefs()

int getNumStateDefs ( )

Returns one more than the highest-numbered state def that was ever assigned to the PGItem.

The complete set of state defs assigned may then be retrieved by indexing from 0 to (get_num_state_defs() - 1).

This is only an upper limit on the actual number of state defs, since there may be holes in the list.

◆ getPressEvent()

str getPressEvent ( const ButtonHandle  button)

Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is depressed while the mouse is within the frame.

◆ getPressPrefix()

static str getPressPrefix ( )
static

Returns the prefix that is used to define the press event for all PGItems.

The press event is the concatenation of this string followed by a button name, followed by a hyphen and get_id().

◆ getReleaseEvent()

str getReleaseEvent ( const ButtonHandle  button)

Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button, formerly clicked down is within the frame, is released.

◆ getReleasePrefix()

static str getReleasePrefix ( )
static

Returns the prefix that is used to define the release event for all PGItems.

The release event is the concatenation of this string followed by a button name, followed by a hyphen and get_id().

◆ getRepeatEvent()

str getRepeatEvent ( const ButtonHandle  button)

Returns the event name that will be thrown when the item is active and the indicated mouse or keyboard button is continuously held down while the mouse is within the frame.

◆ getRepeatPrefix()

static str getRepeatPrefix ( )
static

Returns the prefix that is used to define the repeat event for all PGItems.

The repeat event is the concatenation of this string followed by a button name, followed by a hyphen and get_id().

◆ getSound()

AudioSound getSound ( str  event)

Returns the sound associated with the indicated event, or NULL if there is no associated sound.

◆ getState()

int getState ( )

Returns the "state" of this particular PGItem.

See set_state().

◆ getStateDef()

NodePath getStateDef ( int  state)

Returns the Node that is the root of the subgraph that will be drawn when the PGItem is in the indicated state.

The first time this is called for a particular state index, it may create the Node.

◆ getStateDefs()

list getStateDefs ( )

◆ getSuppressFlags()

int getSuppressFlags ( )

This is just an interface to get the suppress flags on the underlying MouseWatcherRegion.

See MouseWatcherRegion::get_suppress_flags().

◆ getTextNode()

static TextNode getTextNode ( )
static

Returns the TextNode object that will be used by all PGItems to generate default labels given a string.

This can be loaded with the default font, etc.

◆ getWithinEvent()

str getWithinEvent ( )

Returns the event name that will be thrown when the item is active and the mouse moves within the boundaries of the frame.

This is different from the enter_event in that the mouse is considered within the frame even if it is also within a nested frame.

◆ getWithinPrefix()

static str getWithinPrefix ( )
static

Returns the prefix that is used to define the within event for all PGItems.

The within event is the concatenation of this string followed by get_id().

◆ getWithoutEvent()

str getWithoutEvent ( )

Returns the event name that will be thrown when the item is active and the mouse moves completely outside the boundaries of the frame.

This is different from the exit_event in that the mouse is considered within the frame even if it is also within a nested frame.

◆ getWithoutPrefix()

static str getWithoutPrefix ( )
static

Returns the prefix that is used to define the without event for all PGItems.

The without event is the concatenation of this string followed by get_id().

◆ hasFrame()

bool hasFrame ( )

Returns true if the item has a bounding rectangle; see set_frame().

◆ hasSound()

bool hasSound ( str  event)

Returns true if there is a sound associated with the indicated event, or false otherwise.

◆ hasStateDef()

bool hasStateDef ( int  state)

Returns true if get_state_def() has ever been called for the indicated state (thus defining a render subgraph for this state index), false otherwise.

◆ instanceToStateDef()

NodePath instanceToStateDef ( int  state,
const NodePath  path 
)

Parents an instance of the bottom node of the indicated NodePath to the indicated state index.

◆ setActive()

setActive ( bool  active)

Sets whether the PGItem is active for mouse watching.

This is not necessarily related to the active/inactive appearance of the item, which is controlled by set_state(), but it does affect whether it responds to mouse events.

◆ setBackgroundFocus()

setBackgroundFocus ( bool  focus)

Sets the background_focus flag for this item.

When background_focus is enabled, the item will receive keypress events even if it is not in focus; in fact, even if it is not onscreen. Unlike normal focus, many items may have background_focus simultaneously.

◆ setFocus()

setFocus ( bool  focus)

Sets whether the PGItem currently has keyboard focus.

This simply means that the item may respond to keyboard events as well as to mouse events; precisely what this means is up to the individual item.

Only one PGItem in the world is allowed to have focus at any given time. Setting the focus on any other item automatically disables the focus from the previous item.

◆ setFrame() [1/2]

setFrame ( const LVecBase4  frame)

Sets the bounding rectangle of the item, in local coordinates.

This is the region on screen within which the mouse will be considered to be within the item. Normally, it should correspond to the bounding rectangle of the visible geometry of the item.

◆ setFrame() [2/2]

setFrame ( float  left,
float  right,
float  bottom,
float  top 
)

Sets the bounding rectangle of the item, in local coordinates.

This is the region on screen within which the mouse will be considered to be within the item. Normally, it should correspond to the bounding rectangle of the visible geometry of the item.

◆ setFrameStyle()

setFrameStyle ( int  state,
const PGFrameStyle  style 
)

Changes the kind of frame that will be drawn behind the item when it is in the indicated state.

◆ setId()

setId ( str  id)

Set the unique ID assigned to this PGItem.

It is the user's responsibility to ensure that this ID is unique.

Normally, this should not need to be called, as the PGItem will assign itself an ID when it is created, but this function allows the user to decide to redefine the ID to be something possibly more meaningful.

◆ setName()

setName ( str  name)

◆ setSound()

setSound ( str  event,
AudioSound  sound 
)

Sets the sound that will be played whenever the indicated event occurs.

◆ setState()

setState ( int  state)

Sets the "state" of this particular PGItem.

The PGItem node will render as if it were the subgraph assigned to the corresponding index via set_state_def().

◆ setSuppressFlags()

setSuppressFlags ( int  suppress_flags)

This is just an interface to set the suppress flags on the underlying MouseWatcherRegion.

See MouseWatcherRegion::set_suppress_flags().

◆ setTextNode()

static setTextNode ( TextNode  node)
static

Changes the TextNode object that will be used by all PGItems to generate default labels given a string.

This can be loaded with the default font, etc.