Show / Hide Table of Contents

Class SubjectBehavior

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
SubjectBehavior
Inherited Members
UnityEngine.MonoBehaviour.IsInvoking()
UnityEngine.MonoBehaviour.CancelInvoke()
UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
UnityEngine.MonoBehaviour.CancelInvoke(System.String)
UnityEngine.MonoBehaviour.IsInvoking(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
UnityEngine.MonoBehaviour.StopCoroutine(System.String)
UnityEngine.MonoBehaviour.StopAllCoroutines()
UnityEngine.MonoBehaviour.print(System.Object)
UnityEngine.MonoBehaviour.useGUILayout
UnityEngine.MonoBehaviour.runInEditMode
UnityEngine.Behaviour.enabled
UnityEngine.Behaviour.isActiveAndEnabled
UnityEngine.Component.GetComponent(System.Type)
UnityEngine.Component.GetComponent<T>()
UnityEngine.Component.GetComponent(System.String)
UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInChildren(System.Type)
UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentInChildren<T>()
UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInChildren(System.Type)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInChildren<T>()
UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentInParent(System.Type)
UnityEngine.Component.GetComponentInParent<T>()
UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInParent(System.Type)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInParent<T>()
UnityEngine.Component.GetComponents(System.Type)
UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponents<T>()
UnityEngine.Component.CompareTag(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object)
UnityEngine.Component.SendMessageUpwards(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, System.Object)
UnityEngine.Component.SendMessage(System.String)
UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object)
UnityEngine.Component.BroadcastMessage(System.String)
UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.transform
UnityEngine.Component.gameObject
UnityEngine.Component.tag
UnityEngine.Object.GetInstanceID()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
UnityEngine.Object.Destroy(UnityEngine.Object)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
UnityEngine.Object.FindObjectsOfType(System.Type)
UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.ToString()
UnityEngine.Object.name
UnityEngine.Object.hideFlags
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: RecordAndPlay.Record
Assembly: RecordAndPlay.dll
Syntax
public class SubjectBehavior : MonoBehaviour

Methods

Build(GameObject, Recorder)

Builds a SubjectBehavior and it's corrresponding SubjectRecorder and attatches itself to the gameobject passed in.

Declaration
public static SubjectBehavior Build(GameObject subject, Recorder recorder)
Parameters
Type Name Description
UnityEngine.GameObject subject

The gameobject to record.

Recorder recorder

The recorder that is incharge of all subjects.

Returns
Type Description
SubjectBehavior

The subject behavior that's been attatched to the gameobject passed in.

Build(GameObject, Recorder, Int32, Single)

Builds a SubjectBehavior and it's corrresponding SubjectRecorder and attatches itself to the gameobject passed in.

Declaration
public static SubjectBehavior Build(GameObject subject, Recorder recorder, int frameRate, float minimumDelta)
Parameters
Type Name Description
UnityEngine.GameObject subject

The gameobject to record.

Recorder recorder

The recorder that is incharge of all subjects.

System.Int32 frameRate

How many times a second the recorder will observe the position and rotation of the subject.

System.Single minimumDelta

How much the position or rotation must change before it's considered moved.

Returns
Type Description
SubjectBehavior

The subject behavior that's been attatched to the gameobject passed in.

Build(GameObject, Recorder, Int32, String, Dictionary<String, String>, Single)

Builds a SubjectBehavior and it's corrresponding SubjectRecorder and attatches itself to the gameobject passed in.

Declaration
public static SubjectBehavior Build(GameObject subject, Recorder recorder, int frameRate, string name, Dictionary<string, string> metadata, float minimumDelta)
Parameters
Type Name Description
UnityEngine.GameObject subject

The gameobject to record.

Recorder recorder

The recorder that is incharge of all subjects.

System.Int32 frameRate

How many times a second the recorder will observe the position and rotation of the subject.

System.String name

The name of the subject to be used when saved to file.

System.Collections.Generic.Dictionary<System.String, System.String> metadata

Any starting metadata on the specific subject.

System.Single minimumDelta

How much the position or rotation must change before it's considered moved.

Returns
Type Description
SubjectBehavior

The subject behavior that's been attatched to the gameobject passed in.

Build(GameObject, Recorder, String)

Builds a SubjectBehavior and it's corrresponding SubjectRecorder and attatches itself to the gameobject passed in.

Declaration
public static SubjectBehavior Build(GameObject subject, Recorder recorder, string name)
Parameters
Type Name Description
UnityEngine.GameObject subject

The gameobject to record.

Recorder recorder

The recorder that is incharge of all subjects.

System.String name

The name of the subject to be used when saved to file.

Returns
Type Description
SubjectBehavior

The subject behavior that's been attatched to the gameobject passed in.

Build(GameObject, Recorder, String, Dictionary<String, String>)

Builds a SubjectBehavior and it's corrresponding SubjectRecorder and attatches itself to the gameobject passed in.

Declaration
public static SubjectBehavior Build(GameObject subject, Recorder recorder, string name, Dictionary<string, string> metadata)
Parameters
Type Name Description
UnityEngine.GameObject subject

The gameobject to record.

Recorder recorder

The recorder that is incharge of all subjects.

System.String name

The name of the subject to be used when saved to file.

System.Collections.Generic.Dictionary<System.String, System.String> metadata

Any starting metadata on the specific subject.

Returns
Type Description
SubjectBehavior

The subject behavior that's been attatched to the gameobject passed in.

CaptureCustomEvent(String, Dictionary<String, String>)

If you want to keep up with something special that occured at a certain time in your recording, then you can call this function with the details of the special event.

Declaration
public void CaptureCustomEvent(string name, Dictionary<string, string> contents)
Parameters
Type Name Description
System.String name

Name of the event.

System.Collections.Generic.Dictionary<System.String, System.String> contents

Details of the event.

CaptureCustomEvent(String, String)

If you want to keep up with something special that occured at a certain time in your recording, then you can call this function with the details of the special event.

Declaration
public void CaptureCustomEvent(string name, string contents)
Parameters
Type Name Description
System.String name

Name of the event.

System.String contents

Details of the event.

GetFPS()

How many times the recorder takes snapshots of the state of the subject while recording.

Declaration
public float GetFPS()
Returns
Type Description
System.Single

How many times a second the state is captured.

GetSubjectRecorder()

The recorder that the subject specifically uses for recording orientations and lifecycle events.

Declaration
public SubjectRecorder GetSubjectRecorder()
Returns
Type Description
SubjectRecorder

The recorder.

SetMetaData(String, String)

Keep up with custom data associated with the subject.

Declaration
public void SetMetaData(string key, string value)
Parameters
Type Name Description
System.String key

Name of the custom data.

System.String value

Details of the custom data.

Back to top Generated by DocFX