GameObjectRecorder
Records the changing properties of a GameObject as the Scene runs and saves the information into an AnimationClip.
Read time 5 minutesLast updated 8 days ago
Definition
- Type: Class
- Namespace: UnityEditor.Animations
- Assembly: UnityEditor
- Inherits from: Object
public class GameObjectRecorder : Object
Remarks
This class binds GameObject properties, records their values as they change in the running Scene, and saves the result in an AnimationClip. The recorded GameObject is called GameObjectRecorder.root in the class, and you can also bind the properties of any child of GameObjectRecorder.root.
See the following code example on how this class can be implemented and to set what gets recorded.
Examples
using UnityEngine;using UnityEditor.Animations;public class RecordTransformHierarchy : MonoBehaviour{ public AnimationClip clip; private GameObjectRecorder m_Recorder; void Start() { // Create recorder and record the script GameObject. m_Recorder = new GameObjectRecorder(gameObject); // Bind all the Transforms on the GameObject and all its children. m_Recorder.BindComponentsOfType<Transform>(gameObject, true); } void LateUpdate() { if (clip == null) return; // Take a snapshot and record all the bindings values for this frame. m_Recorder.TakeSnapshot(Time.deltaTime); } void OnDisable() { if (clip == null) return; if (m_Recorder.isRecording) { // Save the recorded session to the clip. m_Recorder.SaveToClip(clip); } }}
Constructors
Constructor | Description |
|---|---|
| GameObjectRecorder(UnityEngine.GameObject) | Create a new GameObjectRecorder. |
Properties
Property | Description |
|---|---|
| currentTime | Returns the current time of the recording. (Read Only) |
| isRecording | Returns true when the recorder is recording. (Read Only) |
| root | The GameObject root of the animated hierarchy. (Read Only) |
Methods
Method | Description |
|---|---|
| Bind | Binds a GameObject's property as defined by EditorCurveBinding. |
| BindAll | Adds bindings for all of target's properties, and also for all the target's children if recursive is true. |
| BindComponent | Adds bindings for all the properties of component. |
| BindComponentsOfType | Adds bindings for all the properties of the first component of type T found in target, and also for all the target's children if recursive is true. |
| GetBindings | Returns an array of all the bindings added to the recorder. |
| ResetRecording | Reset the recording. |
| SaveToClip | Saves recorded animation to a destination clip. |
| TakeSnapshot | Forwards the animation by dt seconds, then record the values of the added bindings. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |