ImpactCFX.ImpactContactPoint Struct Reference

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

Public Member Functions
	ImpactContactPoint (ContactPoint contactPoint3D, Vector3 collisionMessageVelocity, bool invert=false)
	Creates an impact contact point from the given ContactPoint.
	ImpactContactPoint (ContactPoint2D contactPoint2D, Vector3 collisionMessageVelocity, bool invert=false)
	Creates an impact contact point from the given ContactPoint2D.
	ImpactContactPoint (RaycastHit raycastHit3D, bool invert, GameObject sourceObject=null)
	Creates an impact contact point from the given RaycastHit.
	ImpactContactPoint (RaycastHit2D raycastHit2D, bool invert, GameObject sourceObject=null)
	Creates an impact contact point from the given RaycastHit2D.
	ImpactContactPoint (Vector3 point, Vector3 normal, GameObject triggerObject, Collider hitCollider3D, Vector3 collisionMessageVelocity)
	Creates a contact point using the given data.
	ImpactContactPoint (Vector3 point, Vector3 normal, Collider triggerCollider3D, Collider hitCollider3D, Vector3 collisionMessageVelocity)
	Creates a contact point using the given data.
	ImpactContactPoint (Vector3 point, Vector3 normal, GameObject triggerObject, Collider2D hitCollider2D, Vector3 collisionMessageVelocity)
	Creates a contact point using the given data.
	ImpactContactPoint (Vector3 point, Vector3 normal, Collider2D triggerCollider2D, Collider2D hitCollider2D, Vector3 collisionMessageVelocity)
	Creates a contact point using the given data.
	ImpactContactPoint (ImpactContactPoint source, bool invert=false)
	Creates a copy of the given contact point.
	ImpactContactPoint (Vector3 point, Vector3 normal, GameObject triggerObject, PhysicsType physicsType)
	Creates a contact point using the given data.
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.

Constructor & Destructor Documentation

ImpactContactPoint() [1/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	ContactPoint	contactPoint3D,
		Vector3	collisionMessageVelocity,
		bool	invert = false )

Creates an impact contact point from the given ContactPoint.

Parameters

contactPoint3D	The contact point to get data from.
collisionMessageVelocity	Optional velocity provided by the original Collision, if applicable.
invert	Should the trigger and hit objects be swapped?

ImpactContactPoint() [2/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	ContactPoint2D	contactPoint2D,
		Vector3	collisionMessageVelocity,
		bool	invert = false )

Creates an impact contact point from the given ContactPoint2D.

Parameters

contactPoint2D	The contact point to get data from.
collisionMessageVelocity	Optional velocity provided by the original Collision2D, if applicable.
invert	Should the trigger and hit objects be swapped?

ImpactContactPoint() [3/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	RaycastHit	raycastHit3D,
		bool	invert,
		GameObject	sourceObject = null )

Creates an impact contact point from the given RaycastHit.

Parameters

raycastHit3D	The raycast hit data.
invert	Should the trigger and hit objects be swapped?
sourceObject	An optional source object for the raycast.

ImpactContactPoint() [4/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	RaycastHit2D	raycastHit2D,
		bool	invert,
		GameObject	sourceObject = null )

Creates an impact contact point from the given RaycastHit2D.

Parameters

raycastHit2D	The raycast hit data.
invert	Should the trigger and hit objects be swapped?
sourceObject	An optional source object for the raycast.

ImpactContactPoint() [5/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	Vector3	point,
		Vector3	normal,
		GameObject	triggerObject,
		Collider	hitCollider3D,
		Vector3	collisionMessageVelocity )

Creates a contact point using the given data.

Parameters

point	The contact point.
normal	The contact normal.
triggerObject	The object that triggered the collision.
hitCollider3D	The collider that was hit.
collisionMessageVelocity	Optional velocity provided by the original Collision, if applicable.

ImpactContactPoint() [6/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	Vector3	point,
		Vector3	normal,
		Collider	triggerCollider3D,
		Collider	hitCollider3D,
		Vector3	collisionMessageVelocity )

Creates a contact point using the given data.

Parameters

point	The contact point.
normal	The contact normal.
triggerCollider3D	The collider that triggered the collision.
hitCollider3D	The collider that was hit.
collisionMessageVelocity	Optional velocity provided by the original Collision, if applicable.

ImpactContactPoint() [7/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	Vector3	point,
		Vector3	normal,
		GameObject	triggerObject,
		Collider2D	hitCollider2D,
		Vector3	collisionMessageVelocity )

Creates a contact point using the given data.

Parameters

point	The contact point.
normal	The contact normal.
triggerObject	The object that triggered the collision.
hitCollider2D	The collider that was hit.
collisionMessageVelocity	Optional velocity provided by the original Collision, if applicable.

ImpactContactPoint() [8/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	Vector3	point,
		Vector3	normal,
		Collider2D	triggerCollider2D,
		Collider2D	hitCollider2D,
		Vector3	collisionMessageVelocity )

Creates a contact point using the given data.

Parameters

point	The contact point.
normal	The contact normal.
triggerCollider2D	The collider that triggered the collision.
hitCollider2D	The collider that was hit.
collisionMessageVelocity	Optional velocity provided by the original Collision, if applicable.

ImpactContactPoint() [9/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	ImpactContactPoint	source,
		bool	invert = false )

Creates a copy of the given contact point.

Parameters

source	The original contact point.
invert	Should the trigger and hit objects be swapped?

ImpactContactPoint() [10/10]

ImpactCFX.ImpactContactPoint.ImpactContactPoint	(	Vector3	point,
		Vector3	normal,
		GameObject	triggerObject,
		PhysicsType	physicsType )

Creates a contact point using the given data.

Parameters

point	The contact point.
normal	The contact normal.
triggerObject	The object that triggered the collision.
physicsType	Whether this is a 3D or 2D physics 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.