Struct BoolProperty

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

Implements
Inherited Members
Namespace: UnityEngine.Animations.Rigging
Assembly: Unity.Animation.Rigging.dll
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
bool

The boolean property value.

Set(AnimationStream, bool)

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.
bool v

The new boolean property value.

Implements