Impact CFX API 1.3.0
Comprehensive API documentation for Impact CFX - Collision Effects System
Loading...
Searching...
No Matches
ImpactCFX.ImpactContactPoint Struct Reference

Wraps data for a single 3D or 2D contact point. More...

Public Member Functions

 ImpactContactPoint (ContactPoint contactPoint3D, Vector3 collisionMessageVelocity)
 
 ImpactContactPoint (ContactPoint2D contactPoint2D, Vector3 collisionMessageVelocity)
 
 ImpactContactPoint (RaycastHit raycastHit3D, bool invert, GameObject sourceObject=null)
 
 ImpactContactPoint (RaycastHit2D raycastHit2D, bool invert, GameObject sourceObject=null)
 
 ImpactContactPoint (Vector3 point, Vector3 normal, GameObject triggerObject, Collider hitCollider3D, Vector3 collisionMessageVelocity)
 
 ImpactContactPoint (Vector3 point, Vector3 normal, GameObject triggerObject, Collider2D hitCollider2D, Vector3 collisionMessageVelocity)
 
 ImpactContactPoint (Vector3 point, Vector3 normal, GameObject triggerObject, PhysicsType physicsType)
 
int GetTriggerObjectPhysicsMaterialID ()
 Get the ID of the physics material belonging to the collider that triggered the collision.
 
int GetHitObjectPhysicsMaterialID ()
 Get the ID of the physics material belonging to the collider being collided with.
 
int GetTriggerObjectID ()
 Get the ID the object that triggered the collision.
 
int GetHitObjectID ()
 Get the ID the object that was hit.
 

Public Attributes

Vector3 Point
 The position of the contact point.
 
Vector3 Normal
 The normal of the contact.
 
GameObject TriggerObject
 The specific collider object that triggered the collision.
 
GameObject HitObject
 The collider object being collided with.
 
Vector3 CollisionMessageVelocity
 The collision velocity provided by the collision message.
 

Detailed Description

Wraps data for a single 3D or 2D contact point.

Member Function Documentation

◆ GetHitObjectID()

int ImpactCFX.ImpactContactPoint.GetHitObjectID ( )

Get the ID the object that was hit.

Returns
The ID the object that was hit. Will return 0 if the object is not known.

◆ GetHitObjectPhysicsMaterialID()

int ImpactCFX.ImpactContactPoint.GetHitObjectPhysicsMaterialID ( )

Get the ID of the physics material belonging to the collider being collided with.

Returns
The ID of the physics material. Will return 0 if there is no material.

◆ GetTriggerObjectID()

int ImpactCFX.ImpactContactPoint.GetTriggerObjectID ( )

Get the ID the object that triggered the collision.

Returns
The ID of the object that triggered the collision. Will return 0 if the object is not known.

◆ GetTriggerObjectPhysicsMaterialID()

int ImpactCFX.ImpactContactPoint.GetTriggerObjectPhysicsMaterialID ( )

Get the ID of the physics material belonging to the collider that triggered the collision.

Returns
The ID of the physics material. Will return 0 if there is no material.