AnimationStream
The stream of animation data passed from one Playable to another.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Struct
- Namespace: UnityEngine.Animations
- Assembly: UnityEngine.AnimationModule
public struct AnimationStream
Remarks
The AnimationStream structure is passed through the animation Playable structures, like AnimationClipPlayable and AnimationMixerPlayable. They can be modified when used with an IAnimationJobPlayable, like the AnimationScriptPlayable.
The Playables implementing IAnimationJobPlayable take a custom C# job, which must implement IAnimationJob, and the AnimationStream is then passed to its callbacks during the animation processing pass.
Additional Resources: IAnimationJob, AnimationScriptPlayable, TransformStreamHandle, PropertyStreamHandle, TransformSceneHandle, and PropertySceneHandle.
Properties
Property | Description |
|---|---|
| angularVelocity | Gets or sets the avatar angular velocity for the evaluated frame. |
| deltaTime | Gets the delta time for the evaluated frame. (Read Only) |
| inputStreamCount | Gets the number of input streams. (Read Only) |
| isHumanStream | Returns |
| isValid | Returns |
| rootMotionPosition | Gets the root motion position for the evaluated frame. (Read Only) |
| rootMotionRotation | Gets the root motion rotation for the evaluated frame. (Read Only) |
| velocity | Gets or sets the avatar velocity for the evaluated frame. |
Methods
Method | Description |
|---|---|
| AsHuman | Gets the same stream, but as an AnimationHumanStream. |
| CopyAnimationStreamMotion | Deep copies motion from a source animation stream to the current animation stream. |
| GetInputStream | Gets the AnimationStream of the playable input at |
| GetInputWeight | Gets the weight of the Playable connected at a specific input index. |