Struct BoolProperty | Animation Rigging | 1.0.3
docs.unity3d.com
    Show / Hide Table of Contents

    Struct BoolProperty

    Boolean property handle used to read and write values in the AnimationStream.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    public struct BoolProperty : IAnimatableProperty<bool>

    Fields

    value

    The PropertyStreamHandle used in the AnimationStream.

    Declaration
    public PropertyStreamHandle value
    Field Value
    Type Description
    PropertyStreamHandle

    Methods

    Bind(Animator, Component, String)

    Creates a BoolProperty handle representing a property binding on a Component.

    Declaration
    public static BoolProperty Bind(Animator animator, Component component, string name)
    Parameters
    Type Name Description
    Animator animator

    The Animator on which to bind the new handle.

    Component component

    The Component owning the parameter.

    String name

    The property name

    Returns
    Type Description
    BoolProperty

    Returns a BoolProperty handle that represents the new binding.

    BindCustom(Animator, String)

    Creates a BoolProperty handle for a custom property in the AnimationStream to pass extra data to downstream animation jobs in the graph.

    Declaration
    public static BoolProperty BindCustom(Animator animator, string property)
    Parameters
    Type Name Description
    Animator animator

    The Animator on which to bind the new handle.

    String property

    The name of the property.

    Returns
    Type Description
    BoolProperty

    Returns a BoolProperty handle that represents the new binding.

    Get(AnimationStream)

    Gets the property value from a stream.

    Declaration
    public bool Get(AnimationStream stream)
    Parameters
    Type Name Description
    AnimationStream stream

    The AnimationStream that holds the animated values.

    Returns
    Type Description
    Boolean

    The boolean property value.

    Implements
    IAnimatableProperty<T>.Get(AnimationStream)

    Set(AnimationStream, Boolean)

    Sets the property value into a stream.

    Declaration
    public void Set(AnimationStream stream, bool v)
    Parameters
    Type Name Description
    AnimationStream stream

    The AnimationStream that holds the animated values.

    Boolean v

    The new boolean property value.

    Implements
    IAnimatableProperty<T>.Set(AnimationStream, T)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023