Panda3D
Public Member Functions | Static Public Member Functions

Event Class Reference

A named event, possibly with parameters. More...

Inheritance diagram for Event:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

List of all members.

Public Member Functions

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


Constructor & Destructor Documentation

Event ( Event const  copy)
Event ( string  event_name,
EventReceiver  receiver 
)
Event ( string  event_name)

Member Function Documentation

addParameter ( EventParameter const  obj)
clearName ( )

Resets the Event's name to empty.

clearReceiver ( )
static TypeHandle getClassType ( ) [static]

Reimplemented from TypedReferenceCount.

string getName ( )
int getNumParameters ( )
EventParameter getParameter ( int  n)
list getParameters ( )
EventReceiver getReceiver ( )
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 hasName ( )

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

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

Event operator= ( Event const  copy)
output ( ostream  out)
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.

setName ( string  name)
setReceiver ( EventReceiver  receiver)
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