s&box docs
API ReferenceSandbox.MovieMaker.Properties

ITrackPropertyFactoryclass

Used by `Sandbox.MovieMaker.TrackBinder` to create `Sandbox.MovieMaker.ITrackProperty` instances that allow `Sandbox.MovieMaker.ITrack`s to modify values in a scene.

object→ITrackPropertyFactory
Namespace
Sandbox.MovieMaker.Properties
Assembly
Sandbox.Engine
Declaration
public abstract interface Sandbox.MovieMaker.Properties.ITrackPropertyFactory

Methods4

Showing 4 methods

public virtual Sandbox.MovieMaker.ITrackProperty`1<T> CreateProperty(Sandbox.MovieMaker.ITrackTarget parent, string name)PUBLICVIRTUAL

Create a property with the given `parent`, `name`, and property value type . The target type was previously returned by `Sandbox.MovieMaker.Properties.ITrackPropertyFactory.GetTargetType(Sandbox.MovieMaker.ITrackTarget,System.String)`, or read from a deserialized track.

ParameterTypeDescription
parentITrackTarget—
namestring—
Returns:ITrackProperty<T>—

public virtual Sandbox.MovieMaker.Properties.DisplayInfo GetDisplayInfo(Sandbox.MovieMaker.ITrackTarget parent, string name)PUBLICVIRTUAL

When listing properties to add, how should we format the name / description / icon?

ParameterTypeDescription
parentITrackTarget—
namestring—
Returns:DisplayInfo—

public virtual System.Collections.Generic.IEnumerable`1<string> GetPropertyNames(Sandbox.MovieMaker.ITrackTarget parent)PUBLICVIRTUAL

Lists all available property names provided by this factory from a given `parent`.

ParameterTypeDescription
parentITrackTarget—
Returns:IEnumerable<string>—

public virtual System.Type GetTargetType(Sandbox.MovieMaker.ITrackTarget parent, string name)PUBLICVIRTUAL

Decides if this factory can create a property given a `parent` target and `name`. Returns any non- type if this factory can create such a property, after which `Sandbox.MovieMaker.Properties.ITrackPropertyFactory.CreateProperty`(Sandbox.MovieMaker.ITrackTarget,System.String)` will be called using that type.

ParameterTypeDescription
parentITrackTarget—
namestring—
Returns:Type—

Properties1

Showing 1 properties

public virtual int Sandbox.MovieMaker.Properties.ITrackPropertyFactory.Order { get; set; }PUBLICVIRTUALGETSET

Used to sort the order that factories are considered when trying to create a property.

Returns:int—

DisplayInfo.ctor()

Previous Page

Order

Next Page

On this page

Methodspublic virtual Sandbox.MovieMaker.ITrackProperty`1<T> CreateProperty(Sandbox.MovieMaker.ITrackTarget parent, System.String name)public virtual Sandbox.MovieMaker.Properties.DisplayInfo GetDisplayInfo(Sandbox.MovieMaker.ITrackTarget parent, System.String name)public virtual System.Collections.Generic.IEnumerable`1<System.String> GetPropertyNames(Sandbox.MovieMaker.ITrackTarget parent)public virtual System.Type GetTargetType(Sandbox.MovieMaker.ITrackTarget parent, System.String name)Propertiespublic virtual System.Int32 Sandbox.MovieMaker.Properties.ITrackPropertyFactory.Order { get; set; }Metadata