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

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. More...

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

Public Member Functions

 __init__ ()
 
 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. More...
 
 clear ()
 Empties all the events from the list. More...
 
bool encircles (int x, int y)
 Returns true if the trail loops around the specified point. More...
 
double getDirection (int n)
 Get the direction of the nth event. More...
 
int getDx (int n)
 Get the x-coordinate of the nth event. More...
 
int getDy (int n)
 Get the y-coordinate of the nth event. More...
 
bool getInWindow (int n)
 Get the in-window flag of the nth event. More...
 
double getLength (int n)
 Get the length of the nth event. More...
 
int getNumEvents ()
 Returns the number of events in the list. More...
 
double getRotation (int n)
 Get the rotation of the nth event. More...
 
int getSequence (int n)
 Get the sequence number of the nth event. More...
 
double getTime (int n)
 Get the timestamp of the nth event. More...
 
int getXpos (int n)
 Get the x-coordinate of the nth event. More...
 
int getYpos (int n)
 Get the y-coordinate of the nth event. More...
 
double matchPattern (str pattern, double rot, double seglen)
 This function is not implemented yet. It is a work in progress. The intent is as follows: More...
 
 popFront ()
 Discards the first event on the list. More...
 
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. More...
 
- Public Member Functions inherited from ParamValueBase
TypeHandle getValueType ()
 Returns the type of the underlying value. More...
 
 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...
 

Static Public Member Functions

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

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.

Member Function Documentation

◆ __init__()

__init__ ( )

◆ addEvent()

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

clear ( )

Empties all the events from the list.

◆ encircles()

bool encircles ( int  x,
int  y 
)

Returns true if the trail loops around the specified point.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDirection()

double getDirection ( int  n)

Get the direction of the nth event.

◆ getDx()

int getDx ( int  n)

Get the x-coordinate of the nth event.

◆ getDy()

int getDy ( int  n)

Get the y-coordinate of the nth event.

◆ getInWindow()

bool getInWindow ( int  n)

Get the in-window flag of the nth event.

◆ getLength()

double getLength ( int  n)

Get the length of the nth event.

◆ getNumEvents()

int getNumEvents ( )

Returns the number of events in the list.

◆ getRotation()

double getRotation ( int  n)

Get the rotation of the nth event.

◆ getSequence()

int getSequence ( int  n)

Get the sequence number of the nth event.

◆ getTime()

double getTime ( int  n)

Get the timestamp of the nth event.

◆ getXpos()

int getXpos ( int  n)

Get the x-coordinate of the nth event.

◆ getYpos()

int getYpos ( int  n)

Get the y-coordinate of the nth event.

◆ matchPattern()

double matchPattern ( str  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.

◆ popFront()

popFront ( )

Discards the first event on the list.

◆ totalTurns()

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.