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

A named event, possibly with parameters. Anyone in any thread may throw an event at any time; there will be one process responsible for reading and dispacting on the events (but not necessarily immediately). More...

Inheritance diagram for Event:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

Public Member Functions

 __init__ (const Event copy)
 
 __init__ (str event_name, EventReceiver receiver)
 
 addParameter (const EventParameter obj)
 
 clearName ()
 Resets the Event's name to empty. More...
 
 clearReceiver ()
 
str getName ()
 
int getNumParameters ()
 
EventParameter getParameter (int n)
 
list getParameters ()
 
EventReceiver getReceiver ()
 
bool hasName ()
 Returns true if the Event has a nonempty name set, false if the name is empty. More...
 
bool hasReceiver ()
 
Event operator= (const Event copy)
 
 output (Ostream out)
 
 setName (str name)
 
 setReceiver (EventReceiver receiver)
 
- 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 TypedReferenceCount
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

A named event, possibly with parameters. Anyone in any thread may throw an event at any time; there will be one process responsible for reading and dispacting on the events (but not necessarily immediately).

This function use to inherit from Namable, but that makes it too expensive to get its name the Python code. Now it just copies the Namable interface in.

Member Function Documentation

◆ __init__() [1/2]

__init__ ( const Event  copy)

◆ __init__() [2/2]

__init__ ( str  event_name,
EventReceiver  receiver 
)

◆ addParameter()

addParameter ( const EventParameter  obj)

◆ clearName()

clearName ( )

Resets the Event's name to empty.

◆ clearReceiver()

clearReceiver ( )

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getName()

str getName ( )

◆ getNumParameters()

int getNumParameters ( )

◆ getParameter()

EventParameter getParameter ( int  n)

◆ getParameters()

list getParameters ( )

◆ getReceiver()

EventReceiver getReceiver ( )

◆ hasName()

bool hasName ( )

Returns true if the Event has a nonempty name set, false if the name is empty.

◆ hasReceiver()

bool hasReceiver ( )

◆ operator=()

Event operator= ( const Event  copy)

◆ output()

output ( Ostream  out)

◆ setName()

setName ( str  name)

◆ setReceiver()

setReceiver ( EventReceiver  receiver)