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

This specialization on MouseWatcherParameter allows us to tag on additional elements to events for the gui system, and also inherits from TypedWritableReferenceCount so we can attach this thing to an event. More...

Inheritance diagram for PGMouseWatcherParameter:
TypedWritableReferenceCount MouseWatcherParameter TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Member Functions

 output (Ostream out)
 
- Public Member Functions inherited from TypedWritable
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...
 
- Public Member Functions inherited from TypedObject
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...
 
- Public Member Functions inherited from ReferenceCount
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...
 
- Public Member Functions inherited from MouseWatcherParameter
ButtonHandle getButton ()
 Returns the mouse or keyboard button associated with this event. If has_button(), above, returns false, this returns ButtonHandle::none(). More...
 
str getCandidateStringEncoded ()
 Returns the candidate string associated with this event. If has_candidate(), above, returns false, this returns the empty string. More...
 
str getCandidateStringEncoded (TextEncoder::Encoding encoding)
 Returns the candidate string associated with this event. If has_candidate(), above, returns false, this returns the empty string. More...
 
size_t getCursorPos ()
 Returns the position of the user's edit cursor within the candidate string. More...
 
size_t getHighlightEnd ()
 Returns one more than the last highlighted character in the candidate string. More...
 
size_t getHighlightStart ()
 Returns the first highlighted character in the candidate string. More...
 
int getKeycode ()
 Returns the keycode associated with this event. If has_keycode(), above, returns false, this returns 0. More...
 
const ModifierButtons getModifierButtons ()
 Returns the set of modifier buttons that were being held down while the event was generated. More...
 
const LPoint2 getMouse ()
 Returns the mouse position at the time the event was generated, in the normalized range (-1 .. 1). It is valid to call this only if has_mouse() returned true. More...
 
bool hasButton ()
 Returns true if this parameter has an associated mouse or keyboard button, false otherwise. More...
 
bool hasCandidate ()
 Returns true if this parameter has an associated candidate string, false otherwise. More...
 
bool hasKeycode ()
 Returns true if this parameter has an associated keycode, false otherwise. More...
 
bool hasMouse ()
 Returns true if this parameter has an associated mouse position, false otherwise. More...
 
bool isKeyrepeat ()
 Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down. More...
 
bool isOutside ()
 Returns true if the mouse was outside the region at the time the event was generated, false otherwise. This is only valid for "release" type events. More...
 
 output (Ostream out)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
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 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 ()
 

Detailed Description

This specialization on MouseWatcherParameter allows us to tag on additional elements to events for the gui system, and also inherits from TypedWritableReferenceCount so we can attach this thing to an event.

Member Function Documentation

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ output()

output ( Ostream  out)