s&box docs
API ReferenceSandbox.MovieMaker

public sealed class Sandbox.MovieMaker.TrackBinder

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.

Broader workflow and conceptual references connected to this API.

Constructors

Showing 1 constructors

public TrackBinder(Sandbox.Scene scene = null)

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.

Parameters

  • scene: Default: null

Methods

Showing 19 methods

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

public void DestroyTargets()

Destroy any instances created by `Sandbox.MovieMaker.TrackBinder.CreateTargets(Sandbox.MovieMaker.IMovieClip,System.Boolean,Sandbox.GameObject)`.

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

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

Parameters

  • clip: Movie clip to find track bindings for.

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)

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

Parameters

  • clip: Movie clip to find track bindings for.

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

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

Parameters

  • clip: Movie clip to find track bindings for.

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

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

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

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

Properties

Showing 2 properties

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

Gets the default binder for the active scene.

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

The scene this binder is targeting.

Metadata

FieldValue
NamespaceSandbox.MovieMaker
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.MovieMaker.TrackBinder

On this page

Constructorspublic TrackBinder(Sandbox.Scene scene = null)Methodspublic System.Void Add(Sandbox.MovieMaker.IReferenceTrack track, Sandbox.IValid target)public System.Void CreateTargets(Sandbox.MovieMaker.IMovieClip clip, System.Boolean replace = True, Sandbox.GameObject rootParent = null)public System.Void CreateTargets(System.Collections.Generic.IEnumerable`1<Sandbox.MovieMaker.IReferenceTrack> tracks, System.Boolean replace = True, Sandbox.GameObject rootParent = null)public virtual sealed System.Void Deserialize(System.Text.Json.Nodes.JsonNode node)public System.Void DestroyTargets()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