Impact CFX API 1.5.3
Comprehensive API documentation for Impact CFX - Collision Effects System
Loading...
Searching...
No Matches
ImpactCFX.ImpactObjectRigidbody Class Reference

Implementation of an Impact Object for objects with a 3D or 2D rigidbody. More...

Inheritance diagram for ImpactCFX.ImpactObjectRigidbody:
ImpactCFX.ImpactObjectRigidbodyCheap ImpactCFX.ImpactObjectSingleMaterial ImpactCFX.ImpactObjectBase ImpactCFX.IImpactObject

Public Member Functions

override RigidbodyData GetRigidbodyData ()
 Gets the rigidbody velocity data for this object.
 
- Public Member Functions inherited from ImpactCFX.ImpactObjectRigidbodyCheap
void FindRigidbody ()
 Attempts to find a rigidbody to reference from this object or one of its parents.
 
void SetRigidbody (Rigidbody rigidbody)
 Sets the 3D physics rigidbody referenced by this object.
 
void SetRigidbody2D (Rigidbody2D rigidbody)
 Sets the 2D physics rigidbody referenced by this object.
 
void ClearRigidbody ()
 Clears the rigidbody reference from this object (does not destroy the rigidbody).
 
void SyncRigidbodyData ()
 Forces the object to sync its cached rigidbody data with the current rigidbody state.
 
override RigidbodyData GetRigidbodyData ()
 Gets the rigidbody velocity data for this object.
 
- Public Member Functions inherited from ImpactCFX.ImpactObjectSingleMaterial
override void RegisterMaterials ()
 Tells this object to register its material(s) with the Impact CFX Manager.
 
override RigidbodyData GetRigidbodyData ()
 Gets the rigidbody velocity data for this object.
 
- Public Member Functions inherited from ImpactCFX.ImpactObjectBase
virtual int GetID ()
 Gets a unique identifier for this object.
 
abstract RigidbodyData GetRigidbodyData ()
 Gets the rigidbody velocity data for this object.
 
abstract void RegisterMaterials ()
 Tells this object to register its material(s) with the Impact CFX Manager.
 
virtual int GetPriority ()
 Gets the priority for this object.
 
virtual Vector3 GetContactPointRelativePosition (Vector3 point)
 Gets the local position of the contact point relative to this object's transform.
 
GameObject GetGameObject ()
 Gets the game object associated with this object.
 
override string ToString ()
 
int GetID ()
 Gets a unique identifier for this object.
 
int GetPriority ()
 Gets the priority for this object.
 
RigidbodyData GetRigidbodyData ()
 Gets the rigidbody data for this object.
 
GameObject GetGameObject ()
 Gets the game object assoicated with this object.
 
Vector3 GetContactPointRelativePosition (Vector3 point)
 Gets the local position of a contact point relative to the object's transform.
 

Protected Member Functions

override void Awake ()
 
virtual void Awake ()
 

Additional Inherited Members

- Properties inherited from ImpactCFX.ImpactObjectRigidbodyCheap
RigidbodyContainer RigidbodyContainer [get]
 Container for handling 2D and 3D rigidbody references.
 
- Properties inherited from ImpactCFX.ImpactObjectSingleMaterial
ImpactMaterialAuthoring Material [get, set]
 The Impact Material associated with this object.
 

Detailed Description

Implementation of an Impact Object for objects with a 3D or 2D rigidbody.

Member Function Documentation

◆ Awake()

override void ImpactCFX.ImpactObjectRigidbody.Awake ( )
protectedvirtual

◆ GetRigidbodyData()

override RigidbodyData ImpactCFX.ImpactObjectRigidbody.GetRigidbodyData ( )
virtual

Gets the rigidbody velocity data for this object.

Implements ImpactCFX.ImpactObjectBase.