EventParameter

from panda3d.core import EventParameter
class EventParameter

Bases: DTOOL_SUPER_BASE

An optional parameter associated with an event. Each event may have zero or more of these. Each parameter stores a pointer to a TypedWritableReferenceCount object, which of course could be pretty much anything. To store a simple value like a double or a string, the EventParameter constructors transparently use the ParamValue template class from paramValue.h.

Inheritance diagram

Inheritance diagram of EventParameter

__init__(*args, **kwargs)
assign()

C++ Interface: assign(const EventParameter self, const EventParameter copy)

/**

*/

getDoubleValue()

C++ Interface: get_double_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_double() has already returned true.

*/

getIntValue()

C++ Interface: get_int_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_int() has already returned true.

*/

getPtr()

C++ Interface: get_ptr(EventParameter self)

/**

  • Retrieves a pointer to the actual value stored in the parameter. The

  • TypeHandle of this pointer may be examined to determine the actual type of

  • parameter it contains. This is the only way to retrieve the value when it

  • is not one of the above predefined types.

*/

getStringValue()

C++ Interface: get_string_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_string() has already returned true.

*/

getTypedRefCountValue()

C++ Interface: get_typed_ref_count_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_typed_ref_count() has already returned true.

*/

getWstringValue()

C++ Interface: get_wstring_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_wstring() has already returned true.

*/

get_double_value()

C++ Interface: get_double_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_double() has already returned true.

*/

get_int_value()

C++ Interface: get_int_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_int() has already returned true.

*/

get_ptr()

C++ Interface: get_ptr(EventParameter self)

/**

  • Retrieves a pointer to the actual value stored in the parameter. The

  • TypeHandle of this pointer may be examined to determine the actual type of

  • parameter it contains. This is the only way to retrieve the value when it

  • is not one of the above predefined types.

*/

get_string_value()

C++ Interface: get_string_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_string() has already returned true.

*/

get_typed_ref_count_value()

C++ Interface: get_typed_ref_count_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_typed_ref_count() has already returned true.

*/

get_wstring_value()

C++ Interface: get_wstring_value(EventParameter self)

/**

  • Retrieves the value stored in the EventParameter. It is only valid to call

  • this if is_wstring() has already returned true.

*/

isDouble()

C++ Interface: is_double(EventParameter self)

/**

  • Returns true if the EventParameter stores a double floating-point value,

  • false otherwise.

*/

isEmpty()

C++ Interface: is_empty(EventParameter self)

// These functions are conveniences to easily determine if the // EventParameter is one of the predefined parameter types, and retrieve the // corresponding value. Of course, it is possible that the EventParameter // is some user-defined type, and is none of these.

/**

  • Returns true if the EventParameter is the empty parameter, storing nothing,

  • or false otherwise.

*/

isInt()

C++ Interface: is_int(EventParameter self)

/**

  • Returns true if the EventParameter stores an integer value, false

  • otherwise.

*/

isString()

C++ Interface: is_string(EventParameter self)

/**

  • Returns true if the EventParameter stores a string value, false otherwise.

*/

isTypedRefCount()

C++ Interface: is_typed_ref_count(EventParameter self)

/**

  • Returns true if the EventParameter stores a TypedReferenceCount pointer,

  • false otherwise. Note that a TypedReferenceCount is not exactly the same

  • kind of pointer as a TypedWritableReferenceCount, hence the need for this

  • separate call.

*/

isWstring()

C++ Interface: is_wstring(EventParameter self)

/**

  • Returns true if the EventParameter stores a wstring value, false otherwise.

*/

is_double()

C++ Interface: is_double(EventParameter self)

/**

  • Returns true if the EventParameter stores a double floating-point value,

  • false otherwise.

*/

is_empty()

C++ Interface: is_empty(EventParameter self)

// These functions are conveniences to easily determine if the // EventParameter is one of the predefined parameter types, and retrieve the // corresponding value. Of course, it is possible that the EventParameter // is some user-defined type, and is none of these.

/**

  • Returns true if the EventParameter is the empty parameter, storing nothing,

  • or false otherwise.

*/

is_int()

C++ Interface: is_int(EventParameter self)

/**

  • Returns true if the EventParameter stores an integer value, false

  • otherwise.

*/

is_string()

C++ Interface: is_string(EventParameter self)

/**

  • Returns true if the EventParameter stores a string value, false otherwise.

*/

is_typed_ref_count()

C++ Interface: is_typed_ref_count(EventParameter self)

/**

  • Returns true if the EventParameter stores a TypedReferenceCount pointer,

  • false otherwise. Note that a TypedReferenceCount is not exactly the same

  • kind of pointer as a TypedWritableReferenceCount, hence the need for this

  • separate call.

*/

is_wstring()

C++ Interface: is_wstring(EventParameter self)

/**

  • Returns true if the EventParameter stores a wstring value, false otherwise.

*/

output()

C++ Interface: output(EventParameter self, ostream out)

/**

*/