Impact Interaction System API
Impact.Objects.ImpactObjectRigidbody Class Reference

Component for Impact Objects that have a rigidbody attached. More...

Inheritance diagram for Impact.Objects.ImpactObjectRigidbody:
Impact.Objects.ImpactObjectSingleMaterial Impact.Objects.ImpactObjectBase Impact.Objects.IImpactObject

Public Member Functions

override VelocityData GetVelocityDataAtPoint (Vector3 contactPoint)
 Gets this object's velocity data at the given point. By default this returns empty data. More...
 
override Vector3 GetContactPointRelativePosition (Vector3 point)
 Gets the local position of the contact point relative to this object's transform. More...
 
- Public Member Functions inherited from Impact.Objects.ImpactObjectSingleMaterial
override int GetMaterialCompositionNonAlloc (Vector3 point, ImpactMaterialComposition[] results)
 Gets the material composition at the given point by filling out the given array. More...
 
override IImpactMaterial GetPrimaryMaterial (Vector3 point)
 Gets the primary material at the given point. More...
 
override IImpactMaterial GetPrimaryMaterial ()
 Gets the primary material without knowing the contact point. More...
 
virtual VelocityData GetVelocityDataAtPoint (Vector3 point)
 Gets this object's velocity data at the given point. By default this returns empty data. More...
 
virtual Vector3 GetContactPointRelativePosition (Vector3 point)
 Gets the local position of the contact point relative to this object's transform. More...
 
abstract int GetMaterialCompositionNonAlloc (Vector3 point, ImpactMaterialComposition[] results)
 Gets the material composition at the given point by filling out the given array. More...
 
abstract IImpactMaterial GetPrimaryMaterial (Vector3 point)
 Gets the primary material at the given point. More...
 
abstract IImpactMaterial GetPrimaryMaterial ()
 Gets the primary material without knowing the contact point. More...
 
int GetMaterialCompositionNonAlloc (Vector3 point, ImpactMaterialComposition[] results)
 Gets the material composition at the given point by filling out the given array. More...
 
IImpactMaterial GetPrimaryMaterial (Vector3 point)
 Gets the primary material at the given point. More...
 
IImpactMaterial GetPrimaryMaterial ()
 Gets the primary material without knowing the contact point. More...
 
VelocityData GetVelocityDataAtPoint (Vector3 contactPoint)
 Gets this object's velocity data at the given point. More...
 
Vector3 GetContactPointRelativePosition (Vector3 point)
 Gets the local position of the contact point relative to this object's transform. More...
 

Protected Member Functions

override void Awake ()
 
virtual void Awake ()
 

Properties

ImpactRigidbodyWrapper Rigidbody [get, set]
 The rigidbody (either 3D or 2D) associated with this object.
 
- Properties inherited from Impact.Objects.ImpactObjectSingleMaterial
ImpactMaterialBase Material [get, set]
 The ImpactMaterialBase this object uses.
 
- Properties inherited from Impact.Objects.ImpactObjectBase
int Priority [get, set]
 How important this object is. More...
 
GameObject GameObject [get]
 The GameObject associated with this object. More...
 
- Properties inherited from Impact.Objects.IImpactObject
int Priority [get]
 How important this object is. More...
 
GameObject GameObject [get]
 The GameObject associated with this object. More...
 

Additional Inherited Members

- Protected Attributes inherited from Impact.Objects.ImpactObjectBase
int _priority
 

Detailed Description

Component for Impact Objects that have a rigidbody attached.

Member Function Documentation

◆ Awake()

override void Impact.Objects.ImpactObjectRigidbody.Awake ( )
protectedvirtual

◆ GetContactPointRelativePosition()

override Vector3 Impact.Objects.ImpactObjectRigidbody.GetContactPointRelativePosition ( Vector3  point)
virtual

Gets the local position of the contact point relative to this object's transform.

Parameters
pointThe world-space point to convert to local space.
Returns
The position of the point in local space.

Reimplemented from Impact.Objects.ImpactObjectBase.

◆ GetVelocityDataAtPoint()

override VelocityData Impact.Objects.ImpactObjectRigidbody.GetVelocityDataAtPoint ( Vector3  point)
virtual

Gets this object's velocity data at the given point. By default this returns empty data.

Parameters
pointThe world-space point to get data for.
Returns
Velocity data for the point.

Reimplemented from Impact.Objects.ImpactObjectBase.