EventParameter¶
from panda3d.core import EventParameter
-
class
EventParameter
¶ 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
-
__init__
()¶
-
__init__
(copy: EventParameter)
-
__init__
(ptr: TypedReferenceCount) Defines an
EventParameter
that stores a pointer to aTypedReferenceCount
object. Note that aTypedReferenceCount
is not the same kind of pointer as aTypedWritableReferenceCount
, hence we require both constructors.This accepts a const pointer, even though it stores (and eventually returns) a non-const pointer. This is just the simplest way to allow both const and non-const pointers to be stored, but it does lose the constness. Be careful.
-
__init__
(ptr: TypedWritableReferenceCount) Defines an
EventParameter
that stores a pointer to any kind ofTypedWritableReferenceCount
object. This is the most general constructor.This accepts a const pointer, even though it stores (and eventually returns) a non-const pointer. This is just the simplest way to allow both const and non-const pointers to be stored, but it does lose the constness. Be careful.
-
__init__
(value: float) Defines an
EventParameter
that stores a floating-point value.
-
__init__
(value: int) Defines an
EventParameter
that stores an integer value.
-
__init__
(param0: nullptr_t)
-
__init__
(value: str) Defines an
EventParameter
that stores a string value.
-
__init__
(value: str) Defines an
EventParameter
that stores a wstring value.
-
assign
(copy: EventParameter) → EventParameter¶
-
getDoubleValue
() → float¶ Retrieves the value stored in the
EventParameter
. It is only valid to call this ifisDouble()
has already returned true.
-
getIntValue
() → int¶ Retrieves the value stored in the
EventParameter
. It is only valid to call this ifisInt()
has already returned true.
-
getPtr
() → TypedWritableReferenceCount¶ 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
() → str¶ Retrieves the value stored in the
EventParameter
. It is only valid to call this ifisString()
has already returned true.
-
getTypedRefCountValue
() → TypedReferenceCount¶ Retrieves the value stored in the
EventParameter
. It is only valid to call this ifisTypedRefCount()
has already returned true.
-
getWstringValue
() → str¶ Retrieves the value stored in the
EventParameter
. It is only valid to call this ifisWstring()
has already returned true.
-
isDouble
() → bool¶ Returns true if the
EventParameter
stores a double floating-point value, false otherwise.
-
isEmpty
() → bool¶ 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 theEventParameter
is some user-defined type, and is none of these.
-
isInt
() → bool¶ Returns true if the
EventParameter
stores an integer value, false otherwise.
-
isString
() → bool¶ Returns true if the
EventParameter
stores a string value, false otherwise.
-
isTypedRefCount
() → bool¶ Returns true if the
EventParameter
stores aTypedReferenceCount
pointer, false otherwise. Note that aTypedReferenceCount
is not exactly the same kind of pointer as aTypedWritableReferenceCount
, hence the need for this separate call.
-
isWstring
() → bool¶ Returns true if the
EventParameter
stores a wstring value, false otherwise.
-