Class VFXPropertyBinder

A Behaviour that controls binding between Visual Effect Properties, and other scene values, through the use of VFXBinderBase

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
VFXPropertyBinder
Inherited Members
Namespace: UnityEngine.VFX.Utility
Syntax
[RequireComponent(typeof(VisualEffect))]
[DefaultExecutionOrder(1)]
[ExecuteInEditMode]
public class VFXPropertyBinder : MonoBehaviour

Fields

m_Bindings

The list of all Bindings attached to the binder, these bindings are managed by the VFXPropertyBinder and should be managed using the AddPropertyBinder, ClearPropertyBinders, RemovePropertyBinder, RemovePropertyBinders, and GetPropertyBinders.

Declaration
public List<VFXBinderBase> m_Bindings
Field Value
Type Description
List<VFXBinderBase>

m_ExecuteInEditor

Whether the bindings should be executed in editor (as preview)

Declaration
[SerializeField]
protected bool m_ExecuteInEditor
Field Value
Type Description
Boolean

m_VisualEffect

The Visual Effect component attached to the VFXPropertyBinder

Declaration
[SerializeField]
protected VisualEffect m_VisualEffect
Field Value
Type Description
VisualEffect

Methods

AddParameterBinder<T>()

Adds a new PropertyBinder

Declaration
[Obsolete("Use AddPropertyBinder<T>() instead")]
public T AddParameterBinder<T>()
    where T : VFXBinderBase
Returns
Type Description
T

The PropertyBinder newly Created
Type Parameters
Name Description
T

the Type of Property Binder

AddPropertyBinder<T>()

Adds a new PropertyBinder

Declaration
public T AddPropertyBinder<T>()
    where T : VFXBinderBase
Returns
Type Description
T

The PropertyBinder newly Created
Type Parameters
Name Description
T

the Type of Property Binder

ClearParameterBinders()

Clears all the Property Binders

Declaration
[Obsolete("Please use ClearPropertyBinders() instead")]
public void ClearParameterBinders()

ClearPropertyBinders()

Clears all the Property Binders

Declaration
public void ClearPropertyBinders()

GetParameterBinders<T>()

Gets all VFXBinderBase of Given Type, attached to this VFXPropertyBinder

Declaration
[Obsolete("Please use GetPropertyBinders<T>() instead")]
public IEnumerable<T> GetParameterBinders<T>()
    where T : VFXBinderBase
Returns
Type Description
IEnumerable<T>

An IEnumerable of all VFXBinderBase
Type Parameters
Name Description
T

Specific VFXBinderBase type

GetPropertyBinders<T>()

Gets all VFXBinderBase of Given Type, attached to this VFXPropertyBinder

Declaration
public IEnumerable<T> GetPropertyBinders<T>()
    where T : VFXBinderBase
Returns
Type Description
IEnumerable<T>

An IEnumerable of all VFXBinderBase
Type Parameters
Name Description
T

Specific VFXBinderBase type

RemoveParameterBinder(VFXBinderBase)

Removes specified Property Binder

Declaration
[Obsolete("Please use RemovePropertyBinder() instead")]
public void RemoveParameterBinder(VFXBinderBase binder)
Parameters
Type Name Description
VFXBinderBase binder

The VFXBinderBase to remove

RemoveParameterBinders<T>()

Remove all Property Binders of Given Type

Declaration
[Obsolete("Please use RemovePropertyBinders<T>() instead")]
public void RemoveParameterBinders<T>()
    where T : VFXBinderBase
Type Parameters
Name Description
T

Specified VFXBinderBase type

RemovePropertyBinder(VFXBinderBase)

Removes specified Property Binder

Declaration
public void RemovePropertyBinder(VFXBinderBase binder)
Parameters
Type Name Description
VFXBinderBase binder

The VFXBinderBase to remove

RemovePropertyBinders<T>()

Remove all Property Binders of Given Type

Declaration
public void RemovePropertyBinders<T>()
    where T : VFXBinderBase
Type Parameters
Name Description
T

Specified VFXBinderBase type