docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Interface IRigEffectorHolder

    This interface represents classes that hold and serialize effectors. Effectors do nothing during runtime.

    Namespace: UnityEngine.Animations.Rigging
    Assembly: Unity.Animation.Rigging.dll
    Syntax
    public interface IRigEffectorHolder

    Properties

    effectors

    Declaration
    IEnumerable<RigEffectorData> effectors { get; }
    Property Value
    Type Description
    IEnumerable<RigEffectorData>

    Methods

    AddEffector(Transform, Style)

    Adds a new effector to the IRigEffectorHolder.

    Declaration
    void AddEffector(Transform transform, RigEffectorData.Style style)
    Parameters
    Type Name Description
    Transform transform

    The Transform represented by the effector.

    RigEffectorData.Style style

    The visual style of the effector.

    ContainsEffector(Transform)

    Queries whether there is an effector for the specified Transform.

    Declaration
    bool ContainsEffector(Transform transform)
    Parameters
    Type Name Description
    Transform transform

    The Transform to query.

    Returns
    Type Description
    bool

    True if there is an effector for this transform. False otherwise.

    RemoveEffector(Transform)

    Removes an effector from the IRigEffectorHolder.

    Declaration
    void RemoveEffector(Transform transform)
    Parameters
    Type Name Description
    Transform transform

    The Transform from which to remove the effector.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)