Panda3D
Public Member Functions | Static Public Member Functions

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

List of all members.

Public Member Functions

string encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encodeToBamStream (basic_stringchar data)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
bool encodeToBamStream (basic_stringchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
UpdateSeq getBamModified ()
 Returns the current bam_modified counter.
ButtonHandle getButton ()
 Returns the mouse or keyboard button associated with this event.
string getCandidateStringEncoded ()
 Returns the candidate string associated with this event.
string getCandidateStringEncoded (Encoding encoding)
 Returns the candidate string associated with this event.
unsigned int getCursorPos ()
 Returns the position of the user's edit cursor within the candidate string.
unsigned int getHighlightEnd ()
 Returns one more than the last highlighted character in the candidate string.
unsigned int getHighlightStart ()
 Returns the first highlighted character in the candidate string.
int getKeycode ()
 Returns the keycode associated with this event.
ModifierButtons const getModifierButtons ()
 Returns the set of modifier buttons that were being held down while the event was generated.
Point2 const getMouse ()
 Returns the mouse position at the time the event was generated, in the normalized range (-1 .
int getRefCount ()
 Returns the current reference count.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool hasButton ()
 Returns true if this parameter has an associated mouse or keyboard button, false otherwise.
bool hasCandidate ()
 Returns true if this parameter has an associated candidate string, false otherwise.
bool hasKeycode ()
 Returns true if this parameter has an associated keycode, false otherwise.
bool hasMouse ()
 Returns true if this parameter has an associated mouse position, false otherwise.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isKeyrepeat ()
 Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
bool isOutside ()
 Returns true if the mouse was outside the region at the time the event was generated, false otherwise.
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
 output (ostream out)
PyObject reduce (PyObject self)
 This special Python method is implement to provide support for the pickle module.
PyObject reducePersist (PyObject self, PyObject pickler)
 This special Python method is implement to provide support for the pickle module.
 ref ()
 Explicitly increments the reference count.
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unref ()
 Explicitly decrements the reference count.

Static Public Member Functions

static TypedWritableReferenceCount decodeFromBamStream (string 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.
static TypedWritableReferenceCount decodeFromBamStream (string data)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
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

static TypedWritableReferenceCount decodeFromBamStream ( string  data,
BamReader  reader 
) [static, inherited]

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.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

static TypedWritableReferenceCount decodeFromBamStream ( string  data) [static, inherited]

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.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

string encodeToBamStream ( ) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data,
BamWriter  writer 
) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data) [inherited]

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.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

UpdateSeq getBamModified ( ) [inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

ButtonHandle getButton ( ) [inherited]

Returns the mouse or keyboard button associated with this event.

If has_button(), above, returns false, this returns ButtonHandle.none().

string getCandidateStringEncoded ( ) [inherited]

Returns the candidate string associated with this event.

If has_candidate(), above, returns false, this returns the empty string.

string getCandidateStringEncoded ( Encoding  encoding) [inherited]

Returns the candidate string associated with this event.

If has_candidate(), above, returns false, this returns the empty string.

static TypeHandle getClassType ( ) [static]

Reimplemented from TypedWritableReferenceCount.

unsigned int getCursorPos ( ) [inherited]

Returns the position of the user's edit cursor within the candidate string.

unsigned int getHighlightEnd ( ) [inherited]

Returns one more than the last highlighted character in the candidate string.

unsigned int getHighlightStart ( ) [inherited]

Returns the first highlighted character in the candidate string.

int getKeycode ( ) [inherited]

Returns the keycode associated with this event.

If has_keycode(), above, returns false, this returns 0.

ModifierButtons const getModifierButtons ( ) [inherited]

Returns the set of modifier buttons that were being held down while the event was generated.

Point2 const getMouse ( ) [inherited]

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.

int getRefCount ( ) [inherited]

Returns the current reference count.

TypeHandle getType ( ) [inherited]

Reimplemented in AnimChannelBase.

int getTypeIndex ( ) [inherited]

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().

bool hasButton ( ) [inherited]

Returns true if this parameter has an associated mouse or keyboard button, false otherwise.

bool hasCandidate ( ) [inherited]

Returns true if this parameter has an associated candidate string, false otherwise.

bool hasKeycode ( ) [inherited]

Returns true if this parameter has an associated keycode, false otherwise.

bool hasMouse ( ) [inherited]

Returns true if this parameter has an associated mouse position, false otherwise.

bool isExactType ( TypeHandle  handle) [inherited]

Returns true if the current object is the indicated type exactly.

bool isKeyrepeat ( ) [inherited]

Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down.

bool isOfType ( TypeHandle  handle) [inherited]

Returns true if the current object is or derives from the indicated type.

bool isOutside ( ) [inherited]

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.

markBamModified ( ) [inherited]

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.

output ( ostream  out)

Reimplemented from MouseWatcherParameter.

PyObject reduce ( PyObject  self) [inherited]

This special Python method is implement to provide support for the pickle module.

This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.

PyObject reducePersist ( PyObject  self,
PyObject  pickler 
) [inherited]

This special Python method is implement to provide support for the pickle module.

This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.

ref ( ) [inherited]

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.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

bool testRefCountIntegrity ( ) [inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

bool testRefCountNonzero ( ) [inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

bool unref ( ) [inherited]

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().

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.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties