Interface IPropertyCollector

Interface used to inform the Timeline Editor about potential property modifications that may occur while previewing.

Namespace: UnityEngine.Timeline

Assembly: Unity.Timeline.dll

Syntax

public interface IPropertyCollector

Methods

AddFromClip(AnimationClip)

Add properties modified by an animation clip.

Declaration

void AddFromClip(AnimationClip clip)

Parameters

Type	Name	Description
AnimationClip	clip	The animation clip that contains the properties.

AddFromClip(GameObject, AnimationClip)

Add property modifications modified by an animation clip.

Declaration

void AddFromClip(GameObject obj, AnimationClip clip)

Parameters

Type	Name	Description
GameObject	obj	The GameObject where the properties exist.
AnimationClip	clip	The animation clip that contains the properties.

AddFromClips(IEnumerable<AnimationClip>)

Add property modifications specified by a list of animation clips.

Declaration

void AddFromClips(IEnumerable<AnimationClip> clips)

Parameters

Type	Name	Description
IEnumerable<AnimationClip>	clips	The list of animation clips used to determine which property modifications to apply.

AddFromClips(GameObject, IEnumerable<AnimationClip>)

Add property modifications specified by a list of animation clips.

Declaration

void AddFromClips(GameObject obj, IEnumerable<AnimationClip> clips)

Parameters

Type	Name	Description
GameObject	obj	The gameObject that will be animated.
IEnumerable<AnimationClip>	clips	The list of animation clips used to determine which property modifications to apply.

AddFromComponent(GameObject, Component)

Set all serializable properties on a component to be under preview control.

Declaration

void AddFromComponent(GameObject obj, Component component)

Parameters

Type	Name	Description
GameObject	obj	The gameObject where the properties exist.
Component	component	The component to set in preview mode.

AddFromName(string)

Add property modifications using the serialized property name.

Declaration

void AddFromName(string name)

Parameters

Type	Name	Description
string	name	The name of the serialized property.

Remarks

This method uses the most recent gameObject from PushActiveGameObject.

AddFromName(Component, string)

Add property modifications using the serialized property name.

Declaration

void AddFromName(Component component, string name)

Parameters

Type	Name	Description
Component	component	The component where the properties exist.
string	name	The name of the serialized property.

AddFromName(GameObject, string)

Add property modifications using the serialized property name.

Declaration

void AddFromName(GameObject obj, string name)

Parameters

Type	Name	Description
GameObject	obj	The gameObject where the properties exist.
string	name	The name of the serialized property.

AddFromName<T>(string)

Add property modifications using the serialized property name.

Declaration

void AddFromName<T>(string name) where T : Component

Parameters

Type	Name	Description
string	name	The name of the serialized property.

Type Parameters

Name	Description
T	The type of the component the property exists on.

Remarks

This method uses the most recent gameObject from PushActiveGameObject.

AddFromName<T>(GameObject, string)

Add property modifications using the serialized property name.

Declaration

void AddFromName<T>(GameObject obj, string name) where T : Component

Parameters

Type	Name	Description
GameObject	obj	The gameObject where the properties exist.
string	name	The name of the serialized property.

Type Parameters

Name	Description
T	The type of the component the property exists on.

AddObjectProperties(Object, AnimationClip)

Add property modifications modified by an animation clip.

Declaration

void AddObjectProperties(Object obj, AnimationClip clip)

Parameters

Type	Name	Description
Object	obj	The Object where the properties exist.
AnimationClip	clip	The animation clip that contains the properties.

PopActiveGameObject()

Removes the active GameObject from the modification stack, restoring the previous value.

Declaration

void PopActiveGameObject()

PushActiveGameObject(GameObject)

Sets the active game object for subsequent property modifications.

Declaration

void PushActiveGameObject(GameObject gameObject)

Parameters

Type	Name	Description
GameObject	gameObject	The GameObject to push.