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

Defines a single collision event. More...

Inheritance diagram for CollisionEntry:
TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

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 More...
 
bool getAll (const NodePath space, LPoint3 surface_point, LVector3 surface_normal, LPoint3 interior_point)
 Simultaneously transforms the surface point, surface normal, and interior point of the collision into the indicated coordinate space. More...
 
bool getAllContactInfo (const NodePath space, LPoint3 contact_pos, LVector3 contact_normal)
 Simultaneously transforms the contact position and contact normal of the collision into the indicated coordinate space. More...
 
LVector3 getContactNormal (const NodePath space)
 Returns the surface normal of the "into" object at the contact position. More...
 
LPoint3 getContactPos (const NodePath space)
 Returns the position of the "from" object at the instant that a collision is first detected. More...
 
const CollisionSolid getFrom ()
 Returns the CollisionSolid pointer for the particular solid that triggered this collision. More...
 
CollisionNode getFromNode ()
 Returns the node that contains the CollisionSolid that triggered this collision. More...
 
NodePath getFromNodePath ()
 Returns the NodePath that represents the CollisionNode that contains the CollisionSolid that triggered this collision. More...
 
LPoint3 getInteriorPoint (const NodePath space)
 Returns the point, within the interior of the "into" object, which represents the depth to which the "from" object has penetrated. More...
 
const CollisionSolid getInto ()
 Returns the CollisionSolid pointer for the particular solid was collided into. More...
 
PandaNode getIntoNode ()
 Returns the node that contains the CollisionSolid that was collided into. More...
 
NodePath getIntoNodePath ()
 Returns the NodePath that represents the specific CollisionNode or GeomNode instance that was collided into. More...
 
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. More...
 
LVector3 getSurfaceNormal (const NodePath space)
 Returns the surface normal of the "into" object at the point at which a collision is detected. More...
 
LPoint3 getSurfacePoint (const NodePath space)
 Returns the point, on the surface of the "into" object, at which a collision is detected. More...
 
float getT ()
 returns time value for this collision relative to other CollisionEntries More...
 
bool hasContactNormal ()
 Returns true if the contact normal has been specified, false otherwise. More...
 
bool hasContactPos ()
 Returns true if the contact position has been specified, false otherwise. More...
 
bool hasInteriorPoint ()
 Returns true if the interior point has been specified, false otherwise. More...
 
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). More...
 
bool hasSurfaceNormal ()
 Returns true if the surface normal has been specified, false otherwise. More...
 
bool hasSurfacePoint ()
 Returns true if the surface point has been specified, false otherwise. More...
 
 output (Ostream out)
 
 resetCollided ()
 prepare for another collision test More...
 
 setContactNormal (const LVector3 normal)
 Stores the surface normal of the "into" object at the contact pos. More...
 
 setContactPos (const LPoint3 pos)
 Stores the position of the "from" object at the instant at which the collision is first detected. More...
 
 setInteriorPoint (const LPoint3 point)
 Stores the point, within the interior of the "into" object, which represents the depth to which the "from" object has penetrated. More...
 
 setSurfaceNormal (const LVector3 normal)
 Stores the surface normal of the "into" object at the point of the intersection. More...
 
 setSurfacePoint (const LPoint3 point)
 Stores the point, on the surface of the "into" object, at which a collision is detected. More...
 
 setT (float t)
 Sets a time value for this collision relative to other CollisionEntries. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. 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. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

CollisionNode from_node
 Returns the node that contains the CollisionSolid that triggered this collision. More...
 
NodePath from_node_path
 Returns the NodePath that represents the CollisionNode that contains the CollisionSolid that triggered this collision. More...
 
const CollisionSolid from_solid
 Returns the CollisionSolid pointer for the particular solid that triggered this collision. More...
 
PandaNode into_node
 Returns the node that contains the CollisionSolid that was collided into. More...
 
NodePath into_node_path
 Returns the NodePath that represents the specific CollisionNode or GeomNode instance that was collided into. More...
 
const CollisionSolid into_solid
 Returns the CollisionSolid pointer for the particular solid was collided into. More...
 
bool respect_prev_transform
 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. More...
 
float t
 returns time value for this collision relative to other CollisionEntries More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

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.

Member Function Documentation

◆ collided()

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

◆ getAll()

bool getAll ( const NodePath  space,
LPoint3  surface_point,
LVector3  surface_normal,
LPoint3  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.

◆ getAllContactInfo()

bool getAllContactInfo ( const NodePath  space,
LPoint3  contact_pos,
LVector3  contact_normal 
)

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.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getContactNormal()

LVector3 getContactNormal ( const NodePath  space)

Returns the surface normal of the "into" object at the contact position.

The normal will be converted into whichever coordinate space the caller specifies.

◆ getContactPos()

LPoint3 getContactPos ( const NodePath  space)

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.

◆ getFrom()

const CollisionSolid getFrom ( )

Returns the CollisionSolid pointer for the particular solid that triggered this collision.

◆ getFromNode()

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

◆ getFromNodePath()

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

◆ getInteriorPoint()

LPoint3 getInteriorPoint ( const NodePath  space)

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.

◆ getInto()

const CollisionSolid 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().

◆ getIntoNode()

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

◆ getIntoNodePath()

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.

◆ getRespectPrevTransform()

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.

◆ getSurfaceNormal()

LVector3 getSurfaceNormal ( const NodePath  space)

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.

◆ getSurfacePoint()

LPoint3 getSurfacePoint ( const NodePath  space)

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.

◆ getT()

float getT ( )

returns time value for this collision relative to other CollisionEntries

◆ hasContactNormal()

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.

◆ hasContactPos()

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.

◆ hasInteriorPoint()

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.

◆ hasInto()

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.

◆ hasSurfaceNormal()

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.

◆ hasSurfacePoint()

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.

◆ output()

output ( Ostream  out)

◆ resetCollided()

resetCollided ( )

prepare for another collision test

◆ setContactNormal()

setContactNormal ( const LVector3  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()

setContactPos ( const LPoint3  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()

setInteriorPoint ( const LPoint3  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()

setSurfaceNormal ( const LVector3  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()

setSurfacePoint ( const LPoint3  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()

setT ( float  t)

Sets a time value for this collision relative to other CollisionEntries.

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ from_node

CollisionNode from_node

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

◆ from_node_path

NodePath from_node_path

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

◆ from_solid

const CollisionSolid from_solid

Returns the CollisionSolid pointer for the particular solid that triggered this collision.

◆ into_node

PandaNode into_node

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

◆ into_node_path

NodePath into_node_path

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.

◆ into_solid

const CollisionSolid into_solid

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

◆ respect_prev_transform

bool respect_prev_transform

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.

◆ t

float t

returns time value for this collision relative to other CollisionEntries