The primary manager of the entire Impact CFX system. More...

Inheritance diagram for ImpactCFX.ImpactCFXManager:

Classes
class	CollisionTypeLimit
	Defines a limit for a certain type of collision. More...

Public Member Functions
void	RegisterMaterials (ImpactMaterialRegistry materials)
	Registers a list of materials from a registry to convert them into data structures suitable for use in jobs.

void	RegisterMaterials (IEnumerable< ImpactMaterialAuthoring > materials)
	Registers a list of materials to convert them into data structures suitable for use in jobs.

void	RegisterMaterial (ImpactMaterialAuthoring material)
	Registers a single material to convert it into data structures suitable for use in jobs.

void	ClearAllRegistered ()
	Completely disposes of and destroys all registered material and effect data and objects.

void	FindObjectsAndRegisterMaterials ()
	Finds all Impact Objects in the active scene and forces them to register their materials.

void	QueueCollision (IImpactObject triggerObject, IImpactObject hitObject, ImpactContactPoint contactPoint, CollisionType collisionType, int triggerObjectMaterialCount, int hitObjectMaterialCount, CollisionVelocityMethod collisionVelocityMethod)
	Queues a collision between 2 objects.

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.

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.

bool	CanQueueCollision (CollisionType collisionType, int materialCount)
	Is there remaining capacity for a collision of the given type?

bool	TryGetEffectProcessor< T > (out T effectProcessor)
	Try to get the effect processor of the given type.

bool	TryGetMaterialProcessor< T > (out T materialProcessor)
	Try to get the material processor of the given type.

void	ResetAllEffectProcessors ()
	Resets all effect processors controlled by this manager.

Properties
int	CollisionQueueCapacity `[get]`
	The capacity of the array used to gather collision data from colliding objects in a frame.

int	MaterialQueueCapacity `[get]`
	The capacity of the array used to gather materials from colliding objects in a single frame.

Detailed Description

The primary manager of the entire Impact CFX system.

Member Function Documentation

◆ CanQueueCollision()

bool ImpactCFX.ImpactCFXManager.CanQueueCollision	(	CollisionType	collisionType,
		int	materialCount
	)

Is there remaining capacity for a collision of the given type?

Parameters

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

◆ QueueCollision() [1/3]

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

Queues a collision between 2 objects.

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]

void ImpactCFX.ImpactCFXManager.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.

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]

void ImpactCFX.ImpactCFXManager.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.

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()

void ImpactCFX.ImpactCFXManager.RegisterMaterial ( ImpactMaterialAuthoring material )

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

Parameters

material The material being registered.

◆ RegisterMaterials() [1/2]

void ImpactCFX.ImpactCFXManager.RegisterMaterials ( IEnumerable< ImpactMaterialAuthoring > materials )

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

Parameters

materials The materials being registered.

◆ RegisterMaterials() [2/2]

void ImpactCFX.ImpactCFXManager.RegisterMaterials ( ImpactMaterialRegistry materials )

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

Parameters

materials The material registry containing the materials to be registered.

◆ TryGetEffectProcessor< T >()

bool ImpactCFX.ImpactCFXManager.TryGetEffectProcessor< T > ( out T effectProcessor )

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 >()

bool ImpactCFX.ImpactCFXManager.TryGetMaterialProcessor< T > ( out T materialProcessor )

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

Classes

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CanQueueCollision()

◆ QueueCollision() [1/3]

◆ QueueCollision() [2/3]

◆ QueueCollision() [3/3]

◆ RegisterMaterial()

◆ RegisterMaterials() [1/2]

◆ RegisterMaterials() [2/2]

◆ TryGetEffectProcessor< T >()

◆ TryGetMaterialProcessor< T >()