Records the changing properties of a GameObject as the Scene runs and saves the information into an AnimationClip.
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 root in the class, and you can also bind the properties of any child of root.
See the following code example on how this class can be implemented and to set what gets recorded.
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); } } }
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) |
GameObjectRecorder | Create a new GameObjectRecorder. |
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. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
GetInstanceID | Returns the instance id of the object. |
ToString | Returns the name of the object. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindObjectOfType | Returns the first active loaded object of Type type. |
FindObjectsOfType | Returns a list of all active loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
bool | Does the object exist? |
operator != | Compares if two objects refer to a different object. |
operator == | Compares two object references to see if they refer to the same object. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.