Panda3D
Public Member Functions | Static Public Member Functions

PointerEventList Class Reference

Records a set of pointer events that happened recently. More...

Inheritance diagram for PointerEventList:
EventStoreValueBase TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

List of all members.

Public Member Functions

 PointerEventList ()
 addEvent (bool in_win, int xpos, int ypos, int seq, double time)
 Adds a new event to the end of the list.
 clear ()
 Empties all the events from the list.
bool encircles (int x, int y)
 Returns true if the trail loops around the specified point.
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, BamWriter writer)
 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)
 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.
double getDirection (int n)
 Get the direction of the nth event.
int getDx (int n)
 Get the x-coordinate of the nth event.
int getDy (int n)
 Get the y-coordinate of the nth event.
bool getInWindow (int n)
 Get the in-window flag of the nth event.
double getLength (int n)
 Get the length of the nth event.
int getNumEvents ()
 Returns the number of events in the list.
int getRefCount ()
 Returns the current reference count.
double getRotation (int n)
 Get the rotation of the nth event.
int getSequence (int n)
 Get the sequence number of the nth event.
double getTime (int n)
 Get the timestamp of the nth event.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
int getXpos (int n)
 Get the x-coordinate of the nth event.
int getYpos (int n)
 Get the y-coordinate of the nth event.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
double matchPattern (string pattern, double rot, double seglen)
 This function is not implemented yet.
 output (ostream out)
 popFront ()
 Discards the first event on the list.
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.
double totalTurns (double sec)
 returns the total angular deviation that the trail has made in the specified time period.
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

Records a set of pointer events that happened recently.

This class is usually used only in the data graph, to transmit the recent pointer presses, but it may be used anywhere a list of PointerEvents is desired.


Constructor & Destructor Documentation


Member Function Documentation

addEvent ( bool  in_win,
int  xpos,
int  ypos,
int  seq,
double  time 
)

Adds a new event to the end of the list.

Automatically calculates the dx, dy, length, direction, and rotation for all but the first event.

clear ( )

Empties all the events from the list.

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.

bool encircles ( int  x,
int  y 
)

Returns true if the trail loops around the specified point.

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.

static TypeHandle getClassType ( ) [static]

Reimplemented from EventStoreValueBase.

double getDirection ( int  n)

Get the direction of the nth event.

int getDx ( int  n)

Get the x-coordinate of the nth event.

int getDy ( int  n)

Get the y-coordinate of the nth event.

bool getInWindow ( int  n)

Get the in-window flag of the nth event.

double getLength ( int  n)

Get the length of the nth event.

int getNumEvents ( )

Returns the number of events in the list.

int getRefCount ( ) [inherited]

Returns the current reference count.

double getRotation ( int  n)

Get the rotation of the nth event.

int getSequence ( int  n)

Get the sequence number of the nth event.

double getTime ( int  n)

Get the timestamp of the nth event.

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

int getXpos ( int  n)

Get the x-coordinate of the nth event.

int getYpos ( int  n)

Get the y-coordinate of the nth event.

bool isExactType ( TypeHandle  handle) [inherited]

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

bool isOfType ( TypeHandle  handle) [inherited]

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

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.

double matchPattern ( string  pattern,
double  rot,
double  seglen 
)

This function is not implemented yet.

It is a work in progress. The intent is as follows:

Returns a nonzero value if the mouse movements match the specified pattern. The higher the value, the better the match. The pattern is a sequence of compass directions (ie, "E", "NE", etc) separated by spaces. If rot is nonzero, then the pattern is rotated counterclockwise by the specified amount before testing. Seglen is the minimum length a mouse movement needs to be in order to be considered significant.

output ( ostream  out) [inherited]
popFront ( )

Discards the first event on the list.

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.

double totalTurns ( double  sec)

returns the total angular deviation that the trail has made in the specified time period.

A small number means that the trail is moving in a relatively straight line, a large number means that the trail is zig-zagging or spinning. The result is in degrees.

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