Panda3D
|
Defines a single collision event. More...
Public Member Functions | |
bool | collided () |
returns true if this represents an actual collision as opposed to a potential collision, needed for iterative collision resolution where path of collider changes mid-frame | |
string | encodeToBamStream () |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. | |
bool | encodeToBamStream (basic_stringchar data, BamWriter writer) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
bool | encodeToBamStream (basic_stringchar data) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
bool | getAll (NodePath const space, Point3 surface_point, Vec3 surface_normal, Point3 interior_point) |
Simultaneously transforms the surface point, surface normal, and interior point of the collision into the indicated coordinate space. | |
bool | getAllContactInfo (NodePath const space, Point3 contact_pos, Vec3 contact_normal) |
Simultaneously transforms the contact position and contact normal of the collision into the indicated coordinate space. | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. | |
Vec3 | getContactNormal (NodePath const space) |
Returns the surface normal of the "into" object at the contact position. | |
Point3 | getContactPos (NodePath const space) |
Returns the position of the "from" object at the instant that a collision is first detected. | |
CollisionSolid const | getFrom () |
Returns the CollisionSolid pointer for the particular solid that triggered this collision. | |
CollisionNode | getFromNode () |
Returns the node that contains the CollisionSolid that triggered this collision. | |
NodePath | getFromNodePath () |
Returns the NodePath that represents the CollisionNode that contains the CollisionSolid that triggered this collision. | |
Point3 | getInteriorPoint (NodePath const space) |
Returns the point, within the interior of the "into" object, which represents the depth to which the "from" object has penetrated. | |
CollisionSolid const | getInto () |
Returns the CollisionSolid pointer for the particular solid was collided into. | |
PandaNode | getIntoNode () |
Returns the node that contains the CollisionSolid that was collided into. | |
NodePath | getIntoNodePath () |
Returns the NodePath that represents the specific CollisionNode or GeomNode instance that was collided into. | |
int | getRefCount () |
Returns the current reference count. | |
bool | getRespectPrevTransform () |
Returns true if the collision was detected by a CollisionTraverser whose respect_prev_transform flag was set true, meaning we should consider motion significant in evaluating collisions. | |
Vec3 | getSurfaceNormal (NodePath const space) |
Returns the surface normal of the "into" object at the point at which a collision is detected. | |
Point3 | getSurfacePoint (NodePath const space) |
Returns the point, on the surface of the "into" object, at which a collision is detected. | |
float | getT () |
returns time value for this collision relative to other CollisionEntries | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
bool | hasContactNormal () |
Returns true if the contact normal has been specified, false otherwise. | |
bool | hasContactPos () |
Returns true if the contact position has been specified, false otherwise. | |
bool | hasInteriorPoint () |
Returns true if the interior point has been specified, false otherwise. | |
bool | hasInto () |
Returns true if the "into" solid is, in fact, a CollisionSolid, and its pointer is known (in which case get_into() may be called to retrieve it). | |
bool | hasSurfaceNormal () |
Returns true if the surface normal has been specified, false otherwise. | |
bool | hasSurfacePoint () |
Returns true if the surface point has been specified, false otherwise. | |
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. | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. | |
output (ostream out) | |
PyObject | reduce (PyObject self) |
This special Python method is implement to provide support for the pickle module. | |
PyObject | reducePersist (PyObject self, PyObject pickler) |
This special Python method is implement to provide support for the pickle module. | |
ref () | |
Explicitly increments the reference count. | |
resetCollided () | |
prepare for another collision test | |
setContactNormal (Vec3 const normal) | |
Stores the surface normal of the "into" object at the contact pos. | |
setContactPos (Point3 const pos) | |
Stores the position of the "from" object at the instant at which the collision is first detected. | |
setInteriorPoint (Point3 const point) | |
Stores the point, within the interior of the "into" object, which represents the depth to which the "from" object has penetrated. | |
setSurfaceNormal (Vec3 const normal) | |
Stores the surface normal of the "into" object at the point of the intersection. | |
setSurfacePoint (Point3 const point) | |
Stores the point, on the surface of the "into" object, at which a collision is detected. | |
setT (float t) | |
Sets a time value for this collision relative to other CollisionEntries. | |
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. | |
write (ostream out) | |
write (ostream out, int indent_level) | |
Static Public Member Functions | |
static TypedWritableReferenceCount | decodeFromBamStream (string 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. | |
static TypedWritableReferenceCount | decodeFromBamStream (string data) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. | |
static TypeHandle | getClassType () |
Defines a single collision event.
One of these is created for each collision detected by a CollisionTraverser, to be dealt with by the CollisionHandler.
A CollisionEntry provides slots for a number of data values (such as intersection point and normal) that might or might not be known for each collision. It is up to the handler to determine what information is known and to do the right thing with it.
bool collided | ( | ) |
returns true if this represents an actual collision as opposed to a potential collision, needed for iterative collision resolution where path of collider changes mid-frame
static TypedWritableReferenceCount decodeFromBamStream | ( | string | data, |
BamReader | reader | ||
) | [static, inherited] |
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.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
static TypedWritableReferenceCount decodeFromBamStream | ( | string | data | ) | [static, inherited] |
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.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
string encodeToBamStream | ( | ) | [inherited] |
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.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data, |
BamWriter | writer | ||
) | [inherited] |
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.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data | ) | [inherited] |
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.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool getAll | ( | NodePath const | space, |
Point3 | surface_point, | ||
Vec3 | surface_normal, | ||
Point3 | interior_point | ||
) |
Simultaneously transforms the surface point, surface normal, and interior point of the collision into the indicated coordinate space.
Returns true if all three properties are available, or false if any one of them is not.
Simultaneously transforms the contact position and contact normal of the collision into the indicated coordinate space.
Returns true if all three properties are available, or false if any one of them is not.
UpdateSeq getBamModified | ( | ) | [inherited] |
Returns the current bam_modified counter.
This counter is normally incremented automatically whenever the object is modified.
static TypeHandle getClassType | ( | ) | [static] |
Reimplemented from TypedWritableReferenceCount.
Returns the surface normal of the "into" object at the contact position.
The normal will be converted into whichever coordinate space the caller specifies.
Returns the position of the "from" object at the instant that a collision is first detected.
The position will be converted into whichever coordinate space the caller specifies.
CollisionSolid const getFrom | ( | ) |
Returns the CollisionSolid pointer for the particular solid that triggered this collision.
CollisionNode getFromNode | ( | ) |
Returns the node that contains the CollisionSolid that triggered this collision.
This will be a node that has been added to a CollisionTraverser via add_collider().
NodePath getFromNodePath | ( | ) |
Returns the NodePath that represents the CollisionNode that contains the CollisionSolid that triggered this collision.
This will be a NodePath that has been added to a CollisionTraverser via add_collider().
Returns the point, within the interior of the "into" object, which represents the depth to which the "from" object has penetrated.
This can also be described as the intersection point on the surface of the "from" object (which is inside the "into" object). It can be thought of as the deepest point of intersection.
The point will be converted into whichever coordinate space the caller specifies.
CollisionSolid const getInto | ( | ) |
Returns the CollisionSolid pointer for the particular solid was collided into.
This pointer might be NULL if the collision was into a piece of visible geometry, instead of a normal CollisionSolid collision; see has_into().
PandaNode getIntoNode | ( | ) |
Returns the node that contains the CollisionSolid that was collided into.
This returns a PandaNode pointer instead of something more specific, because it might be either a CollisionNode or a GeomNode.
Also see get_into_node_path().
NodePath getIntoNodePath | ( | ) |
Returns the NodePath that represents the specific CollisionNode or GeomNode instance that was collided into.
This is the same node returned by get_into_node(), represented as a NodePath; however, it may be more useful because the NodePath can resolve the particular instance of the node, if there is more than one.
int getRefCount | ( | ) | [inherited] |
Returns the current reference count.
bool getRespectPrevTransform | ( | ) |
Returns true if the collision was detected by a CollisionTraverser whose respect_prev_transform flag was set true, meaning we should consider motion significant in evaluating collisions.
Returns the surface normal of the "into" object at the point at which a collision is detected.
The normal will be converted into whichever coordinate space the caller specifies.
Returns the point, on the surface of the "into" object, at which a collision is detected.
This can be thought of as the first point of intersection. However the contact point is the actual first point of intersection.
The point will be converted into whichever coordinate space the caller specifies.
float getT | ( | ) |
returns time value for this collision relative to other CollisionEntries
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 hasContactNormal | ( | ) |
Returns true if the contact normal has been specified, false otherwise.
See get_contact_normal(). Some types of collisions may not compute the contact normal.
bool hasContactPos | ( | ) |
Returns true if the contact position has been specified, false otherwise.
See get_contact_pos(). Some types of collisions may not compute the contact pos.
bool hasInteriorPoint | ( | ) |
Returns true if the interior point has been specified, false otherwise.
See get_interior_point(). Some types of collisions may not compute the interior point.
bool hasInto | ( | ) |
Returns true if the "into" solid is, in fact, a CollisionSolid, and its pointer is known (in which case get_into() may be called to retrieve it).
If this returns false, the collision was detected into a GeomNode, and there is no CollisionSolid pointer to be retrieved.
bool hasSurfaceNormal | ( | ) |
Returns true if the surface normal has been specified, false otherwise.
See get_surface_normal(). Some types of collisions may not compute the surface normal.
bool hasSurfacePoint | ( | ) |
Returns true if the surface point has been specified, false otherwise.
See get_surface_point(). Some types of collisions may not compute the surface point.
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.
markBamModified | ( | ) | [inherited] |
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.
output | ( | ostream | out | ) |
PyObject reduce | ( | PyObject | self | ) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.
PyObject reducePersist | ( | PyObject | self, |
PyObject | pickler | ||
) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.
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.
resetCollided | ( | ) |
prepare for another collision test
setContactNormal | ( | Vec3 const | normal | ) |
Stores the surface normal of the "into" object at the contact pos.
This normal is specified in the coordinate space of the "into" object.
setContactPos | ( | Point3 const | pos | ) |
Stores the position of the "from" object at the instant at which the collision is first detected.
This position is specified in the coordinate space of the "into" object.
setInteriorPoint | ( | Point3 const | point | ) |
Stores the point, within the interior of the "into" object, which represents the depth to which the "from" object has penetrated.
This can also be described as the intersection point on the surface of the "from" object (which is inside the "into" object).
This point is specified in the coordinate space of the "into" object.
setSurfaceNormal | ( | Vec3 const | normal | ) |
Stores the surface normal of the "into" object at the point of the intersection.
This normal is specified in the coordinate space of the "into" object.
setSurfacePoint | ( | Point3 const | point | ) |
Stores the point, on the surface of the "into" object, at which a collision is detected.
This point is specified in the coordinate space of the "into" object.
setT | ( | float | t | ) |
Sets a time value for this collision relative to other CollisionEntries.
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.
write | ( | ostream | out | ) |