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

Implementation of an Impact Object specifically for terrains. More...

Inheritance diagram for ImpactCFX.ImpactObjectTerrain:
ImpactCFX.ImpactObjectBase ImpactCFX.IImpactObject

Public Member Functions

override void RegisterMaterials ()
 Tells this object to register its material(s) with the Impact CFX Manager.
 
void RefreshCachedData ()
 Refresh the cached alphamaps and terrain materials. You should call this if you ever modify your terrain at runtime.
 
void SyncTerrainLayersAndMaterialsList ()
 
override RigidbodyData GetRigidbodyData ()
 Gets the rigidbody velocity data for this object.
 
TerrainLayer[] GetTerrainLayers ()
 Gets the array of terrain layers defined in the terrain data.
 
NativeArray< float > GetAlphamaps ()
 Gets a flattened array of the terrain's texture alphamaps/splatmaps.
 
NativeArray< int > GetTerrainLayerMaterialIDs ()
 Gets the array of impact material IDs assigned to the terrain layers.
 
- 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 assoicated 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.
 

Properties

bool HasValidTerrain [get]
 Does this object have a valid terrain assigned?
 
int TerrainLayerCount [get]
 The number of terrain layers the terrain has.
 
int AlphamapResolution [get]
 The resolution of the terrain's splatmap/alphamap.
 
int DefaultMaterialID [get]
 The ID of the default fallback Impact Material, if one is set.
 
Vector3 Size [get]
 The size of the terrain in world units.
 

Detailed Description

Implementation of an Impact Object specifically for terrains.

Member Function Documentation

◆ GetRigidbodyData()

override RigidbodyData ImpactCFX.ImpactObjectTerrain.GetRigidbodyData ( )
virtual

Gets the rigidbody velocity data for this object.

Implements ImpactCFX.ImpactObjectBase.

◆ RegisterMaterials()

override void ImpactCFX.ImpactObjectTerrain.RegisterMaterials ( )
virtual

Tells this object to register its material(s) with the Impact CFX Manager.

Implements ImpactCFX.ImpactObjectBase.