Struct Vector3BoolProperty

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

Namespace: UnityEngine.Animations.Rigging
Syntax
public struct Vector3BoolProperty : IAnimatableProperty<Vector3Bool>

Fields

x

The PropertyStreamHandle used for the X component in the AnimationStream.

Declaration
public PropertyStreamHandle x
Field Value
Type Description
PropertyStreamHandle

y

The PropertyStreamHandle used for the Y component in the AnimationStream.

Declaration
public PropertyStreamHandle y
Field Value
Type Description
PropertyStreamHandle

z

The PropertyStreamHandle used for the Z component in the AnimationStream.

Declaration
public PropertyStreamHandle z
Field Value
Type Description
PropertyStreamHandle

Methods

Bind(Animator, Component, String)

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

Declaration
public static Vector3BoolProperty 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
Vector3BoolProperty

Returns a Vector3BoolProperty handle that represents the new binding.

BindCustom(Animator, String)

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

Declaration
public static Vector3BoolProperty BindCustom(Animator animator, string name)
Parameters
Type Name Description
Animator animator

The Animator on which to bind the new handle.
String name

The name of the property.
Returns
Type Description
Vector3BoolProperty

Returns a Vector3BoolProperty handle that represents the new binding.

Get(AnimationStream)

Gets the property value from a stream.

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

The AnimationStream that holds the animated values.
Returns
Type Description
Vector3Bool

The Vector3Bool property value.
Implements

Set(AnimationStream, Vector3Bool)

Sets the property value into a stream.

Declaration
public void Set(AnimationStream stream, Vector3Bool value)
Parameters
Type Name Description
AnimationStream stream

The AnimationStream that holds the animated values.
Vector3Bool value

The new Vector3Bool property value.
Implements