s&box docs
API ReferenceSandbox.MovieMaker

TrackBinderclass

Controls which `Sandbox.MovieMaker.ITrackTarget`s from a scene are controlled by which `Sandbox.MovieMaker.ITrack` from a `Sandbox.MovieMaker.IMovieClip`. Can be serialized to save which tracks are bound to which targets.

object→TrackBinder
Namespace
Sandbox.MovieMaker
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.MovieMaker.TrackBinder

Constructors1

Showing 1 constructors

public TrackBinder(Sandbox.Scene scene = null)PUBLICCONSTRUCTOR

Controls which `Sandbox.MovieMaker.ITrackTarget`s from a scene are controlled by which `Sandbox.MovieMaker.ITrack` from a `Sandbox.MovieMaker.IMovieClip`. Can be serialized to save which tracks are bound to which targets.

ParameterTypeDescription
scene = nullScene—

Methods18

Showing 18 methods

public virtual sealed void Deserialize(System.Text.Json.Nodes.JsonNode node)PUBLICVIRTUAL

ParameterTypeDescription
nodeJsonNode—
Returns:void—

public System.Collections.Generic.IEnumerable`1<T> GetComponents(Sandbox.MovieMaker.IMovieClip clip)PUBLIC

Get all bound component references for tracks in the given `clip`.

ParameterTypeDescription
clipIMovieClipMovie clip to find track bindings for.
Returns:IEnumerable<T>—

public virtual sealed System.Collections.Generic.IEnumerator`1<System.Collections.Generic.KeyValuePair`2<System.Guid,Sandbox.IValid>> GetEnumerator()PUBLICVIRTUAL

Returns:IEnumerator<KeyValuePair<Guid,IValid>>—

public System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.ITrackProperty`1<T>> GetProperties(Sandbox.MovieMaker.IMovieClip clip)PUBLIC

Get all property targets for tracks in the given `clip`.

ParameterTypeDescription
clipIMovieClipMovie clip to find track bindings for.
Returns:IEnumerable<ITrackProperty<T>>—

public System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.ITrackReference`1<T>> GetReferences(Sandbox.MovieMaker.IMovieClip clip)PUBLIC

Get all reference targets for tracks in the given `clip`.

ParameterTypeDescription
clipIMovieClipMovie clip to find track bindings for.
Returns:IEnumerable<ITrackReference<T>>—

public System.Nullable`1<System.Guid> GetTrackId(Sandbox.IValid gameObjectOrComponent)PUBLIC

ParameterTypeDescription
gameObjectOrComponentIValid—
Returns:Nullable<Guid>—

public System.Collections.Generic.IEnumerable`1<System.Guid> GetTrackIds(Sandbox.IValid gameObjectOrComponent)PUBLIC

Finds track IDs currently explicitly bound to the given `gameObjectOrComponent`.

ParameterTypeDescription
gameObjectOrComponentIValid—
Returns:IEnumerable<Guid>—

public virtual sealed System.Text.Json.Nodes.JsonNode Serialize()PUBLICVIRTUAL

Returns:JsonNode—

Properties2

Showing 2 properties

public static Sandbox.MovieMaker.TrackBinder Sandbox.MovieMaker.TrackBinder.Default { get; set; }PUBLICSTATICGETSET

Gets the default binder for the active scene.

Returns:TrackBinder—

public Sandbox.Scene Sandbox.MovieMaker.TrackBinder.Scene { get; set; }PUBLICGETSET

The scene this binder is targeting.

Returns:Scene—

Related Guides

→Playback API

Union()

Previous Page

Default

Next Page

On this page

Constructorspublic TrackBinder(Sandbox.Scene scene = null)Methodspublic System.Void Add(Sandbox.MovieMaker.IReferenceTrack track, Sandbox.IValid target)public System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.ITrackReference> CreateTargets(Sandbox.MovieMaker.IMovieClip clip, Sandbox.GameObject rootParent = null)public System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.ITrackReference> CreateTargets(System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.IReferenceTrack> tracks, Sandbox.GameObject rootParent = null)public virtual sealed System.Void Deserialize(System.Text.Json.Nodes.JsonNode node)public Sandbox.MovieMaker.ITrackProperty Get(Sandbox.MovieMaker.IPropertyTrack track)public Sandbox.MovieMaker.ITrackReference Get(Sandbox.MovieMaker.IReferenceTrack track)public Sandbox.MovieMaker.ITrackTarget Get(Sandbox.MovieMaker.ITrack track)public Sandbox.MovieMaker.ITrackProperty`1<T> Get(Sandbox.MovieMaker.IPropertyTrack`1<T> track)public Sandbox.MovieMaker.ITrackReference`1<T> Get(Sandbox.MovieMaker.IReferenceTrack`1<T> track)public System.Collections.Generic.IEnumerable`1<T> GetComponents(Sandbox.MovieMaker.IMovieClip clip)public virtual sealed System.Collections.Generic.IEnumerator`1<System.Collections.Generic.KeyValuePair`2<System.Guid,Sandbox.IValid>> GetEnumerator()public System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.ITrackProperty`1<T>> GetProperties(Sandbox.MovieMaker.IMovieClip clip)public System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.ITrackReference`1<T>> GetReferences(Sandbox.MovieMaker.IMovieClip clip)public System.Nullable`1<System.Guid> GetTrackId(Sandbox.IValid gameObjectOrComponent)public System.Collections.Generic.IEnumerable`1<System.Guid> GetTrackIds(Sandbox.IValid gameObjectOrComponent)public virtual sealed System.Text.Json.Nodes.JsonNode Serialize()public System.Boolean TryGetBinding(System.Guid trackId, Sandbox.IValid target)public System.Boolean TryGetBinding(System.Guid trackId, T target)Propertiespublic static Sandbox.MovieMaker.TrackBinder Sandbox.MovieMaker.TrackBinder.Default { get; set; }public Sandbox.Scene Sandbox.MovieMaker.TrackBinder.Scene { get; set; }Metadata