ImpactCFX.ImpactCFXGlobal Class Reference

Global class for managing and interfacing with the active impact instance. More...

Static Public Member Functions
static void	SetInstance (ImpactCFXManager collisionEffectProcessor)
	Sets the active impact manager instance.
static void	RegisterMaterials (ImpactMaterialRegistry materials)
	Registers a list of materials from a registry with the impact manager to convert them into data structures suitable for use in jobs.
static void	RegisterMaterials (IEnumerable< ImpactMaterialAuthoring > materials)
	Registers a list of materials with the impact manager to convert them into data structures suitable for use in jobs.
static void	RegisterMaterial (ImpactMaterialAuthoring material)
	Registers a single material with the impact manager to convert it into data structures suitable for use in jobs.
static void	ClearAllRegistered ()
	Completely disposes of and destroys all material and effect data and objects currently registered in the impact manager.
static void	FindObjectsAndRegisterMaterials ()
	Finds all Impact Objects in the active scene and forces them to register their materials.
static bool	CanQueueCollision (CollisionType collisionType, int materialCount)
	Does the impact manager have the capacity to queue a collision of the given type? This is useful to abort early to save processing.
static void	QueueCollision (IImpactObject triggerObject, IImpactObject hitObject, ImpactContactPoint contactPoint, CollisionType collisionType, int triggerObjectMaterialCount, int hitObjectMaterialCount, CollisionVelocityMethod collisionVelocityMethod)
	Queues a collision between 2 objects when the other object has an impact object component.
static void	QueueCollision (IImpactObject triggerObject, ImpactObjectData hitObjectData, ImpactContactPoint contactPoint, CollisionType collisionType, int triggerObjectMaterialCount, CollisionVelocityMethod collisionVelocityMethod)
	Queues a collision using basic data for the object that was hit.
static void	QueueCollision (ImpactObjectData triggerObjectData, IImpactObject hitObject, ImpactContactPoint contactPoint, CollisionType collisionType, int hitObjectMaterialCount, CollisionVelocityMethod collisionVelocityMethod)
	Queues a collision using basic data for the object triggering the collision.
static bool	TryGetEffectProcessor< T > (out T effectProcessor)
	Try to get the effect processor of the given type.
static bool	TryGetMaterialProcessor< T > (out T materialProcessor)
	Try to get the material processor of the given type.
static void	ResetAllEffectProcessors ()
	Resets all effect processors controlled by the active manager instance.

Detailed Description

Global class for managing and interfacing with the active impact instance.

Member Function Documentation

CanQueueCollision()

static bool ImpactCFX.ImpactCFXGlobal.CanQueueCollision ( CollisionType  collisionType, int  materialCount  )

static

Does the impact manager have the capacity to queue a collision of the given type? This is useful to abort early to save processing.

Parameters

collisionType	The collision type.
materialCount	The number of materials that will need to be processed for the collision.

QueueCollision() [1/3]

static void ImpactCFX.ImpactCFXGlobal.QueueCollision ( IImpactObject  triggerObject, IImpactObject  hitObject, ImpactContactPoint  contactPoint, CollisionType  collisionType, int  triggerObjectMaterialCount, int  hitObjectMaterialCount, CollisionVelocityMethod  collisionVelocityMethod  )

static

Queues a collision between 2 objects when the other object has an impact object component.

Parameters

triggerObject	The object that triggered the collision.
hitObject	The object being collided with.
contactPoint	The contact point of the collision.
collisionType	The type of collision.
triggerObjectMaterialCount	The number of materials to get for the object that triggered the collision.
hitObjectMaterialCount	The number of materials to get for the object that was hit.
collisionVelocityMethod	The method to use for calculating the collision velocity.

QueueCollision() [2/3]

static void ImpactCFX.ImpactCFXGlobal.QueueCollision ( IImpactObject  triggerObject, ImpactObjectData  hitObjectData, ImpactContactPoint  contactPoint, CollisionType  collisionType, int  triggerObjectMaterialCount, CollisionVelocityMethod  collisionVelocityMethod  )

static

Queues a collision using basic data for the object that was hit.

Parameters

triggerObject	The object that triggered the collision.
hitObjectData	Basic data for the object being collided with.
contactPoint	The contact point of the collision.
collisionType	The type of collision.
triggerObjectMaterialCount	The number of materials to get for the object that triggered the collision.
collisionVelocityMethod	The method to use for calculating the collision velocity.

QueueCollision() [3/3]

static void ImpactCFX.ImpactCFXGlobal.QueueCollision ( ImpactObjectData  triggerObjectData, IImpactObject  hitObject, ImpactContactPoint  contactPoint, CollisionType  collisionType, int  hitObjectMaterialCount, CollisionVelocityMethod  collisionVelocityMethod  )

static

Queues a collision using basic data for the object triggering the collision.

Parameters

triggerObjectData	Basic data for the object that triggered the collision.
hitObject	The object being collided with.
contactPoint	The contact point of the collision.
collisionType	The type of collision.
collisionVelocityMethod	The method to use for calculating the collision velocity.

RegisterMaterial()

static void ImpactCFX.ImpactCFXGlobal.RegisterMaterial ( ImpactMaterialAuthoring  material )

static

Registers a single material with the impact manager to convert it into data structures suitable for use in jobs.

Parameters

material

The material being registered.

RegisterMaterials() [1/2]

static void ImpactCFX.ImpactCFXGlobal.RegisterMaterials ( IEnumerable< ImpactMaterialAuthoring >  materials )

static

Registers a list of materials with the impact manager to convert them into data structures suitable for use in jobs.

Parameters

materials

The materials being registered.

RegisterMaterials() [2/2]

static void ImpactCFX.ImpactCFXGlobal.RegisterMaterials ( ImpactMaterialRegistry  materials )

static

Registers a list of materials from a registry with the impact manager to convert them into data structures suitable for use in jobs.

Parameters

materials

The material registry containing the materials to be registered.

TryGetEffectProcessor< T >()

static bool ImpactCFX.ImpactCFXGlobal.TryGetEffectProcessor< T > ( out T  effectProcessor )

static

Try to get the effect processor of the given type.

Template Parameters

T	The type of effect processor.

Parameters

effectProcessor

The effect processor that was found, if any.

Returns

True if an effect processor matching the given type was found. False otherwise.

Type Constraints

T

:

ImpactEffectProcessorBase

TryGetMaterialProcessor< T >()

static bool ImpactCFX.ImpactCFXGlobal.TryGetMaterialProcessor< T > ( out T  materialProcessor )

static

Try to get the material processor of the given type.

Template Parameters

T	The type of effect processor.

Parameters

materialProcessor

The material processor that was found, if any.

Returns

True if an material processor matching the given type was found. False otherwise.

Type Constraints

T

:

ImpactMaterialProcessorBase